CatalogLoadDataSetSet Class
A class for automatically loading data sets from a Carmenta Engine Catalog.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECatalog assembly)
Syntax
public class CatalogLoadDataSetSet : DataSetSetRemarks
A CatalogLoadDataSetSet is similar to a DataSetSet, but instead of manually adding child datasets, it loads data set services from a catalog and inserts them as children. Since the class can be configured in Carmenta Studio, this makes is very simple to include catalog data sets in an application; the application does not even have to use the Catalog mechanism API.
CatalogLoadDataSetSet can also be used in .px files inside a catalog. This makes it possible to create catalog maps reading data from multiple data sets in the catalog, perhaps not known in advance. You can for instance create a map with a LineOfSightOperator, making it read elevation data from all datasets available in the catalog with a keyword elevation.
If two different queries return the same dataset instance, it will only be inserted once.
Avoid using CRS or extent conditions in the queries, for CatalogLoadDataSetSet instances used inside a catalog. The CRS or extents of other datasets may not yet be known when the queries are evaluated.
If you use multiple CatalogLoadDataSetSet instances inside a catalog, you can easily create circular references. Make sure to specify queries with adequate conditions to avoid this.
A Catalog object must be available when this class is initialized. This catalog may come from three different places:
If the CatalogLoadDataSetSet is loaded from a .px file that is read during the initialization of a Catalog, then that Catalog instance will be used by the CatalogLoadDataSetSet.
If the .px file is loaded directly by an application, the application may supply a Catalog object.
If no catalog object is found, the Catalog property is used.
If no catalog object can be located at all, an exception is thrown during initialization.
Some ordering of the features returned from the dataset is guaranteed. During a query, each child dataset will return its features in turn. The order of the child datasets is determined by their nominal highest resolution, i.e. their cell width and cell height expressed in meters; highest resolution first. The order of child datasets with the same raster resolution and the order of vector datasets are unspecified.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
DataSetSet
CatalogLoadDataSetSet
Platforms
Windows, Linux, Android
CatalogLoadDataSetSet Members
The CatalogLoadDataSetSet type has the following members.
Constructors
| Name | Description |
|---|---|
| CatalogLoadDataSetSet | Initializes a new instance of the CatalogLoadDataSetSet class. |
Properties
| Name | Description |
|---|---|
| Catalog | Gets or sets the catalog instance to load data set services from. |
| Crs | Gets or sets the coordinate reference system of the CatalogLoadDataSetSet. Inherited from DataSet |
| DataSets | Gets a collection that contains all DataSet elements in the CatalogLoadDataSetSet. Inherited from DataSetSet |
| Description | Gets or sets a short description of the dataset. Inherited from DataSet |
| DisplayName | Gets or sets a display name for the dataset. Inherited from DataSet |
| Id | Gets a unique identifier for this dataset instance. Inherited from DataSet |
| IsDisposed | Gets a value that tells whether the current CatalogLoadDataSetSet has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the dataset. Inherited from DataSet |
| Name | Gets or sets the name of the CatalogLoadDataSetSet. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current CatalogLoadDataSetSet represents. Inherited from EngineObject |
| Queries | Gets the list of queries used to find and load the data set services. |
| SuppressInitializationErrors | Gets or sets a flag indicating how errors during dataset initialization are handled. Inherited from DataSet |
| 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 |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| FindChildObject | Overloaded. Finds the child object with the specified name. Inherited from DataSet |
| FlushCache | Frees any information the dataset may have cached, including all cached features. Inherited from DataSet |
| GetChildObjects | Overloaded. Gets the child objects of the current object. Inherited from DataSet |
| GetDataCoverage | Gets coverage information for this dataset in a given area. Inherited from DataSet |
 GetDataSetById | Looks up an existing dataset instance from a dataset identity. Inherited from DataSet |
| GetDataSetInfo | Returns a dataset info that describes the contents of this dataset. Inherited from DataSet |
| GetDataSetInfoAsync | Makes an asynchronous call to GetDataSetInfo. Inherited from DataSet |
| GetFeature | Gets the feature with the specified identity. Inherited from DataSet |
| GetFeatures | Overloaded. Gets features from the dataset. Inherited from DataSet |
| GetFloatValueAt | Overloaded. Gets the float raster value from a cell at the specified position. Inherited from DataSet |
| GetFloatValuesAt | Overloaded. Gets a number of float raster values. Inherited from DataSet |
| GetLocalizedDescription | Gets a localized version of the dataset description in a specific language. Inherited from DataSet |
| GetLocalizedDisplayName | Gets a localized version of the dataset display name in a specific language. Inherited from DataSet |
| GetLocalizedIsoMetadataDocument | Gets the path to an ISO 19139 metadata document for a specific language. Inherited from DataSet |
| GetNormalizedFloatValueAt | Overloaded. Gets the raster value from a cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| GetNormalizedFloatValuesAt | Overloaded. Gets a number of raster values, normalized by Scale and Offset. Inherited from DataSet |
| GetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |
| GetValuesAt | Overloaded. Gets a number of raster values. Inherited from DataSet |
| HasLocalizedDescription | Checks if a localized version of the dataset description is available in a specific language. Inherited from DataSet |
| HasLocalizedDisplayName | Checks if a localized version of the dataset display name is available in a specific language. Inherited from DataSet |
| HasLocalizedIsoMetadataDocument | Checks if an ISO 19139 metadata document is available for a specific language. Inherited from DataSet |
| HighestRasterValue | Finds the highest raster value inside the given polygon. Inherited from DataSet |
| Initialize | Initializes the dataset. Inherited from DataSet |
| Match | Checks if a metadata instance matches the queries of this CatalogLoadDataSetSet. |
| SetLocalizedDescription | Sets a dataset description in a specific language. Inherited from DataSet |
| SetLocalizedDisplayName | Sets a dataset display name in a specific language. Inherited from DataSet |
| SetLocalizedIsoMetadataDocument | Sets the path to an ISO 19139 metadata document for the dataset, for a specific language. Inherited from DataSet |
| TryGetFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position. Inherited from DataSet |
| TryGetNormalizedFloatValueAt | Overloaded. Gets the float value from a raster cell at the specified position, normalized by Scale and Offset. Inherited from DataSet |
| TryGetValueAt | Overloaded. Gets the integer value from a raster cell at the specified position. Inherited from DataSet |