CARIS HPD : CARIS® Batch : S-57 Composer Processes : Create S-57 Exchange Set
 

Create S-57 Exchange Set

The CreateS57ExchangeSet process creates a new S-57 exchange set.

Input

N/A

Output

Location of the S-57 exchange set to create. If this directory does not exist, it will be created.

Command Line Syntax

carisbatch --run CreateS57ExchangeSet --file-to-add <value> [options]

User Interface Command

Tools > Editors > S-57 Exchange Set

Options

Long

Short

Description

Can Repeat

Notes

--file-to-add

-a

New file to add to the exchange set. At least 1 file must be added to the new exchange set, and multiple files can be added.

When adding an S-57 file (base or update), its external files are also added.

TRUE

Required

--external-files-folder

-e

Location of external files.This must be an existing folder.

If this is not specified, external files are assumed to be in the same location as the dataset being added.

FALSE

Optional

--folder-structure

If set, the new exchange set is created using the specified folder structure:

DEFAULT: Creates an exchange set with all files placed directly in the exchange set folder.

S63: Creates an exchange set using the standard S-63 folder structure. This is equivalent to the deprecated UseS63FolderStructure option.

DATASET_NAME: Creates an exchange set with a <dataset_name> folder for each dataset in the exchange set. The dataset's base, update and support files are in the dataset folder.

AGENCY/EDITION/DATASET_NAME: Creates an exchange set with an agency folder followed by an edition number folder and then a folder for the dataset. The dataset's base, update and support files are in the dataset folder.

DEFAULT is the default.

FALSE

Optional

Example

Objective

Create an S-57 exchange set with several files, and specify an existing folder in which to place the new exchange set using the DATASET_NAME folder structure.

Description

Command Line Syntax

Add 4 files.

--file-to-add C:\dataset1.000 --file-to-add C:\dataset1.001 --file-to-add C\dataset2.000 --file-to-add C:\readme.txt

Set the output folder for the new exchange set.

--external-files-folder C:\externalFiles

Use the DATASET_NAME folder structure.

--folder-structure DATASET_NAME

Output for the process.

C:\exchangeSets\testExchangeSet\ENC_ROOT

Command Line

carisbatch --run CreateS57ExchangeSet --file-to-add C:\dataset1.000 --file-to-add C:\dataset1.001 --file-to-add C\dataset2.000 --file-to-add C:\readme.txt --external-files-folder C:\externalFiles --folder-structure DATASET_NAME C:\exchangeSets\testExchangeSet\ENC_ROOT