CARIS HPD : CARIS® Batch : Feature Editing Processes : Add Features
 

Add Features

Description

The AddFeatures process copies features from the input to the output. It may only copy some features when the KeepFOID option is used.

Inputs

Features in a supported format. HOB, H2O, 000 (S-57 or S-101 specification), HPD database URI and simple feature table URI are supported, as well as OGR sources such as Shapefile and GML.

Multiple inputs may be specified except for an HPD database. The wildcard character "*" may be used to specify multiple inputs, or the full path of each may be given.

Shapefiles must be in CARIS Shapefile Format and use a recognized Shapefile Coordinate Reference System. HPD Source database URIs must contain a project with a boundary.

If an input dataset has a map scale, it may be copied to the update dataset. If multiple input datasets are given, the map scale of the first specified input is used. However, a map scale is only copied to the update dataset if it does not contain any features to start.

Update

HOB file, H2O file or HPD database URI.

An HPD URI must specify the project to use and either a usage or a product to update. If a HOB or H2O file does not exist, a new one is created.

Process Models

When an HPD URI is specified for update, AddFeatures only queries features from HPD that match the input features by FOID. If the output of AddFeatures is passed to another process in a process model, features are not queried from HPD by the next process. Only the features that have matching FOIDs are provided by AddFeatures when an HPD URI is specified for update.

Command Line Syntax

carisbatch --run AddFeatures [options] <inputs> <output>

Options

Parameter

 

Long

Short

Description

Can Repeat

Notes

 

--keep-foid

-k

If set, the feature object identifiers (FOIDS) of the input are used for the output features when they are unique in the output. If an input feature has the same FOID as an existing output feature, the input feature is not added to the output.

If the output is a database and a feature already exists in the database with the same FOID, feature class and attributes as an input feature, the feature is added to the specified usage by adding a new representation, provided that the feature does not already have a representation on the usage. Attributes are considered matching if all of the defined attributes of the input feature match the attributes of the output feature - the output feature may have defined attributes that are not defined for the input feature. Note that the attributes of the output feature are not modified.

New FOIDs are always assigned when multiple new features are generated from area or line composite features or sounding groups. Composite features and sounding groups are not supported in all formats.

If not set, new FOIDs are assigned and all input features are added to the output.

If the input is a GML or Shapefile and uses a 'fid' or 'FOID' attribute to hold the FOID, that is used as the FOID when the KeepFOID option is used.

FALSE

--require-all

-q

If set, the process is cancelled if any of the features cannot be added.

FALSE

--feature-catalogue

-F

String specifying the name of the catalogue that defines the features and attributes in a vector dataset. One of {list dynamically populated from the catalogue control file}.

The names of the available catalogues can be accessed through application via the Object Catalogue environment variable in Tools > Options. The available catalogues are controlled by the Catalogue Control file. An example of a catalogue name is "S-57 ENC 3.1".

A catalogue must be specified only when the output is a HOB or H2O file. If the output is not a HOB or H2O file, a warning message reports that the option has been ignored.

FALSE

Must be specified explicitly.

--map-undefined-attribute-value

-n

Attribute value to map to Undefined.

All attributes with the given value are mapped to Undefined in the output.

FALSE

--map-unknown-attribute-value

-w

Attribute value to map to Unknown.

All attributes with the given value are mapped to Unknown in the output.

FALSE

--certification-status

Certification status that is assigned to all new features:

UNDER_CONSTRUCTION

ACCEPTED

VERIFIED

NOT_VERIFIED.

This option is only used with HPD URIs.

When this option is used and the output does not support certification status, a warning message reports that the option has been ignored.

The default is UNDER_CONSTRUCTION.

FALSE

--input-crs

-P

String specifying the horizontal coordinate reference system key of the input.

This option is only used when the input is a generic feature table that does not have a registered coordinate reference system.

FALSE

--overwrite

-o

If set, the output file is overwritten rather than updated. Applies only to HOB and H2O files.

FALSE

Example

Objective

You want to add features to an existing map.

Description

Command Line Syntax

Existing FOIDs in the inputs are applied to the output, when possible.

--keep-foid

Process will be cancelled if any of the features cannot be added.

--require-all

S-57 ENC 3.1 feature catalogue will be used to add the features to the output file.

--feature-catalogue "S-57 ENC 3.1"

Input file is named Surface10.hob and located at D:\BatchSample.

D:\BatchSample\Surface10.hob

Output file is named AddFeatures.hob and located at D:\BatchSample.

D:\BatchSample\AddFeatures.hob

Command Line

carisbatch --run AddFeatures --keep-foid --require-all --feature-catalogue "S-57 ENC 3.1" D:\BatchSample\Surface10.hob D:\BatchSample\AddFeatures.hob

Outcome

The features in the source file are added to the existing content of the output file.

Extra Notes

N/A