CustomDataSetProxy Class
A proxy for a custom dataset in map configurations.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public class CustomDataSetProxy : DataSet,
IReadAttributes,
ISearchableRemarks
A custom dataset is a .NET, C++ or Java object that implements (at least) the ICustomDataSet interface (you should also implement the ICustomRasterDataSet if the dataset reads rasters).
When you have implemented a custom dataset and want to use it in a map configuration you use a CustomDataSetProxy. There are two different ways to connect the custom dataset implementation to the proxy:
If the Api, LibraryName and ClassName properties are set, the proxy will automatically load the specified library and create an instance of the custom dataset.
The application can create the custom dataset instance at runtime, and pass it to the proxy by setting the CustomDataSet property.
After the proxy has been connected to an implementation it works as a regular Carmenta Engine dataset.
DataSetInfo
To customize the DataSetInfo instance returned by GetDataSetInfo, the custom dataset must also implement the ICustomDataSetInfoProvider interface.
A custom dataset class implementing ICustomDataSetInfoProvider may also be registered as a DataSetInfo provider for data files with a certain file extension. Doing so allows the custom-dataset class to handle invocations to DataSetInfo.FromFile and DataSetInfo.FromDirectory. See RegisterInfoProvider for more information on this.
ISearchable
CustomDataSetProxy implements the ISearchable interface but the search methods will only return features if the custom dataset also implements the ICustomSearchableDataSet interface.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
CustomDataSetProxy
Platforms
Windows, Linux, Android
CustomDataSetProxy Members
The CustomDataSetProxy type has the following members.
Constructors
| Name | Description |
|---|---|
| CustomDataSetProxy | Initializes a new instance of the CustomDataSetProxy class. |
Properties
| Name | Description |
|---|---|
| Api | Gets the API the custom dataset is implemented with. |
| IReadAttributes.Attributes | Gets a collection whose contents determine which attributes will be read the DataSet. Inherited from IReadAttributes |
| ClassName | Gets the name of the class implementing the custom dataset. |
| CustomDataSet | Gets or sets the custom dataset instance. |
| 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 |
| ISearchable.HasSearchIndex | Gets a value that tells whether a dataset has a search index. Inherited from ISearchable |
| Id | Gets a unique identifier for this dataset instance. Inherited from DataSet |
| IsDisposed | Gets a value that tells whether the current CustomDataSetProxy has been disposed. Inherited from EngineObject |
| IsoMetadataDocument | Gets or sets the path to an ISO 19139 metadata document for the dataset. Inherited from DataSet |
| LibraryName | Gets the name of the library containing the custom dataset. |
| Name | Gets or sets the name of the CustomDataSetProxy. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current CustomDataSetProxy represents. Inherited from EngineObject |
| IReadAttributes.ReadAttributes | Gets or sets a value indicating whether the DataSet reads attributes. Inherited from IReadAttributes |
| SuggestedCrs | Gets or sets a suggested coordinate reference system for the custom dataset to use. |
| 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 |
| RegisterInfoProvider | Overloaded. Register a custom dataset as a DataSetInfo provider for data files with a certain file extension. |
| ISearchable.Search | Overloaded. Searches for features with an attribute whose value match the specified search text. Inherited from ISearchable |
| 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 |