Exports S-101 hydrographic data from a geodatabase to an S-101 file.
Usage
S-101 products are clipped and extracted based on the area or areas of interest (up to three), pursuant to the S-101 specification, in the ProductCoverage feature class.
The product name is in accordance with the DatasetName listed in the ProductDefinitions table.
The following criteria must exist to export an S-101 cell:
Product information populated in the ProductDefinitions table
At least one area of interest (AOI) in the ProductCoverage feature class with a relationship to the corresponding ProductDefinitions
The tool builds geometry primitives.
This tool creates an S100_ROOT folder that contains the exchange set catalog (CATALOG.XML) and the exported S-101 cell. This output is an intermediate S-100 exchange set that can be loaded into the S-100 Exchange Set Editor to add digital signature, support files, and additional products.
This tool does not reproject data. Verify that the projection field of the product metadata matches that of the source geodatabase.
This tool groups soundings and assigns a Feature Object Identifier (FOID) to each sounding group.
An .xml file that follows the S-100 Feature Catalogue format as defined by the IHO. It describes the content of a data product and its specifications. The default file location for S-100 catalogue files is <ArcGIS Maritime installation location>\ArcGIS Maritime\Product Files\<version>\S-101\, provided the Maritime product files are installed.
File
S-101 Workspace
The workspace that contains the product.
Workspace
S-101 Product
The name of the product that will be exported.
This information must exist in the ProductCoverage feature class and ProductDefinitions table before using this tool.
String
Export Type
Specifies the type of file that will be created during export.
New Dataset—A new dataset including information that has not been previously distributed by updates will be created.
New Edition—A new edition of a dataset including information that has not been previously distributed by updates will be created.
Update—Changes to a dataset since the last export will be reflected in the file.
Reissue—A reissue of a dataset including all the updates applied to the original dataset up to the date of reissue will be created. A reissue does not contain information that has not been previously issued by updates.
Cancel—When a dataset is deleted, an updated cell file will be created containing only the Dataset General Information record with the Dataset Identification (DSID) field. In this case, the Dataset edition (DSED) subfield must be set to 0.
String
Output Location
The location where the export package will be written.
Folder
Sample Export
(Optional)
Specifies whether the product will be exported as a sample.
Checked—The exported cell is not stored in the ProductExports table and the metadata information will not be updated in the ProductDefinitions table.
Unchecked—The exported cell is stored in the ProductExports table as a BLOB, and the edition, update, and other metadata in the ProductDefinitions table will be updated. This is the default.
Boolean
Suppress Exchange Set
(Optional)
Specifies whether an S-100 exchange set will be generated.
Checked—An exchange set will not be generated.
Unchecked—An exchange set will be generated. This is the default.
An .xml file that follows the S-100 Feature Catalogue format as defined by the IHO. It describes the content of a data product and its specifications. The default file location for S-100 catalogue files is <ArcGIS Maritime installation location>\ArcGIS Maritime\Product Files\<version>\S-101\, provided the Maritime product files are installed.
File
in_s101_workspace
The workspace that contains the product.
Workspace
product
The name of the product that will be exported.
This information must exist in the ProductCoverage feature class and ProductDefinitions table before using this tool.
String
export_type
Specifies the type of file that will be created during export.
NEW_DATASET—A new dataset including information that has not been previously distributed by updates will be created.
NEW_EDITION—A new edition of a dataset including information that has not been previously distributed by updates will be created.
UPDATE—Changes to a dataset since the last export will be reflected in the file.
REISSUE—A reissue of a dataset including all the updates applied to the original dataset up to the date of reissue will be created. A reissue does not contain information that has not been previously issued by updates.
CANCEL—When a dataset is deleted, an updated cell file will be created containing only the Dataset General Information record with the Dataset Identification (DSID) field. In this case, the Dataset edition (DSED) subfield must be set to 0.
String
output_location
The location where the export package will be written.
Folder
sample_export
(Optional)
Specifies whether the product will be exported as a sample.
SAMPLE_EXPORT—The exported cell is not stored in the ProductExports table and the metadata information will not be updated in the ProductDefinitions table.
OFFICIAL_EXPORT—The exported cell is stored in the ProductExports table as a BLOB, and the edition, update, and other metadata in the ProductDefinitions table will be updated. This is the default.
Boolean
suppress_exchange_set
(Optional)
Specifies whether an S-100 exchange set will be generated.
SUPPRESS_EXCHANGE_SET—An exchange set will not be generated.
GENERATE_EXCHANGE_SET—An exchange set will be generated. This is the default.
Boolean
Derived output
Name
Explanation
Data type
out_output_file
The file to which output data will be written.
File
Code sample
ExportS101Cell example (stand-alone script)
The following script demonstrates how to use the ExportS101Cell function.