User Tools

Site Tools


api:dk11:net:tatukgis.ndk.tgis_layerwfs

TGIS_LayerWFS class

DK11 for .NET | TatukGIS.NDK.TGIS_LayerWFS | Classes | Constructors | Fields | Methods | Properties

Encapsulation of an OpenGIS WFS layer.

Available also on: Delphi | Java | ActiveX.

Syntax

// C#
public class TGIS_LayerWFS : TGIS_LayerCompoundVector
{
}
' VisualBasic
Public Class TGIS_LayerWFS
  Inherits TGIS_LayerCompoundVector
End Class
// Oxygene
type
  TGIS_LayerWFS = public class( TGIS_LayerCompoundVector )
  end;

Inheritance

Constructors

Inherited Overrides Protected
Name Visibility Description
TGIS_LayerWFS() public Create a layer with default parameters.
(Overrides TGIS_LayerCompoundVector.TGIS_LayerCompoundVector())

Fields

Inherited Protected
Name Visibility Description
FActive protected Is layer active?
(Inherited from TGIS_Layer)
FAddition protected Addition value.
(Inherited from TGIS_Layer)
FAge protected Age of the layer.
(Inherited from TGIS_Layer)
FBasemap protected True, if layer will be interpreted as basemap.
(Inherited from TGIS_Layer)
FCachedPaint protected False, if layer must be painted directly (bypassing cache).
(Inherited from TGIS_Layer)
FCaption protected Layer caption.
(Inherited from TGIS_Layer)
FCodePage protected Code Page in which text has been stored.
(Inherited from TGIS_Layer)
FCodePageForced protected Code Page forced by project file or property setting.
(Inherited from TGIS_Layer)
FCollapsed protected Is layer collapsed?
(Inherited from TGIS_Layer)
FComments protected Additional comments.
(Inherited from TGIS_Layer)
FConfigFile protected Configuration file handle.
(Inherited from TGIS_Layer)
FConfigFile2 protected Configuration file handle.
(Inherited from TGIS_Layer)
FConfigName protected Configuration file name.
(Inherited from TGIS_Layer)
FCS protected Projection object.
(Inherited from TGIS_Layer)
FCustomData protected List of custom data.
(Inherited from TGIS_Layer)
FDormantMode protected Dormant mode for the layer.
(Inherited from TGIS_Layer)
FDriver protected Layer driver.
(Inherited from TGIS_Layer)
FExtent protected Layer extent.
(Inherited from TGIS_Layer)
FExtent3D protected Layer extent 3D.
(Inherited from TGIS_Layer)
FFileCopyright protected Additional textual information about layer copyright.
(Inherited from TGIS_Layer)
FFileInfo protected Additional textual information about the layer such compression, number of pixels, copyright etc.
(Inherited from TGIS_Layer)
FHideFromLegend protected True, if layer should not be visible in a legend.
(Inherited from TGIS_Layer)
FIsLocked protected True, if layer is in locked state Lock.
(Inherited from TGIS_Layer)
FIsModified protected True, if structure (field, geometry etc).
(Inherited from TGIS_Layer)
FIsOpened protected True, if layer was opened.
(Inherited from TGIS_Layer)
FIsPrepared protected True, if layer was opened.
(Inherited from TGIS_Layer)
FIsReadOnly protected Read only flag.
(Inherited from TGIS_Layer)
FMaxTileSize protected Maximum allowed tile size for the layer.
(Inherited from TGIS_Layer)
FMultiUserMode protected Multiuser mode.
(Inherited from TGIS_Layer)
FName protected Layer name.
(Inherited from TGIS_Layer)
FOnBusy protected Busy event.
(Inherited from TGIS_Layer)
FOnPaintLayer protected PaintLayer event.
(Inherited from TGIS_Layer)
FOnPassword protected Will be fired upon opening layer to resolve any username/password
(Inherited from TGIS_Layer)
FOnRead protected Will be fired upon each file Read request.
(Inherited from TGIS_Layer)
FOnWrite protected Will be fired upon each file Write request.
(Inherited from TGIS_Layer)
forceCachedMode protected Set tor True to force cached (bitmap) type of drawing.
(Inherited from TGIS_Layer)
FParamsList protected List of parameters set (sections).
(Inherited from TGIS_Layer)
FParentLayer protected Parent layer.
(Inherited from TGIS_Layer)
FPath protected Layer path.
(Inherited from TGIS_Layer)
FProjectedExtent protected Precalculated projected extent.
(Inherited from TGIS_Layer)
FProjectedExtentBase protected Precalculated projected extent - Base extent (unprojected).
(Inherited from TGIS_Layer)
FProjectedExtentEPSG protected Precalculated projected extent - Layer CS Context.
(Inherited from TGIS_Layer)
FProjectedExtentRotationAngle protected Precalculated projected extent - Rotation context.
(Inherited from TGIS_Layer)
FProjectedExtentRotationPoint protected Precalculated projected extent - Rotation context.
(Inherited from TGIS_Layer)
FProjectedExtentViewerEPSG protected Precalculated projected extent - Viewer CS Context.
(Inherited from TGIS_Layer)
FRenderer protected Handle to a renderer used for drawing shapes.
(Inherited from TGIS_Layer)
FStatistics protected Statistics engine.
(Inherited from TGIS_Layer)
FStream protected Reference to a potential layer underlying stream.
(Inherited from TGIS_Layer)
FSubLayers protected Sub layers list.
(Inherited from TGIS_Layer)
FSubType protected Layer Type.
(Inherited from TGIS_Layer)
FTag protected Tag value.
(Inherited from TGIS_Layer)
FTagInternal protected Internal Tag value.
(Inherited from TGIS_Layer)
FTagPointer protected Pointer Tag value
(Inherited from TGIS_Layer)
FTransform protected Custom transformation.
(Inherited from TGIS_Layer)
FTransparency protected Transparency value.
(Inherited from TGIS_Layer)
FUnSupportedOperations protected Set of operations not supported by a layer.
(Inherited from TGIS_Layer)
FUseConfig protected Is config file active?
(Inherited from TGIS_Layer)
FUserObject protected User object.
(Inherited from TGIS_Layer)
FViewer protected Reference to viewer object.
(Inherited from TGIS_Layer)
inDraw protected True, if layer paint procedure not yet complete.
(Inherited from TGIS_Layer)
paramsCache protected List of prepared parameters.
(Inherited from TGIS_Layer)
View3D public 3D Representation properties.
(Inherited from TGIS_Layer)

Methods

Inherited Overrides Protected
Name Visibility Description
Add public Add a layer to the list.
(Inherited from TGIS_LayerCompoundAbstract)
Alive public Makes a layer non-dormant.
(Inherited from TGIS_Layer)
applyConfigOptions protected Read config option parameters.
(Inherited from TGIS_Layer)
applyConfigProjection protected Read config projection parameters.
(Inherited from TGIS_Layer)
ApplyCuttingPolygon public Set cutting polygon for a layer.
(Inherited from TGIS_Layer)
ChangeHash public Change hash.
(Inherited from TGIS_Layer)
ClearModified public Set IsModified flag to false for a layer and sublayers.
(Inherited from TGIS_Layer)
Dormant public Makes a layer dormant.
(Inherited from TGIS_Layer)
DormantGain public Calculate approximate gain (in Megabytes) which can be achieved releasing memory by calling Dormant()
(Inherited from TGIS_Layer)
Draw public Draws a layer.
(Overrides TGIS_LayerCompoundAbstract.Draw)
DrawEx public Draws a layer with given extent.
(Inherited from TGIS_Layer)
drawExtent protected Calculates the drawing area /clipping area of device/.
(Inherited from TGIS_Layer)
drawExtentEx protected Calculates the drawing area /clipping area of device/.
(Inherited from TGIS_Layer)
DrawFlash public Draw flashed
(Inherited from TGIS_LayerCompoundAbstract)
DrawSelected public Draws a layer.
(Inherited from TGIS_Layer)
DrawSelectedEx public Draws a layer with given extent.
(Inherited from TGIS_LayerCompoundAbstract)
ForEachSubLayer public Return in callback event a layer and all sublayers that belong it.
(Inherited from TGIS_Layer)
Get public Retrieve the layer identified by a name.
(Inherited from TGIS_LayerCompoundAbstract)
GetAvailableLayers public Get a list of layers available in storage.
(Inherited from TGIS_Layer)
HourglassShake public Notify on hourglass on busy state.
(Inherited from TGIS_Layer)
IsGrid public Is layer a grid type.
(Inherited from TGIS_Layer)
IsPixel public Is layer a pixel type.
(Inherited from TGIS_Layer)
isSublayer protected Gives us information if layer is sublayer.
(Inherited from TGIS_Layer)
IsSupported public Is operation supported by a layer.
(Inherited from TGIS_Layer)
IsVector public Is layer a vector type.
(Inherited from TGIS_Layer)
IsVector3D public Is layer a vector type.
(Inherited from TGIS_Layer)
IsVisible public Check if a layer is visible in given extent and current params.
(Inherited from TGIS_Layer)
LocateEx public Locate a shape (more precise).
(Inherited from TGIS_LayerCompoundVector)
Lock public Lock a layer burst-mode operation.
(Inherited from TGIS_Layer)
lockThread protected Lock thread.
(Inherited from TGIS_Layer)
Move public Move a layer up or down in a viewer zorder list.
(Inherited from TGIS_Layer)
MoveEx public Move a layer up or down in a viewer zorder list.
(Inherited from TGIS_Layer)
MustCalculateStatistics public Verify if all statistics required to properly render layer are available.
(Inherited from TGIS_Layer)
MustReproject public Do layer must reproject.
(Inherited from TGIS_Layer)
MustSave public Check if the layer was modified by editing.
(Inherited from TGIS_Layer)
Open public Open the layer.
(Inherited from TGIS_Layer)
optimizeParamsCache protected Move section specified by _idx to the top of the cached list.
(Inherited from TGIS_Layer)
Paint public Draws a layer or fires PaintLayer event ( if defined ).
(Inherited from TGIS_Layer)
Prepare public Open the layer.
(Inherited from TGIS_Layer)
prepareParamsCache protected Prepare cached section list meeting the _style name.
(Inherited from TGIS_Layer)
PreRecognize public Check if layer can read a file.
(Overrides TGIS_Layer.PreRecognize)
Project public Apply a projection on the single point.
(Inherited from TGIS_Layer)
Project3D public Apply a projection on the single point in 3D.
(Inherited from TGIS_Layer)
Project3D_Ref public Apply a projection on the single point in 3D.
(Inherited from TGIS_Layer)
projectExtent protected Project a given extent.
(Inherited from TGIS_Layer)
Project_Ref public Apply a projection on the single point.
(Inherited from TGIS_Layer)
RaiseBusyEvent public Fire Busy event of a layer.
(Inherited from TGIS_Layer)
RaiseBusyPrepare public Fire BusyPrepare method of a viewer.
(Inherited from TGIS_Layer)
RaiseBusyRelease public Fire BusyRelease method of a viewer.
(Inherited from TGIS_Layer)
RaiseBusyShake public Fire BusyShake method of a viewer.
(Inherited from TGIS_Layer)
ReadConfig public Read layer configuration files.
(Inherited from TGIS_Layer)
ReadConfigParam public Read layer configuration parameter.
(Inherited from TGIS_Layer)
RecalcExtent public Recalculate extent based on real shapes.
(Inherited from TGIS_LayerCompoundAbstract)
RecalcProjectedExtent public Recalculate a projected extent.
(Inherited from TGIS_LayerCompoundAbstract)
ReOpen public Reopen the layer.
(Inherited from TGIS_Layer)
RereadConfig public Reread layer configuration files.
(Inherited from TGIS_Layer)
resetMustReproject protected Reset MustReporoject state.
(Inherited from TGIS_Layer)
RevertAll public Revert a layer to a original content.
(Inherited from TGIS_Layer)
RootLayer public Return absolute parent layer.
(Inherited from TGIS_Layer)
SaveAll public Save layer and destroy mirrored items.
(Inherited from TGIS_Layer)
SaveData public Save layer and destroy mirrored items.
(Inherited from TGIS_Layer)
SetCSByEPSG public Setup Coordinate System to a coordinate system provided by EPSG code.
(Inherited from TGIS_Layer)
SetCSByWKT public Setup Coordinate System to a coordinate system provided by WKT string (GEOGCS or PROJCS).
(Inherited from TGIS_Layer)
SetCSByWKTFile public Setup Coordinate System to a coordinate system provided by file which contains WKT string (GEOGCS or PROJCS).
(Inherited from TGIS_Layer)
setUp protected Makes a general layer setup first step.
(Overrides TGIS_LayerCompoundAbstract.setUp)
setUp2 protected Makes a general layer setup second step.
(Inherited from TGIS_Layer)
setUp3 protected Makes a general layer setup third step.
(Inherited from TGIS_LayerCompoundAbstract)
storeConfigOptions protected Store layer options in a configuration file.
(Inherited from TGIS_Layer)
transformExtent protected Custom transformation of the extent.
(Inherited from TGIS_Layer)
Unlock public Unlock a layer from burst-mode operation.
(Inherited from TGIS_Layer)
unlockThread protected Unlock thread.
(Inherited from TGIS_Layer)
Unproject public Apply reverse projection (recover from projection) on the single point.
(Inherited from TGIS_Layer)
Unproject3D public Apply reverse projection (recover from projection) on the single point in 3D.
(Inherited from TGIS_Layer)
Unproject3D_Ref public Apply reverse projection (recover from projection) on the single point in 3D.
(Inherited from TGIS_Layer)
unprojectExtent protected Unproject a given extent.
(Inherited from TGIS_Layer)
Unproject_Ref public Apply reverse projection (recover from projection) on the single point.
(Inherited from TGIS_Layer)
WriteConfig public Write layer configuration files.
(Inherited from TGIS_Layer)

Properties

Inherited Protected
Name Visibility Description
Active public Is the Layer active? Active means that it can be visible, and that an object can be localized on such layers.
(Inherited from TGIS_Layer)
Addition public Addition value.
(Inherited from TGIS_Layer)
Age public Age of the layer.
(Inherited from TGIS_Layer)
Basemap public True, if layer must be interpreted as basemap (for background painting).
(Inherited from TGIS_Layer)
CachedPaint public False, if layer must be painted directly (bypassing cache).
(Inherited from TGIS_Layer)
Caption public Caption of layer, if not filed directly then will be filed with Name while adding to the Viewer.
(Inherited from TGIS_Layer)
CodePage public Code Page in which text has been stored.
(Inherited from TGIS_Layer)
Collapsed public Is the Layer collapsed? Collapsed means that inside legend only title will be visible.
(Inherited from TGIS_Layer)
Comments public Additional user comments.
(Inherited from TGIS_Layer)
ConfigFile public Configuration file handle.
(Inherited from TGIS_Layer)
ConfigName public Configuration file name.
(Inherited from TGIS_Layer)
CS public Coordinate System assigned to the layer.
(Inherited from TGIS_Layer)
CustomData public List of custom, user-defined data.
(Inherited from TGIS_Layer)
DirectMode public Return True, if the layer is direct-mode (bypassing cache).
(Inherited from TGIS_Layer)
DormantMode public Dormant mode for the layer.
(Inherited from TGIS_Layer)
Driver public Layer driver name.
(Inherited from TGIS_Layer)
Extent public Extent of the layer.
(Inherited from TGIS_Layer)
Extent3D public Extent 3D of the layer.
(Inherited from TGIS_Layer)
FileCopyrights public Copyright information about the layer.
(Inherited from TGIS_Layer)
FileInfo public Additional textual information about the layer such compression, number of pixels, copyright etc.
(Inherited from TGIS_Layer)
FoundLayers public List of all found layers names.
HideFromLegend public False, if layer should not be visible in a legend.
(Inherited from TGIS_Layer)
IsExportable public True if layer is exportable.
(Inherited from TGIS_Layer)
IsLocked public True, if layer is in locked state Lock.
(Inherited from TGIS_Layer)
IsOpened public True, if layer was opened and is ready for operations.
(Inherited from TGIS_Layer)
IsPersistent public True if layer is persistent.
(Inherited from TGIS_Layer)
IsReadOnly public Is layer read only.
(Inherited from TGIS_Layer)
IsTopmost public True, if layer can be interpreted as topmost (trackable).
(Inherited from TGIS_Layer)
Layer public All sub layers.
(Inherited from TGIS_LayerCompoundAbstract)
LayersCount public Sub layers count.
(Inherited from TGIS_LayerCompoundAbstract)
MaxTileSize public Maximum allowed tile size for the layer.
(Inherited from TGIS_Layer)
MultiUserMode public Multiuser mode.
(Inherited from TGIS_Layer)
Name public Name of layer, if not field directly then will be field with Path while adding to the Viewer.
(Inherited from TGIS_Layer)
Params public Parameters (colors, fills etc) object.
(Inherited from TGIS_Layer)
ParamsList public List of all parameters sections attached to the current layer.
(Inherited from TGIS_Layer)
ParentLayer public Sub layer parent layer.
(Inherited from TGIS_Layer)
Path public Path to file with layer data.
(Inherited from TGIS_Layer)
PathWithDriver public Path to file with layer data extended with driver name.
(Inherited from TGIS_Layer)
ProjectedExtent public Extent of the layer in projected units.
(Inherited from TGIS_Layer)
ProxyUrl public Proxy URL as for ESRI proxy.ashx.
Renderer public Handle to a renderer used for drawing shapes.
(Inherited from TGIS_Layer)
Statistics public Layer statistics engine
(Inherited from TGIS_Layer)
Stream public Reference to a potential layer underlying stream.
(Inherited from TGIS_Layer)
SubLayers public Sub layers list.
(Inherited from TGIS_Layer)
SubType public Layer type.
(Inherited from TGIS_Layer)
Tag public Tag has no predefined meaning.
(Inherited from TGIS_Layer)
TagInternal public TagInternal has no predefined meaning.
(Inherited from TGIS_Layer)
TagPointer public TagPointer has no predefined meaning.
(Inherited from TGIS_Layer)
Transform public Custom transformation.
(Inherited from TGIS_Layer)
Transparency public Transparency value.
(Inherited from TGIS_Layer)
UnSupportedOperations public Set of operations not supported by a layer.
(Inherited from TGIS_Layer)
UseConfig public Is config file active?
(Inherited from TGIS_Layer)
UseLayers public List of layers to be used for render.
UserAgent public User Agent string.
UserObject public UserObject can be used to associate with the layer a user defined objects.
(Inherited from TGIS_Layer)
Viewer public Reference to viewer object.
(Inherited from TGIS_Layer)
ZOrder public Layer position relative to other layers.
(Inherited from TGIS_Layer)
ZOrderEx public Layer position relative to other layers.
(Inherited from TGIS_Layer)

Remarks

To open a layer provide the path with GetResponse request like

 Layer.Path := ‘http://WFS.jpl.nasa.gov/WFS.cgi?SERVICE=WFS&REQUEST=GetCapabilities’ ;

This layer can also be opened by opening the file name_of_layer.ttkwp or embedding all parameters to Path property as CRLF or '\n' delimited string. Structure of this file must be:

  [TatukGIS Layer]
  Storage=WFS
  Name=layer name
  Caption=layer caption
  Url=wfs server url
  .....
  AxisOrder=NE or EN (default) (obsolate)
  AxisOrderReversed=reverse coordinates of axis for some coordinate systems
  AxisOrderIgnored=ignore axis order from the coordinate system (only for 1.3.0 services)
  ExtentOrder=set XX or XY to define how a bounding box of a layer is defined

If the GetCapabilities will be omitted then class will try to recognize the server of its own:

  Layer.Path := 'http://WFS.jpl.nasa.gov/WFS.cgi?SERVICE=WFS' ;

It is possible to embed into Path additional WFS parameters like VERSION, TYPENAME, SRSNAME, OUTPUTFORMAT, MAXFEATURES, STARTINDEX, BBOX, CQL_FILTER, AxisOrderIgnored, AxoisOrderReversed or ExtentOrder like

  layer.Path := 'http://WFS.jpl.nasa.gov/WFS.cgi?SERVICE=WFS&FORMAT=image/jpeg&LAYERS=global_mosaic' ;

For WFS servers that require authentication, it is possible to embed into Path additional parameters USER, PASS like

  layer.Path := 'http://WFS.jpl.nasa.gov/WFS.cgi?SERVICE=WFS&USER=test&PASS=test' ;

or use templates format instead of real parameter values and OnPassword event for secured decoding like

  layer.Path := 'http://WFS.jpl.nasa.gov/WFS.cgi?SERVICE=WFS&USER=<#USER#>&PASS=<#PASS#>' ;

The layer should properly recognize axis order. However, axis order can be modified to:

  • force reversed axis order useAxisOrderReversed=true definition and:
    • embed into a URL
    • store in a .ttkwp file
    • store in a layer configuration file or project file
    • use Metadata TGIS_LayerWFS.AxisOrderReversed=true
  • ignore axis order recognition use AxisOrderIgnored=true definition and:
    • embed into a URL
    • store in a .ttkwp file
    • store in a layer configuration file or project file
    • use Metadata TGIS_LayerWFS.AxisOrderIgnored=true

2019/09/03 14:37