OgcWmsLayer Class
A layer that generates its presentation using maps from OpenGIS Web Map Service sites.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEOgc assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEOgc assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class OgcWmsLayer : HttpLayerRemarks
An OgcWmsLayer generates its presentation using map images from OGC WMS services and can connect to servers implementing version 1.1.1 or 1.3.0 of the OpenGIS Web Map Service Implementation Specification. See www.opengis.org for more information.
To use an OgcWmsLayer you need to at minimum, but it is often enough, set the Url property to an endpoint to an OGC WMS service. Everything else will be configured automatically when the layer is being initialized. The layer will automatically issue one or more GetCapabilites requests to find out what the OGC WMS service supports and which URL to use to request a map image.
After an OgcWmsLayer has been initialized you can access the layer hierarchy that is provided by the service through the Layers property which will contain a hierarchy of OgcWmsServerLayer instances. The layer hierarchy itself is read-only and any attempt to insert or remove layers from it will result in an exception being thrown. You can however use it to enable/disable child layers, apply named styles, populate a GUI control and more. Please see OgcWmsServerLayer for more information.
Tip
An OgcWmsLayer should almost always be used inside a TileLayer so that map images are requested asynchronously and cached to avoid unnecessary requests to the remote server.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Layer
LayerSet
HttpLayer
OgcWmsLayer
Platforms
Windows, Linux, Android
OgcWmsLayer Members
The OgcWmsLayer type has the following members.
Constructors
| Name | Description |
|---|---|
| OgcWmsLayer | Initializes a new instance of the OgcWmsLayer. |
Properties
| Name | Description |
|---|---|
| Background | Gets or sets the background color of the maps. |
| BlendMode | Gets or sets the blend mode that determines how the layer is combined with previously rendered layers. Inherited from Layer |
| Buffered | Gets or sets a value that determines whether the OgcWmsLayer will cache images between updates. |
| Condition | Gets or sets the Condition that determines whether the OgcWmsLayer is drawn or not. Inherited from Layer |
| CoverageHint | Gets or sets a value that can assert that the visualization is fully opaque within the data extent. Inherited from Layer |
| Description | Gets or sets a short description of the layer. Inherited from Layer |
| DimensionValues | Gets or sets the values in the DIMENSION parameter of other dimensions as appropriate. |
| DisableOnError | Gets or sets a value specifying if an error within the layer should automatically disable the layer, or throw an exception. Inherited from Layer |
| DisplayName | Gets or sets a display name for the layer. Inherited from Layer |
| Effects | List of effects Inherited from Layer |
| Elevation | Gets or sets the value of the ELEVATION parameter sent in GetMap requests to the OGC WMS service. |
| Enabled | Determines whether the OgcWmsLayer is enabled or not. Inherited from Layer |
| EnabledDuringQuickUpdates | Determines whether the OgcWmsLayer is temporarily turned off during mouse interactions. Inherited from Layer |
| ExplicitLayers | Gets the list of layers that should be included in the map image. |
| ExplicitStyles | Gets the list of named styles for the layers in the map image |
| Format | Gets or sets the graphics format of the map image generated by the OGC WMS service. |
| IsDisposed | Gets a value that tells whether the current OgcWmsLayer has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path or URL to an ISO 19139 metadata document for the layer. Inherited from Layer |
| Layers | Gets the child layers of this OgcWmsLayer. Inherited from LayerSet |
| Legend | Gets or sets a map legend associated with this layer. Inherited from Layer |
| MaxScale | Gets or sets the highest inverted nominal scale in a 2D view, or the furthest distance in a 3D globe view, at which objects from this OgcWmsLayer should be drawn. Inherited from Layer |
| MinScale | Gets or sets the lowest inverted nominal scale this OgcWmsLayer should be drawn at. Inherited from Layer |
| Name | Gets or sets the name of the layer. Inherited from Layer |
| NamedStyles | Gets the list of named styles that can be enabled for the layer. Inherited from Layer |
| NativeHandle | Gets the native Carmenta Engine kernel object the current OgcWmsLayer represents. Inherited from EngineObject |
| Opacity | Gets or sets a value that specifies the opacity of the layer. Inherited from Layer |
| Password | Gets or sets the password used for basic authentication by the OGC WMS/WMTS service. Inherited from HttpLayer |
| ServiceMonitorInterval | Starts a background thread that monitors the OGC service for changes. Inherited from HttpLayer |
| ThrowExceptions | Gets or sets a flag indicating if exceptions should be thrown when an error occurs. Inherited from HttpLayer |
| Time | Gets or sets the value of the TIME parameter sent in GetMap requests to the OGC WMS service. |
| Timeout | Gets or sets a value that indicates how long the layer will wait for a response from the OGC WMS/WMTS server. Inherited from HttpLayer |
| Transparent | Gets or sets a value that specifies whether areas with no data should be transparent or not. |
| Url | Gets or sets the URL to a web mapping service. Inherited from HttpLayer |
| User | Gets or sets the username used for basic authentication by the OGC WMS/WMTS service. Inherited from HttpLayer |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
| VendorSpecificParameters | Gets or sets any vendor specific parameters that are appended to all requests. |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| EnableStyle | Enables or disables a named style for the layer. Inherited from Layer |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from Layer |
| FlushCache | Marks the layer as flushed which will release cached resources during the next update. Inherited from Layer |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from Layer |
| GetDataBounds | Calculates the bounds of all dataset coverages in the layer. Inherited from Layer |
| GetFeatureAttributes | Gets information about all attributes that may be present on features in this layer. Inherited from Layer |
| GetFeatureInfo | Sends a GetFeatureInfo request to the OGC WMS service and returns the result as a sequence of bytes. |
| GetFeatureInfoFormats | Returns a list of GetFeatureInfo reply formats supported by the OGC WMS service. |
| GetFeatures | Overloaded. Gets features from the layer and any child layers. Inherited from Layer |
| GetLastError | Gets the error message for the last error that occurred within the layer. Inherited from Layer |
| GetLocalizedDescription | Gets a localized version of the layer description in a specific language. Inherited from Layer |
| GetLocalizedDisplayName | Gets a localized version of the layer display name in a specific language. Inherited from Layer |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from Layer |
| HasLocalizedDescription | Checks if a localized version of the layer description is available in a specific language. Inherited from Layer |
| HasLocalizedDisplayName | Checks if a localized version of the layer display name is available in a specific language. Inherited from Layer |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from Layer |
| Initialize | Initializes the OgcWmsLayer instance. |
| IsStyleEnabled | Checks if a certain style is enabled for the layer or not. Inherited from Layer |
| MoveLayer | Moves a child layer to a new position. Inherited from LayerSet |
| Reset | Resets the OgcWmtsLayer or OgcWmsLayer instance to its default state. Inherited from HttpLayer |
| SetLocalizedDescription | Sets a layer description in a specific language. Inherited from Layer |
| SetLocalizedDisplayName | Sets a layer display name in a specific language. Inherited from Layer |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the layer, for a specific language. Inherited from Layer |
Events
| Name | Description |
|---|---|
| EnabledChanged | Occurs when the value of the Enabled property has changed. Inherited from Layer |
| ServiceChanged | Occurs when the layer has detected changes to the OGC service. Inherited from HttpLayer |