Description
The ChangeFeatureAttributes process modifies all features with the specified attribute(s) in the input.
Inputs
Features in a supported format. HOB and 000 (S-57 specification) are supported.
Outputs
Features in HOB format.
Command Line Syntax
carisbatch --run ChangeFeatureAttributes --attribute <acronym> <value> --feature-catalogue <value> [options] <input> <output>
Options
The following table describes the parameters available for this process.
Parameter |
| |||
Long | Short | Description | Can Repeat | Notes
|
--feature-catalogue | F | A 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". | FALSE | This must be specified for HOB input. |
--attribute | a | The acronym and new value for a feature attribute. <Acronym> - A string specifying the acronym of the attribute. <Value> - A string specifying the attribute value. One of {CARIS:UNKNOWN, CARIS:NONE or an actual value}. • CARIS:UNKNOWN: Unknown - The attribute requires a value but the value is unknown. • CARIS:NONE: None - The attribute does not have a value. The specified acronym must be present in the specified FeatureCatalogue. The Acronym must exist as a feature attribute in the input. The value must be valid for the specified FeatureCatalogue. Enumerated and list type attributes will be given by numerical code. For example, with the default S-57 ENC 3.1 catalogue, enter COLOUR 7 to set grey as the colour of all features with the COLOUR attribute. To set multiple attributes, use commas as separators, e.g. CATFOG 3,6,10. Dates and times are specified in the standard ISO 8601:1988 format. Depending on the specific attribute, the following formats for dates may be supported: YYYY‑MM‑DD, YYYY‑MM, YYYY, --MM‑DD, --MM. Times are always reported in UTC in the format YYYY‑MM‑DDTHH:MM:SS. See ISO 8601:1988 documentation for more information. | TRUE | |
Example
To use this command refer to the following example.
Example | ||
Objective | You want to change all coverage features in a given source to be hole type; any coverage features that should not be updated have been filtered out of the input as a precursor step. | |
Description | Command Line Syntax | |
The input has features and attributes defined in the S-57 ENC 3.1 feature catalogue. | --feature-catalogue "S-57 ENC 3.1" | |
The cvgtyp attribute will be changed from boundary type (0) to hole type (1). | --attribute cvgtyp 1 | |
The input file is named CVRAGE_Type_Boundary.hob and located at D:\BatchSample. | D:\BatchSample\CVRAGE_Type_Boundary.hob | |
The output file will be named CVRAGE_Type_Hole.hob and located at D:\BatchSample. | D:\BatchSample\CVRAGE_Type_Hole.hob | |
Command Line |
| |
Outcome | A new HOB map is created containing hole-type coverage features; any other features with a cvgtyp attribute would also be affected. All other features are copied over unchanged. | |
Extra Notes | N/A | |