CatalogMap Class
Represents a map loaded from a Carmenta Engine catalog.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECatalog assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECatalog assembly)
Thread safety: Members defined in this class are, in general, not thread-safe. Show
Syntax
public class CatalogMap : CatalogLayerRemarks
A CatalogMap represents the top layer of a map loaded from a Carmenta Engine catalog. Instances of this class are only created and returned by the Catalog.LoadMap method; it can not be created directly by the application. Once loaded, an application can add the map directly to the layer hierarchy of its view.
A catalog map defines its own "virtual" sub-layer hierarchy. This are exposed to the application as CatalogLayer child layers of the map instance. The actual implementation of these layers is hidden, they may correspond to regular Carmenta Engine layers held internally by the map, or they may be layers defined by an OGC WMS or WMTS service.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Layer
LayerSet
CatalogLayer
CatalogMap
Platforms
Windows, Linux, Android
CatalogMap Members
The CatalogMap 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 CatalogMap 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 |
| Elevation | Gets or sets the value of the ELEVATION parameter. |
| Enabled | Determines whether the CatalogMap is enabled or not. Inherited from Layer |
| EnabledDuringQuickUpdates | Determines whether the CatalogMap is temporarily turned off during mouse interactions. Inherited from Layer |
| IsDisposed | Gets a value that tells whether the current CatalogMap has been disposed. Inherited from EngineObject |
| IsMovable | Gets a value indicating if a catalog layer can be moved or not. Inherited from CatalogLayer |
| 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 CatalogMap. 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 CatalogMap should be drawn. Inherited from Layer |
| Metadata | Gets a reference to the metadata object that was used to load the catalog map. Inherited from CatalogLayer |
| MinScale | Gets or sets the lowest inverted nominal scale this CatalogMap 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 CatalogMap represents. Inherited from EngineObject |
| Opacity | Gets or sets a value that specifies the opacity of the layer. Inherited from Layer |
| Selectable | Gets or sets a value that determines whether features in this CatalogMap can be selected. Inherited from Layer |
| ServiceMonitorInterval | Starts a background thread that monitors the OGC service for changes. |
| Time | Gets or sets the value of the TIME parameter. |
| 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 |
| FlushAllDataSets | Calls DataSet.FlushCache on all datasets referenced by the map. |
| FlushCache | Marks the layer as flushed which will release cached resources during the next update. Inherited from Layer |
| GetAllPublicObjects | Retrieves a list of all public object loaded by a map, including those loaded indirectly by included maps. |
| 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 |
| GetImplementingLayer | Retrieves a reference to the underlying hidden layer implementing the catalog map. |
| 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 |
| GetPublicObject | Retrieves a public object from the map. |
| 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 CatalogMap 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 |