CARIS HIPS and SIPS : Support Files Guide : Mapping : Mapping CARIS Objects : Attribute Mapping Scripts
 

Attribute Mapping Scripts

A major difference between the CARIS mapping file and other mapping files is the use of pre-defined attribute scripts to assign values to attributes. These scripts are accessed using the <ExecuteAttributeScript> tag.

The following table lists scripts used by the CARIS mapping file. A table that describes the attributes for the script tags is described in the table below this one.

Script

Description

assign_depthdepare

Map CARIS polygons to DEPARE features using the polygon label to get the depth values.

Assign values to DRVAL1 and DRVAL2 attributes.

This script requires the "From" attribute. If From=CARIS_FCODE it may be required to specify Formatted=True in the <Object> section.

assign_depthdrgare

Map CARIS polygons to DRGARE features, using the polygon label to get depth values.

Assign values to DRVAL1 attribute.

This script requires the "From" attribute.

assign_depthvalsou

Assign values to VALSOU attribute.

This script requires the "From" attribute.

assign_depthverccl

Assign values to VERCCL attribute.

This script requires the "From" attribute.

assign_depthverclr

Assign values to VERCLR attribute.

This script requires the "From" attribute.

assign_depthverclrc

Assign values to VERCCL attribute.

This script requires the "From" attribute.

assign_label

Assign values to attribute given by the "Acronym" tag. For CARIS polygons, this takes the value of the polygon label.

This script requires the "From" attribute.

assign_metaacc

Assign values to HORACC and VERACC attributes.

This script requires the "From" attribute.

assign_metascale

Assign values to CSCALE attribute.

This script requires the "From" attribute.

assign_metaverdat

Assign values to VERDAT attribute.

This script requires the "From" attribute.

assign_name

Assign values to attribute given by the "Acronym" tag. For CARIS names, this takes the value of the text string.

This script requires the "From" attribute.

assign_scamin

Assign values to SCAMIN attribute.

This script requires the "From" and "Scamin" attributes

Properties are assigned to the scripts. The following properties can be used with scripts.

Script Tag Attributes

Description

Acronym

Specify the attribute acronym to be assigned a value.

From

Specify where the new attribute value will come from. This is normally set to a CARIS keyword (that is, From="CARIS_FCODE").

LowDepthAcronym

Specify the low-depth acronym to be assigned a value.

HighDepthAcronym

Specify the high-depth acronym to be assigned a value

Negate

Multiply the floating point or integer number by -1 to negate. This property is set to True or False. If it is not specified then Negate=False.

PositiveValuesOnly

Convert only positive floating point or integer attributes. This is set to True or False. If it is not specified then PositiveValuesOnly=False.

ScaminFactor

Specify the factor to apply in calculating the SCAMIN value.