SuperMap.Chart
The AgencyS57 class. It provides the related information of the agency which products the S-57 format data, including the acronym, code and name.
Gets the acronym of the agency.
The default value is String.Empty.
Gets the code of the agency.
The default value is -1.
Gets the name of the agency.
The default value is String.Empty.
The AttributeExpectedInputsS57 class. It's used to represent the related information of the expected input of the AttributeS57 object, such as the ID, meaning, definition, and references.
Gets the ID of the attribute that you expect to input.
Gets the meaning of the attribute that you expect to input.
Gets the definitions of the attribute that you expect to input.
Gets the references of the attribute that you expect to input.
The FeatureInfoS57 class. It's used to describe the basic information of the feature attributes, which includes the acronym, the name, and so on.
Gets the acronym of the attribute.
The default value is String.Empty.
Gets the attribute field name.
The default value is String .Empty.
Gets the localized name.
The default value is String.Empty.
Gets the definition of the attribute.
The default value is String.Empty.
Gets the reference information of the attribute.
The default value is String.Empty.
Gets the remark information of the attribute.
The default value is String.Empty.
Gets the type of the attribute.
Gets the code of the attribute.
The default value is 0.
Gets the collection which the attribute belongs to.
Gets the expected input collection of the S-57 feature attributes.
The default value is null.
Gets the display format of the attribute.
The default value is String.Empty.
Gets the indication information of the attribute.
Gets the restrictions when using this attribute.
The AttributeSpecs class. It’s used to provide the attribute fields of the features in the chart. For example, the ENC 3.1 version. It is obsolete. Replace it with AttributeSpec.
Gets the attribute field code.
The default value is 0.
Gets whether this attribute is required for the feature.
This class defines the chart attribute type contant.
Unknown type.
Enumerated ('E'). It means the expected value is selected from the AttributeExpectedInputsS57 collection, and the value must be correct.
List ('L'). It means the expected value is one or several values selected from the AttributeExpectedInputsS57 collection.
Float ('F'). It means the expected value is the float value with the limited ranges, resolution, unit and format.
Integer ('I'). It means the expected value is the integer value with the limited ranges, resolution, unit and format.
CodedString ('A'). It means the expected value is the ASCII string with the specified format.
FreeText ('S'). It means the expected value is the alphanumeric mixed string with free format.
The ChartAttributeInfo class. This class can be used to retrieve information on a chart object attribute such as the short name, the full name, the code, and the field value of the attribute.
Constructs a new ChartAttributeInfo object.
Gets the six-letter short name of an attribute.
Gets the attribute field name.
Gets the attribute code.
Gets the field value of the attribute.
The chart dataset group class. This class offers a way of building the chart dataset group via the dataset group. It also offers the type, dataset name, and default scale of the chart dataset group. Besides, this class can get the feature dataset from the chart dataset group.
Create the chart dataset group according to the given dataset group.
The specified dataset group.
The chart dataset group which is successfully created.
Get the type of the chart dataset group from the given dataset group.
The specified dataset group.
The type of the chart dataset group from the given dataset group.
Get the feature dataset with specified feature code and dataset type from the current chart dataset group.
This specified feature code.
The specified dataset type. Point, line, region and tabular are supported.
The feature dataset.
Get the feature dataset from the current chart dataset group according to the specified parameters.
Get the feature dataset with specified feature acronym and dataset type from the current chart dataset group.
This specified feature abbreviation.
The specified dataset type. Point, line, region and tabular are supported.
The feature dataset.
Get all feature datasets from the current chart dataset group.
All the feature datasets of the chart dataset group.
Releases all resources that the object occupies.
Gets the dataset group corresponding to the current chart dataset group.
Gets the type of the chart dataset group.
Gets the chart dataset name of the current chart dataset group. The field is DSID-DSNM.
Gets the chart scale of the current chart dataset group. The scale is used for making and editing the chart.
This enumeration defines the type constant of chart dataset group.
Unknown type. Not a chart, or an unknown type of chart.
The ineditable S-57 chart dataset group.
The editable S-57 chart dataset group.
This enum defines the chart display style constant.
Unknown type.
The chart type.
The paper chart type.
The ChartEnvironment class. This class is used to add and delete displaying styles, get and set dictionary file path through ChartConfig.xml.
Releases unmanaged resources and performs other cleanup operations before the ChartEnvironment is reclaimed by garbage collection.
Creates a new object of ChartEnvironment.
Adds a new displaying style in the configuration file.
The name of the new displaying style specified.
The specified displaying style.
True if it is removed successfully; false otherwise.
Gets the path of the region style lookup table according to the specified parameters.
The name of the specified displaying style.
The specified border whether to symbolize or not. If false, it gets the region style lookup table that isn't symbolized.
Gets the path of the region style lookup table.
Gets the path of the line style lookup table according to the specified displaying style.
The name of the specified displaying style.
Gets the path of the line style lookup table.
Gets the path of the point style lookup table according to the specified parameters.
The name of the specified displaying style.
Whether the specified symbol is simplified. If false, gets the traditional point lookup table of the chart.
Gets the path of the point style lookup table.
Gets the path of the color table according to the parameters.
The name of the specified displaying style.
The specified color mode.
The path of the color look-up table that you get.
Gets names of the configured displaying styles in the configuration file.
The name set of the displaying names that you get.
Gets the displaying style type according to the displaying style name.
The name of the specified displaying style.
The displaying style types that you get.
Removes the displaying style type according to the specified displaying style name.
The name of the specified displaying style.
True if it is removed successfully; false otherwise.
Set the path of the region style lookup table.
The specified style lookup table path.
The name of the specified displaying style.
The specified border whether to symbolize or not. If false, the region style lookup table isn't symbolized.
True if it is removed successfully; false otherwise.
Sets the color table path.
The path of the color look-up table that you specify.
The name of the specified displaying style.
The specified color mode.
True if it is removed successfully; false otherwise.
Set the path of the line style lookup table.
The specified style lookup table path.
The name of the specified displaying style.
True if it is removed successfully; false otherwise.
Set the path of the point style lookup table.
The specified style lookup table path.
The name of the specified displaying style.
Whether the specified point is simplified. If false, sets the traditional point lookup table of the chart.
True if it is removed successfully; false otherwise.
Disposes the local resources that ChartEnvironment occupies.
Gets or sets the agency file path.
Gets or sets the S-57 attribute file path.
Gets or sets the S-57 object file path.
Gets or sets the S-57 specification information file path.
Gets or sets the S-57 specification object file path.
Query the records of one or more chart DatasetGroup objects based on query parameters, and set the spatial extent to query. You can use the ChartQueryParameter class to set the parameters. The parameters includes FeatureInfo, AttributeFilter and the types of features to query.
Finds feature objects conforming to the specified query parameters in one or more dataset group and returns the corresponding recordset.
The chart DatasetGroup array. It contains at least one DatasetGroup.
The given ChartQueryParameter array. It contains at least one ChartQueryParameter object.
The given CursorType. The recordset can be modified when the CursorType is Dynamic, and the recordset is readOnly when the CursorType is Static.
ChartQueryResult array.
The length of datasetGroups is 0, or the length of queryParameters is 0.
Finds feature objects conforming to the specified query parameters in one or more chart dataset group and returns the correspoinding recordset.
Query the records in one or more chart DatasetGroup objects based on the given parameters in the given spatial extent.
The chart DatasetGroup array. It contains at least one DatasetGroup.
The specified space bounds.
The given ChartQueryParameter array. It contains at least one ChartQueryParameter object.
The given CursorType. The recordset can be modified when the CursorType is Dynamic, and the recordset is readOnly when the CursorType is Static.
ChartQueryResult array.
The length of datasetGroups is 0, or the length of queryParameters is 0.
The ChartQueryParameter class is used to set the parameters for ChartQuery. The parameters includes AttributeFilter, FeatureInfo and whether to query point (line/region) features.
Constructs a new ChartQueryParameter object.
Gets or sets FeatureInfoSpec.
Gets or sets whether to query point land mark.
The default value is true.
Gets or sets whether to query line land mark.
The default value is true.
Gets or sets whether to query region land mark.
The default value is true.
Gets or sets query filters.
The default value is String.Empty.
The ChartQueryResult class is used to get the result of ChartQuery, including dataset name and the corresponding ChartQueryResult array.
Gets the name of the DatasetGroup in the ChartQueryResult.
Gets the result Recordset array in the ChartQueryResult.
The ChartDatasetGroupManager class is used to create an editable S-57 chart dataset group, as well as the conversion between the editable S-57 dataset group and non-editable S-57 chart dataset group.
Converts the specified editable S-57 chart dataset group into the S-57 chart dataset group.
The specified editable S-57 dataset grouping.
The specified output datasource.
A chart dataset group that has been converted successfully.
Creates a new editable S-57 chart dataset group according to the specified S-57 chart information definition parameter.
The specified S-57 chart information definition parameter object.
The specified output datasource.
The specified FIDN sequence name.
The specified FIDS.
The created editable S-57 chart dataset group.
Converts the specified S-57 chart dataset group into the editable S-57 chart dataset group.
The specified editable S-57 chart dataset group object.
The specified output datasource.
The specified FIDNSequence name.
The specified FIDS.
The converted editable S-57 chart dataset group.
The event is trigged when the process bar is activated.
The ChartValidateParameter class provides properties which can set the validation types of chart data, such as the topological relationship of spatial features, chart information parameters, water depth, the association information of features and feature objects.
Constructs a new ChartValidateParameter object.
Gets or sets whether to check the parameter settings of a single chart. True denotes checking, while false denotes no checking. If the check is wrong, then it will be not to continue performing other checks.
The default value is false.
Gets or sets whether to check the chain node topology. True means to check, while false means not to check.
The default value is false.
Gets or sets whether to check the feature relationships. True means to check, while false means not to check.
The default value is false.
Gets or sets whether to check the soundings. True means to check, while false means not to check.
The default value is false.
Gets or sets whether to check the feature objects. True means to check, while false means not to check.
The default value is false.
Gets or sets whether to check the attributes of spatial features. True means to check, while false means not to check.
The default value is false.
The S-58 chart data check result class is used for obtaining the results of S-58 chart data check, including check number and error information.
Gets the CheckID.
Gets the error information of the check item.
This enumeration class defines the constants representing the types of modes for setting chart colors.
The day mode.
The dusk mode.
The night mode.
The DataExportChart class. This class can export data into the standard chart data (*.000 and other format files).
///
Creates a new instance of the DataExportChart object.
Creates a new instance of the DataExportChart object.
The exported result include the ExportResultChart array corresponding with the successful and failure task of exporting.
Return the result of export, including the ExportSettingChart arrays of success to export and the ExportSettingChart arrays of fail to export.
Releases the resources before recycling DataExportChart.
Releases all resources that the objects occupy.
The event is trigged when the process bar is activated.
Gets or sets the ExportSettingCharts object, which could be used to implement several export settings.
The default is the ExportSettingCharts object,which is used to store the ExportSettingChart object, and the default number of the ExportSettingChart object is zero.
The ImportChart object. This class could import the chart data (000 format file, etc. ) into the chart dataset group supported by the SuperMap.
Creates a new instance of the DataImportChart.
Implements the operation of importing dataset, return the ImportResultChart object as the result of import.
Returns the result of import, including the ImportSettingChart collection corresponding to the successful or failed task.
Releases the resources before recycling DataImportChart.
Releases all resources that the objects occupy.
The event is trigged when the process bar is activated.
Gets or sets the settings for importing data. This method can be used to complete settings of many imports.
The default value is a ImportSettingCharts object, which is used to store the ImportSettingChart object. The default number of the ImportSettingChart object is 0.
The DictionaryManagerChart class. This class gets the agency, attribute, feature information, feature specification of product specification, S-58 check item, specification information file, and specification objects file.
Gets the AgencyS57 collection object. It is obsolete. Replace it with GetAgencyS57s.
The AgencyS57 collection object.
Gets the AgencyS57 collection object.
The AgencyS57 collection object.
Gets the FeatureInfoS57 collection object.
The FeatureInfoS57 collection object.
Gets the set of AttributeS57.
The FeatureInfoS57 collection object.
Gets the FeatureInfoSpecs object. It is obsolete. Replace it with GetFeatureInfoSpecs().
The FeatureInfoSpecs collection object.
Gets the FeatureInfoSpec collection object.
The FeatureInfoSpecs collection object.
Gets the AgencyS57 object according to the given agency code.
The given agency code.
The AgencyS57 object.
Gets the AgencyS57 object according to the specified agency acronym.
The specified agency acronym.
The AgencyS57 object.
Gets the FeatureInfoS57 object according to the specified feature ID.
The specified feature ID.
The FeatureInfoS57 object.
Gets the FeatureInfoS57 object according to the specified feature acronym.
The specified feature acronym.
The FeatureInfoS57 object.
Gets the AttributeS5757 object according to the specified feature attribute code.
The specified feature attribute code.
The FeatureInfoS57 object.
Gets the FeatureInfoS57 object according to the acronym of the specified feature attribute.
The acronym of the specified feature attribute.
The FeatureInfoS57 object.
Gets the FeatureInfoSpecs object according to the specified feature code. It is obsolete. Replace it with GetFeatureInfoSpec(Int32).
The specified feature ID.
The FeatureInfoSpecs object.
Gets the FeatureInfoSpecs object according to the specified feature acronym. It is obsolete. Replace it with GetFeatureInfoSpec(String).
The specified feature acronym.
The FeatureInfoSpecs object.
Gets the FeatureInfoSpecs object according to the specified feature code.
The specified feature ID.
The FeatureInfoSpecs object.
Gets the FeatureInfoSpecs object according to the specified feature acronym.
The specified feature acronym.
The FeatureInfoSpecs object.
Reset S57SpecsObjectsFile. It is obsolete. Replace it with ResetS57SpecObjectsFile.
A Boolean value. It's used to determine whether the reset is successful. Return true if successful, or false otherwise.
Reset S57SpecsInfosFile. It is obsolete. Replace it with ResetS57SpecObjectsFile.
A Boolean value. It's used to determine whether the reset is successful. Return true if successful, or false otherwise.
Resets the S-57 specification dictionary file.
A Boolean value. It's used to determine whether the reset is successful. Return true if successful, or false otherwise.
Resets the basic S-57 specification information file.
A Boolean value. It's used to determine whether the reset is successful. Return true if successful, or false otherwise.
Gets S-58 check items information according to the specified check item number, including check content, error level and basis.
The specified S-58 check ID.
The S-58 check information of the specified ID.
Provides the data of the ExportChartSteppedEventArgs event.
Initializes a new instance of the SteppedEventArgs object
The title of the current progress bar.
The progress information of the current progress bar.
The percent of the current process have done
The completion percent of the current ongoing sub-operation.
The information of the current ongoing sub-operation.
Gets the count of the items of the tasks.
Whether to cancel all tasks.
Gets the completion percent of the current operation.
Gets the percent of the current sub item.
Gets the current ongoing item information, and returns the imported Setting directly.
Gets the count of the items of the tasks.
Gets or sets whether to cancel all the tasks.
Gets the title of the current progress bar.
Gets the progress information of the current progress bar.
Represents the method that handles a Stepped event.
The specified source event.
The ExportChartSteppedEventArgs class.
The ExportResultChart class, which provides the two methods such as SucceedSettings, FailedSettings to get the successful and the failed import settings.
Gets the ExportSettingChart set of the successful tasks.
Gets the ExportSettingChart set of the failed tasks.The user can get whether the count of the failed tasks is zero to determine whether imported successfully.
The ExportSettingChart class.
Creates a new instance of the ExportSettingChart.
Gets or sets the path of the target file to be exported.
The default value is String.Empty.
Gets or sets whether to cover the files with the same name by force when exporting the files to the same directory.
The default is false, indicating that the export operation doesn't be performed, otherwise covering files by force.
Gets or sets the type of the chart to be exported.
The default value is FileTypeChart.None.
The ExportSettingCharts class.
The Constructor.
Adds the specified ExportSettingChart object into the ExportSettingCharts object.
The specified ExportSettingChart object.
The index value corresponding to the newly added ExportSettingChart object.
Inserts the specified ExportSettingChart object at the specified index of the ExportSettingCharts class.
The specified index.
The specified ExportSettingChart object.
Returns true if successful, otherwise false.
Removes the ExportSettingChart objects from the ExportSettingCharts object with the specified index.
The specified index value.
Returns true if successful, otherwise false.
Clears all the ExportSettingChart objects from the ExportSettingCharts object.
Gets the IEnumerator object.
return the enumerator of the dataset set
Gets the total count of the features of the ExportSettingCharts object.
Gets the total count of the features of the ExportSettingCharts object.
The default value is 0.
Gets the ExportSettingChart object with specified index in the ExportSettingCharts object.
The specified index value. index must be greater than 0 and less than the Count, otherwise an exception is thrown.
The ExportSettingChart object corresponding to the specified index value.
The ExportSettingChartS57 class. This class inherits from the ExportSettingChart class.
Creates a new instance of the ExportSettingChartS57.
Builds a new object that is the same with the given ExportSettingChartS57 object.
The specified ExportSettingChartS57 object.
Constructs a new ExportSettingChartS57 object according to the specified parameter.
The specified outputted dataset object.
The path of the specified exported file.
Gets or sets the whole chart DatasetGroup object to export.
Gets or sets the type of the chart to be exported.
The default value is FileTypeChart.S57.
The FeatureInfoS57 class. It's used to represent the basic information of the FeatureS57, which includes the acronym, name, type and other related information.
Gets the acronym of the feature.
The default value is String.Empty.
Gets the name of the feature.
The default value is String.Empty.
Gets the definition of the feature.
The default value is String.Empty.
Gets the reference information of the feature.
The default value is String.Empty.
Gets the remark information of the feature.
The default value is String.Empty.
Gets the type of the feature.
The default value is FeatureTypeChart.None.
Gets the code of the feature.
The default value is 0.
The FeatureInfoSpecs class. It's used to describe the basic information of the specification feature of the products, which includes the name, type and the related attributes. For example, the ENC 3.1 version. It is obsolete. Replace it with FeatureInfoSpec.
Gets the acronym of the feature.
The default value is String.Empty.
Gets the name of the object.
The default value is String.Empty.
Gets the localization name of the object.
The default value is String.Empty.
Gets the code of the feature.
The default value is 0.
Gets the object type which could be applied by the feature.
The default value is String.Empty.
Gets the attribute fields of the feature.
-57 feature object identifier information class.
Constructs a new S57FeatureObjectIDInfo object.
Constructs a new S57FeatureObjectIDInfo object according to given parameters.
The specified feature acronym.
The specified FOID, i.e., long name.
Gets or sets the feature acronym.
The default value is null.
Gets or sets FOID, i.e., long name.
The default value is null.
The S-57 feature relationship class. This class provides the creation and maintenance of feature relationships (including master-slave relationship and equal relationship).
Creates a new FeatureRelationships object.
Constructs a new FeatureRelationships object according to the specified S57EditDatasetGroup object.
The specified S57EditDatasetGroup object.
Set the editable S-57 chart dataset group.
The editable S-57 chart dataset group.
Gets all the master-slave relationships in the current chart.
All the master-slave relationships in the current chart. The dictionary key is the FOID of the master feature, and its value is the FOID of the slave feature.
Creates a new master-slave relationship.
The specified FOID of the specified master feature.
The specified FOID of the specified slave feature.
True if successful; otherwise, false.
Gets the FOID of the slave feature according to the specified master feature.
The specified FOID of the specified master feature.
The feature identifier information array of the slave feature corresponding to the specified master feature.
Resets the master-slave relationship.
The specified FOID of the specified master feature.
The specified feature identifier information array of the specified slave feature.
True if successful; otherwise, false.
Deletes the master-slave relationship corresponding to the feature specified with the FOID.
The specified FOID of the specified master feature.
True if successful; otherwise, false.
Gets the information of all the collection features in the current chart.
The information of all the collection features in the current chart.
Creates a collection feature according to the FOID of the specified feature object.
The feature acronym of the specified collection feature is used for determining the type of the built collection feature, which only can be "C_AGGR" or "C_ASSO".
The feature identifier information array of the feature object referenced by the specified collection feature to be created.
The FOID of the new collection feature.
Gets the FOID of the feature object referenced by the specified collection feature.
The specified FOID of the specified collection feature.
The feature identifier information array of the feature object referenced by the specified collection feature.
Resets the collection feature object, i.e., resets the referenced feature object of the specified collection feature object.
The FOID of the specified collection features to be reset.
The specified feature identifier information array of the specified referenced feature.
True if successful; otherwise, false.
Deletes the association relationship between the collection feature and its referenced feature, or specifies whether to delete the collection feature.
The specified collection feature whose association relationship will be deleted.
Specifies whether to delete the collection feature. If true, then deletes the association relationship between the collection feature and its referenced feature, and deletes the collection feature (one record) from the collection feature dataset (a tabular table).
A boolean value denotes whether deleting the collection feature and its referenced relationship are successful or not. True if successful; otherwise, false.
Sets the value of the attribute field specified by the collection feature.
The FOID of the specified collection feature.
The attribute acronym of the specified collection feature.
The specified attribute value to be set up.
True if successful; otherwise, false.
Gets the value of the specified property of the collection feature.
The FOID of the specified collection feature.
The acronym of the specified attribute to get.
The value of the specified attribute.
Gets the attribute information of the collection feature.
The FOID of the specified collection feature.
The property information array of the collection feature.
This class defines the type constant of the features.
The unknown feature object.
The geographic feature object ('G'), indicating that the description of the objective world is contained.
The mate-feature object ('M'), indicating that other feature information (such as the editing scale, vertical datum) is contained.
The collection feature object ('C'), indicating that the relationship between features is described.
The cartographic object ('$'), indicating that the map display information of the objective world entity is contained.
This class defines the type constant of the chart conversion file.
Unknow data format.
The S-57 chart format, 000 file.
The ImportChartSteppedEventArgs class.
Initializes a new instance of the ImportSteppedEventArgs class with the specified parameters.
The title of the current progress bar.
The progress information of the current progress bar.
Gets the total percent of the current operation.
Gets the percent of the current sub item.
The current item information.
Gets the count of the items of the tasks.
Whether to cancel all the import tasks.
Gets the title of the current progress bar.
Gets the progress information of the current progress bar.
Gets the completion percent of the current operation.
Gets the percent of the current sub item.
Gets the information of the item of the current task and returns the ImportSettingChart object.
Gets the count of the items of the tasks.
Gets or sets whether to cancel all the tasks.
Returns true if successful, otherwise false.
Represents the method that handles a Stepped event.
The specified source event.
The ImportChartSteppedEventArgs class.
The ExportResult class, which provides the two methods such as SucceedSettings, FailedSettings to get the successful and the failed import settings.
Releases unmanaged resources and performs other cleanup operations before the Geometry is reclaimed by garbage collection.
Releases all resources that the objects occupy.
Gets the ImportSettingChart settings of the successful tasks.
Gets the ImportSettingChart settings of the failed tasks.The user can get whether the count of the failed tasks is zero to determine whether imported successfully.
The ImportSettingChart class. This class is the base class of all the import setting classes. It provides the common methods and properties.
Creates a new instance of the ImportSettingChart.
Frees the resources of the non-managed object before it is reclaimed by the garbage collector.
Releases all resources that the objects occupy.
Gets or sets the path of the chart file to be imported.
Gets the type of the chart data to be imported.
The default value is FileTypeChart.None.
Gets or sets the code type of the dataset to be created.
The default value is the code type in the source data.
Gets or sets the target datasource connected information. If there is no corresponding datasource, create a new datasource according to the connected information.
The default value is null.
Gets or sets the target datasource object to be imported.
The default value is null.
Sets or Gets whether to convert the imported data into the Mercator coordinate system.
The default is false.
Gets or sets the grouping information of the target dataset.
The collection class of import setting information.This class is the collection class of ImportSettingChart object.
Creates a new instance of the ImportSettingCharts class.
Adds a specified ImportSettingChart to the ImportSettingCharts object.
The specified ImportSettingChart object.
The index value corresponding to the newly added ImportSettingChart object.
Inserts a specified ImportSettingChart object to the specified index of the ImportSettingCharts object.
The specified index.
The specified ImportSettingChart object.
Returns true if successful, otherwise false.
Removes the items from the ImportSettingCharts object with the specified index.
The specified index value.
Returns true if successful, otherwise false.
Clears all the ImportSettingChart objects from the ImportSettingCharts object.
Gets the IEnumerator object.
return the enumerator of the dataset set
Gets the total counts of the features of the ImportSettingCharts object.
Gets the count of the elements in the specified ImportSettings.
The default value is 0.
Gets the ImportSettingChart object with specified index in the ImportSettingCharts object.
The specified index value.
The specified index corresponding to the ImportSettingChart object.
The ImportSettingChartS57 class. This class is inherited from the ImportSettingChart class.
Creates a new instance of the ImportSettingChartS57.
Gets or sets the information of the spatial index.
The default value is null, indicating that the space index information is null.
Gets or sets whether to update the data (001, 002, ...) when the 000 file is imported.
The default value is true representing that the data will be updated.
The S57CellInformation class is used for getting and setting the information of a S-57 electronic chart, including AgencyCode, CellName, IntendedUsage, EditionVersion, IssueDate, UpdateVersion, UpdateDate, DataSetIdentificationComment, CompilationScale, VerticalDatum, SoundingDatum, CoordinateFactor, DataSetParameterComment, ATTFLexicalLevel and NATFLexicalLevel.
Construct a new S57CellInformation object.
Releases all resources that the object occupies.
Gets or sets the agency code, corresponding to DSID-AGEN.
The default value is -1.
Gets or sets the vocabulary level of ATTF, corresponding to DSSI-AALL.
Default is S57LexicalLevel.Level0.
Gets or sets the name of the dataset, corresponding to DSID-DSNM.
The default is a null string.
Gets or sets the data editing scale, corresponding to DSPM-CSCL.
The default value is -1.
Gets or sets the zoom in coefficient of the coordinates, corresponding to DSPM-COMF.
The default value is -1.
Gets or sets the annotation information of the DSID field, corresponding to DSID-COMT.
The default is a null string.
Gets or sets the annotation information of the DSPM field, corresponding to DSPM-COMT.
The default is a null string.
Gets or sets the version number, corresponding to DSID-EDTN.
The default value is 1.
Gets or sets the nautical purpose, corresponding to DSID-INTU.
Default is S57IntendedUsage.OverView.
Gets or sets the issure date, corresponding to DSID-ISDT.
The default value is 20130101.
Gets or sets the vocabulary level of NATF, corresponding to DSSI-NALL.
Default is S57LexicalLevel.Level0.
Gets or sets the sounding datum, corresponding to DSPM-SDAT.
The default value is -1.
Gets or sets the update date, corresponding to DSID-UADT.
The default value is 20130101.
Gets or sets the update version, corresponding to DSID-UPDN.
The default value is 0.
Gets or sets the vertical datum, corresponding to DSPM-VDAT.
The default value is -1.
The S57DatasetExtInfo class. The extension information can be obtained by this class, such as dataset type, the acronym, the code and the dataset related to the attribute dataset, and so on.
Creates a new instance of the S57DatasetExtInfo object.
The specified Dataset object.
Releases all resources used by the S57DatasetExtInfo.
Frees the resources of the current managed object before it is reclaimed by the garbage collector.
Writes the extension information into the dataset.
Returns true if successful; otherwise, false.
Determines whether to be the chart dataset by the extension information.
A boolean value means whether to be the chart dataset, returns true if yes, or false otherwise.
Gets or sets the dataset.
Gets or sets the type of the S-57 dataset.
Gets or sets the S-57 feature acronym. Only chart dataset with the S57DatasetType.S57FEATURE type is supported.
Gets or sets the S-57 feature code. Only chart dataset with the S57DatasetType.S57FEATURE type is supported.
The S-57 chart dataset grouping class.
Gets the coordinate system of the chart corresponding to the current S-57 chart dataset group.
The S57DatasetGroupExtInfo class. This class could be used get the grouped extension of the dataset, which includes the filename, the default scale, the spatial isolated node dataset, the spatial linked node dataset and so on.
Creates a new S57DatasetGroupExtInfo object according to the specified arguments.
The specified DatasetGroup object.
Releases all resources used by the S57DatasetGroupExtInfo.
Frees the resources of the current managed object before it is reclaimed by the garbage collector.
Writes the extension information to the dataset group. If this interface isn't called, the information cannot be written to the dataset group.
Returns true if successful, otherwise returns false
Determines whether it is the chart dataset group by the extension information.
A Boolean value indicates whether to be the chart dataset group, true means yes, or false otherwise.
Gets the feature dataset according to the feature code value and the dataset type (the geometry type). The dataset type contains Point, Line, Region, and Tabular.
The specified feature code.
The specified type of dataset.
The feature dataset.
Sets the feature dataset.
The dataset requires that the extension information of the dataset has been set. If the current dataset group already contains the dataset with the same type, then the set fails. Because the feature with the same type has multiple geometry types. Therefore, a kind of features in the chart dataset group contains the dataset with several types, and every type is unique.
Returns true if successful,otherwise returns false.
Deletes the feature dataset with the specified code and the type (the geometry type).
This specified feature code.
The specified type of dataset.
Gets or sets the DatasetGroup.
Gets or sets the filename of the chart. It's saved in the DSNM field.
Gets or sets the scale of the layer.
Gets or sets the chart coordinates. Its supports WGS1984 and World Mercator.
Gets or sets the DSID dataset. It supports the S57DSID type in the S57DatasetType.
Gets or sets the spatial isolated node dataset. It supports the S57VI type in the S57DatasetType.
Gets or sets the spatial linked node dataset. It supports the S57VI type in the S57DatasetType.
Gets or sets the spatial boundary line dataset. It supports the S57VE type in the S57DatasetType.
Gets or sets the dataset which stores the topology relationship from the feature to the spatial boundary. It supports the S57FVE type in the S57DatasetType.
Gets or sets the dataset which stores the topology relationship from the feature to the spatial points (including the isolated nodes and the link nodes). It supports the S57FVP type in the S57DatasetType.
Gets or sets the dataset which stores the relationships between the features. It supports the S57RS type in the S57DatasetType.
Gets or sets all the feature datasets in the current map sheet. It supports the S57FEATURE type in the S57DatasetType.
This class defines the type constant of the chart dataset to be imported.
Non-chart dataset.
The feature dataset.
The dataset that stores the DSID and DSPM field in the S-57 file.
The dataset that stores the spatial isolated points.
The dataset that stores the spatial link node.
The dataset that stores the spatial boundaries.
The dataset that stores the spatial topology relationship from the feature object to the spatial boundary object.
The dataset that stores the spatial topology relationship from the feature object to the spatial point (isolated point and link node).
The dataset that stores the connection relationships between feature objects.
The AttributeSpecs class. It’s used to provide the attribute fields of the features in the chart. For example, the ENC 3.1 version.
Gets the attribute field code.
The default value is 0.
Gets whether this attribute is required for the feature.
The FeatureInfoSpecs class. It's used to describe the basic information of the specification feature of the products, which includes the name, type and the related attributes. For example, the ENC 3.1 version.
Gets the acronym of the feature.
The default value is String.Empty.
Gets the name of the object.
The default value is String.Empty.
Gets the localization name of the object.
The default value is String.Empty.
Gets the code of the feature.
The default value is 0.
Gets the object type which could be applied by the feature.
The default value is String.Empty.
Gets the attribute fields of the feature.
Class of dataset group for editable S-57 chart data. This class is used to edit and query the chart data. It can create, delete feature datasets, append records to the feature dataset, set basic information of nautical chart, set chain node topological relations for the chart, and check S-58 data.
Creates a new feature dataset according to the specified feature code and the dataset type, and adds this new feature dataset to the current editable S-57 chart dataset group. The creation will be failed if the corresponding feature dataset exists.
This specified feature code.
The specified dataset type. Point, line, region and tabular are supported.
The new feature dataset. Return null if the creation is failed.
Creates a new feature dataset according to the specified arguments, and adds this new feature dataset to the current editable S-57 chart dataset group.
Creates a new feature dataset according to the specified feature acronym and the dataset type, and adds this new feature dataset to the current editable S-57 chart dataset group. The creation will be failed if the corresponding feature dataset exists.
The specified feature acronym.
The specified dataset type. Point, line, region and tabular are supported.
The new feature dataset. Return null if the creation is failed.
Appends recordset to the feature dataset with the given feature code and the dataset type from the current editable S-57 chart dataset group.
This specified feature code.
The specified feature dataset to be appended.
The source field array, corresponding to the field in the source recordset to be appended.
The specified target field array, corresponding to the fields in the new or existed feature dataset.
Whether to create a new feature dataset or not when the feature dataset doesn't exist. The new dataset will be created and the recordset appended if it is true; otherwise, false. Note, the recordset will be always appended to the dataset if the feature dataset exists, regardless of true or false.
The feature dataset after being appended successfully.
Appends the recordset to the feature dataset of the current editable S-57 chart dataset group according to the given aurgments.
Appends recordset to the feature dataset with the given feature acronym and the dataset type from the current editable S-57 chart dataset group.
The specified feature acronym.
The specified feature dataset to be appended.
The source field array, corresponding to the field in the source recordset to be appended.
The specified target field array, corresponding to the fields in the new or existed feature dataset.
Whether to create a new feature dataset or not when the feature dataset doesn't exist. The new dataset will be created and the recordset appended if it is true; otherwise, false. Note, the recordset will be always appended to the dataset if the feature dataset exists, regardless of true or false.
The feature dataset after being appended successfully.
Deletes the feature dataset with the given feature code and the dataset type from the current editable S-57 chart dataset group.
This specified feature code.
The specified dataset type. Point, line, region and tabular are supported.
Returns true if successful; otherwise, false.
Deletes a feature dataset from the current editable S-57 chart dataset group according to the given argument.
Deletes the feature dataset with the given feature acronym and the dataset type from the current editable S-57 chart dataset group.
The specified feature acronym.
The specified dataset type. Point, line, region and tabular are supported.
Returns true if successful; otherwise, false.
Check the chart data according to the given parameters.
The specified chart validation parameter.
Whether to show the progress information or not. Show the progress bar if it is true; otherwise, false.
The collection of the chart data after being validated.
Builds the chain node topology for the chart that corresponds to the current S-57 chart dataset group.
Whether to show the progress information or not. Show the progress bar if it is true; otherwise, false.
true if successful; otherwise, false.
Gets the feature objects reference to the spatial objects. The precondition is that the topology relation must be built.
This specified feature RCID.
The geometry type of the specified feature object.
Whether to return spatial attributes or not.
Whether to return spatial geometries or not.
The reference information array of feature objects to spatial objects.
Sets the masking indicator of the feature objects reference to the spatial objects. It is only valid for the line and region feature objects. The precondition is that the topology relation must be built.
This specified feature RCID.
The specified spatial object ID. For the spatial object ID, please refer to the SpatialObjectID property of the S57FeatureToSpatialPointer class.
The specified masking indicator type.
True if successful; otherwise, false.
Gets the masking indicator of the feature objects reference to the spatial objects. It is only valid for the line and region feature objects. The precondition is that the topology relation must be built.
The specified feature RCID.
The specified spatial object ID. For the spatial object ID, please refer to the SpatialObjectID property of the S57FeatureToSpatialPointer class.
The masking indicator of the feature objects reference to the spatial objects.
Sets the spatial attribute value.
The specified spatial object ID. For the spatial object ID, please refer to the SpatialObjectID property of the S57FeatureToSpatialPointer class.
The acronym of the specified attribute.
The specified attribute value.
True if successful; otherwise, false.
Gets the spatial attribute value.
The specified spatial object ID. For the spatial object ID, please refer to the SpatialObjectID property of the S57FeatureToSpatialPointer class.
The array of the spatial attribute values.
Gets the spatial attribute value.
The specified spatial object ID. For the spatial object ID, please refer to the SpatialObjectID property of the S57FeatureToSpatialPointer class.
The acronym of the specified attribute to get.
The spatial attribute value.
Gets the spatial geometry object.
The specified spatial object ID. For the spatial object ID, please refer to the SpatialObjectID property of the S57FeatureToSpatialPointer class.
The spatial geometry object.
Recreates the feature object ID (FOID) of all feature objects.
Whether to show the progress information or not. Show the progress bar if it is true; otherwise, false.
True if successful; otherwise, false.
Gets the assigned feature ID distinction (FIDS) when the editable S-57 chart dataset group is created.
The assigned feature ID distinction (FIDS) for the editable S-57 chart dataset group.
Gets the FIDN sequence name of the datasource where the editable S-57 chart dataset group stores.
The FIDN sequence name of the datasource where the editable S-57 chart dataset group stores.
Gets or sets the chart definition parameters of the current editable S-57 dataset group.
The event is trigged when the process bar is activated.
S57FeatureToSpatialPointer is used for retrieving the reference relationships between features and spatial objects, including the record ID of the referenced spatial object (RCID), the directions that Linear and planar features are relative to the spatial objects, the masking indicator of boundary lines and the differentiation between the internal boundary line and the external boundary line of the planar feature.
Releases all resources that the object occupies.
Gets an unique identifier of spatial identifier objects.
Gets the reference way for the direction of the edge (linear spatial object).
Gets the usage guide of the planar features to reference edges (linear spatial features).
Gets the masking indicator of reference edges (linear spatial features).
Gets the geometry object of the referenced spatial features.
Gets the property information of the referenced spatial features.
This enumeration defines the nautical purpose constant of the S-57 chart.
For review,namely schematic diagram.
For general purpose, namely general map.
For coastal areas, namely coastal map.
For inshore areas, namely the entrance map.
For ports, namely port map.
For berths, namely anchoring map.
This enumeration defines S-57 character set constant.
Level 0, i.e., ASC Ⅱ text, ISO / IEC 646 international reference version (IRV).
Level 1, i.e., the first part of the ISO 8859, the Latin alphabet series 1 (such as Western Europe, Latin). Level 1 character set can be directly used in almost all computer systems.
Level 2, i.e., the UCS-2 complement level 1 (non-combining characters), ISO/IEC 10646 multilingual platform (for example, including Latin characters, Greek, Cyrillic, Chinese, Japanese, etc.). Level 2 character set is suitable for almost all languages, but its coding efficiency is low.
This enumeration defines the mask indicating constant of the spatial object.
Shield.
Display.
Irrelevant to the mask.
The S57SoundingGroup class is used for editing the soundings and providing rich functions such as grouping the soundings, adding/deleting sounding points into the sounding group and retrieving and modifying the feature attributes of soundings.
Constructs a new S57SoundingGroup object.
Constructs a new S57SoundingGroup object according to the specified S57EditDatasetGroup object.
The specified S57EditDatasetGroup object.
Set the editable S-57 chart dataset group.
The editable S-57 chart dataset group.
Groups the specified sounding points and automatically divides the soundings point with same attributes into a group.
The specified sounding points ID array to be grouped. If it is specified as an null array, then all the sounding points in the sounding dataset will be grouped by default.
The feature long name of each sounding group. If grouping is failed, then return null.
The specified sounding points are grouped into one group.
The specified water depth ID array.
The feature long name after grouping. If grouping is failed, then return null.
Adds the specified sounding points into an existing sounding group.
The long name of the specified existing sounding group.
The specified sounding ID group to be added into the sounding group.
True if successful; otherwise, false.
Deletes the specified sounding points from an existing sounding group.
The long name of the specified sounding group.
The specified sounding points to be deleted.
Returns true if successful; otherwise, false.
Gets the FOID for all the sounding groups in the current chart.
The FOID array of the sounding group.
Gets the sounding point object of the specified FOID.
The long name of the specified sounding point.
The sounding point array with the specified FOID. The sounding point uses the GeoPoint3D object for representation. The Z value is the sounding value. Unit is meter.
Gets the feature attribute of the sounding group of the specified FOID.
The long name of the specified sounding group.
The feature attribute collection of sounding group.
Gets the value of the specified attribute of the sounding group.
The long name of the specified sounding group.
The specified property acronym.
The attribute value of the specified attribute acronym.
Sets the attribute value of the specified attribute of the sounding group.
The long name of the specified sounding group.
The specified property acronym.
The specified attribute value.
Returns true if successful; otherwise, false.
Gets the depth of the sounding point.
The specified soundings IDs.
The given depth of the sounding point.
Sets the depth of the sounding point.
The specified soundings IDs.
The specified depth.
True if successful; otherwise, false.
The S-58 check item information class. This class is used to get S-58 check ID, check contents, and error type.
Gets the check ID of this S-58 chart.
Gets the error level of this S-58 chart.
Gets the checking description of this S-58 chart.
Gets the reference of this S-58 chart, i.e., the content position of S-57 standard.