S57DataSet Class
A dataset for reading nautical charts data in S-57 format.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEDataSets assembly)
Syntax
public class S57DataSet : MultiFileDataSet,
ISearchableRemarks
An S57DataSet reads nautical chart data in S-57 ENC format, and Additional Military Layers version 2.1 and 3.0 in S-57 AML format. The output is point, line, and polygon features with S-57 attributes. For more AML information see www.ukho.gov.uk/Defence/AML.
Commercially available chart data is often protected by the IHO S-63 protection scheme. This means, among other things, that all the data files are encrypted, and only licensed clients can decrypt them. The S63 class can be used to create and maintain a database of encrypted S-63 data files along with the permit files needed to decrypt them. The S57DataSet class can be configured to use such a database instead of reading unencrypted S-57 files, by specifying S63DatabasePath instead of Path and FileName. See Working with S-63 Electronic Nautical Chart Data for an overview of the S-63 support in Carmenta Engine.
You can use the S52Visualizer to visualize S57 data.
 |
The S57DataSet can handle data files covering the same area with different levels of detail. The dataset will use the most appropriate data available for any requested area and resolution. Areas not covered by higher level of detail data will be filled in with lesser level of detail if necessary.
Different kinds of data located in different files, such as a background sea chart and AML data placed on top, must be read using different S57DataSet instances in order to be rendered correctly by Carmenta Engine.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
ResourceObject
DataSet
FileDataSet
MultiFileDataSet
S57DataSet
Platforms
Windows, Linux, Android
S57DataSet Members
The S57DataSet type has the following members.
Constructors
| Name | Description |
|---|---|
| S57DataSet | Initializes a new instance of the S57DataSet class. |
Properties
| Name | Description |
|---|---|
| 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 |
| FeatureIndexPath | Gets or sets the directory where the feature index files will be saved. |
| FileName | Gets or sets the name of the file to read from. Inherited from FileDataSet |
| 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 |
| IndexFileName | Gets or sets an explicit index file name used for the generated index files in IndexPath. Inherited from MultiFileDataSet |
| IndexPath | Gets or sets the directory where the dataset index files are saved. Inherited from MultiFileDataSet |
| IsDisposed | Gets a value that tells whether the current S57DataSet 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 S57DataSet. Inherited from ResourceObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current S57DataSet represents. Inherited from EngineObject |
| Path | Gets or sets the path to the file or files to read from. Inherited from FileDataSet |
| S63DatabasePath | Gets or sets the path to an S-63 database. |
| ScaleBands | Gets or sets an object to override the default scale bands for S-57 ENC or AML data. |
| SearchableAttributes | The attributes that will be used to create a search index for the dataset. |
| SearchableCondition | Gets or sets a condition that determines which features will be included in the search index for the dataset. |
| SearchSubdirectories | Gets or sets a flag indicating if the dataset will search for data files recursively. Inherited from MultiFileDataSet |
| 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 |
| VerifyIndexFiles | Gets or sets a flag indicating if the contents of index files should be verified before use. Inherited from MultiFileDataSet |
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 |
| GetS63Warnings | Gets a list of warnings for incorrect S-63 cells in the specified view area and scale. |
| 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 |
| 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 |