HttpLayer Class
A common base class for OgcWmsLayer, OgcWmtsLayer and OgcApiTilesLayer.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.17.0.nupkg (in the CECore assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public abstract class HttpLayer : LayerSetRemarks
This is an abstract base class holding properties and methods common to the OgcWmsLayer , OgcWmtsLayer and OgcApiTilesLayer layer classes.
Inheritance Hierarchy
System.Object
EngineObject
Layer
LayerSet
HttpLayer
OgcApiTilesLayer
OgcWmsLayer
OgcWmtsLayer
Platforms
Windows, Linux, Android
HttpLayer Members
The HttpLayer type has the following members.
Properties
| Name | Description |
|---|---|
| BlendMode | Gets or sets the blend mode that determines how the layer is combined with previously rendered layers. Inherited from Layer |
| Condition | Gets or sets the Condition that determines whether the HttpLayer is drawn or not. Inherited from Layer |
| Description | Gets or sets a short description of the layer. Inherited from Layer |
| 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 |
| Enabled | Determines whether the HttpLayer is enabled or not. Inherited from Layer |
| EnabledDuringQuickUpdates | Determines whether the HttpLayer is temporarily turned off during mouse interactions. Inherited from Layer |
| IsDisposed | Gets a value that tells whether the current HttpLayer 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 HttpLayer. 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 HttpLayer should be drawn. Inherited from Layer |
| MinScale | Gets or sets the lowest inverted nominal scale this HttpLayer 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 HttpLayer 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/API service. |
| Selectable | Gets or sets a value that determines whether features in this HttpLayer can be selected. Inherited from Layer |
| ServiceMonitorInterval | Starts a background thread that monitors the OGC service for changes. |
| ThrowExceptions | Gets or sets a flag indicating if exceptions should be thrown when an error occurs. |
| Timeout | Gets or sets a value that indicates how long the layer will wait for a response from the OGC WMS/WMTS/API server. |
| Url | Gets or sets the URL to a web mapping service. |
| User | Gets or sets the username used for basic authentication by the OGC WMS/WMTS/API service. |
| IUserProperties.UserProperties | Gets the AttributeSet that contains the user properties. Inherited from IUserProperties |
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 |
| 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 |
| 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, OgcWmsLayer or OgcApiTilesLayer instance to its default state. |
| 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. |