CARIS Batch Utility : Compose Processes : Export S‑57 Product
 

Export S‑57 Product

Description

The ExportS57Product process exports an S‑57 product.

Update

An S-57 product (.prd file) as produced by the Compose module.

Outputs

The exported S‑57 (.000) file as named in the S‑57 product (.prd) file.

Command Line Syntax

carisbatch --run ExportS57Product [options] input

User Interface Command

Export Product

Options

The following table describes the parameters available for this process.

Parameter

Long

Short

Description

Can Repeat

Notes

--create-new-edition

N

If set, a new edition will be exported by incrementing the edition number in the product (.prd) file by one and using that edition number.

FALSE

Optional.

--comment-for-dsid

C

A string specifying a comment for the S‑57 data set ID (DSID) that will override the one given in the product (.prd) file.

FALSE

Optional.

--issue-date

I

A string specifying the issue date for the S‑57 data set that will override the one given in the product (.prd) file.

Dates are specified in the standard ISO 8601 extended format for batch processes, which is YYYY-MM-DD or YYYY-DDD. See ISO 8601 documentation for more information.

FALSE

Optional.

Example 1

To use this command refer to the following examples.

Example

Objective

You want to export the current file as a product.

Description

Command Line Syntax

The name of the product file is gb4x0000.prd and it is located in D:\BatchSample.

D:\BatchSample\gb4x0000.prd

The issue date for the product is October 5, 2016.

--issue-date “2016-10-05”

Command Line

carisbatch --run ExportS57Product --issue-date “2016-10-05” D:\gb4x0000.prd

Outcome

The product is exported.

Extra Notes

N/A

Example 2

Example

Objective

Export a new product with a new edition, comment, and issue date.

Description

Command Line Syntax

Create a new edition.

--create-new-edition

Define a new DSID comment.

-comment-for-dsid "Update beacons and buoys."

Define a new issue date.

--issue-date "2016-11-16"

The output product is named gb4x0000.prd and is located in D:\BatchSample\.

D:\BatchSample\gb4x0000.prd

Command Line

carisbatch --run ExportS57Product --create-new-edition --comment-for-dsid "Update beacons and buoys." --issue-date "2016-11-16" D:\BatchSample\gb4x0000.prd

Outcome

A new product using the defined parameters is created.

Extra Notes

N/A