Reader Directives

The directives that are processed by the NTX reader are listed below. The suffixes shown are prefixed by the current <ReaderKeyword> in a mapping file. By default, the <ReaderKeyword> for the NTX reader is NTX.

DATASET

Required/Optional: Required

The value for this keyword is the file containing the NTX dataset to be read. A typical mapping file fragment specifying an input NTX dataset looks like:

NTX_DATASET /usr/data/caris/test.ntx

Workbench Parameter: Source NTX File(s)

BREAK_ON_MASK_CHANGE

Required/Optional: Optional

This setting determines whether linked features are merged together even though their masked flags are different. If this setting is YES, it will break linked features at the point where their masked flags change. If this setting is NO, it will merge features regardless of the mask flag settings. A typical mapping file fragment specifying that linked features should not be broken looks like:

NTX_BREAK_ON_MASK_CHANGE NO

Workbench Parameter: Break features at mask changes

AGGREGATE_DASHED_LINES

Required/Optional: Optional

This setting determines whether dashed lines (code 4) will have their geometry represented as a single linestring or as an aggregate of 2 point lines – each line being one of the dashes. If this setting is YES, it will form aggregate geometries on dashed line features. If this setting is NO, it will set the geometry to be a single line for dashed line features. Those wishing to read NTX files for cartographic reasons may prefer to read dashed lines as aggregates. Those wishing to read the lines most efficiently may prefer to read dashed lines as a single linestring. A typical mapping file fragment specifying that dashed line features should not be read as aggregates looks like:

NTX_AGGREGATE_DASHED_LINES NO

Workbench Parameter: Aggregate NTX Dashed Lines

AGGREGATE_SOUNDINGS

Required/Optional: Optional

This setting determines whether consecutive sounding features are merged together into an aggregate feature. If this setting is YES, it will merge consecutive sounding features into aggregate features. If this setting is NO, it will treat each sounding feature as an individual feature. A typical mapping file fragment specifying that sounding features should not be aggregated looks like:

NTX_AGGREGATE_SOUNDINGS NO

Workbench Parameter: Aggregate NTX Soundings

SEARCH_ENVELOPE

Using the minimum and maximum x and y parameters, define a bounding box that will be used to filter the input features. Only features that interact with the bounding box are returned.

If all four coordinates of the search envelope are specified as 0, the search envelope will be disabled.

Mapping File Syntax

<ReaderKeyword>_SEARCH_ENVELOPE <minX> <minY> <maxX> <maxY>

Note: If all four coordinates of the search envelope are specified as zero, the search envelope will be disabled.

Required/Optional

Optional

Workbench Parameter

Minimum X, Minimum Y, Maximum X, Maximum Y

SEARCH_ENVELOPE_COORDINATE_SYSTEM

This directive specifies the coordinate system of the search envelope if it is different than the coordinate system of the data.

The COORDINATE_SYSTEM directive, which specifies the coordinate system associated with the data to be read, must always be set if the SEARCH_ENVELOPE_COORDINATE_SYSTEM directive is set.

If this directive is set, the minimum and maximum points of the search envelope are reprojected from the SEARCH_ENVELOPE_COORDINATE_SYSTEM to the reader COORDINATE_SYSTEM prior to applying the envelope.

Required/Optional

Optional

Mapping File Syntax

<ReaderKeyword>_SEARCH_ENVELOPE_COORDINATE_SYSTEM <coordinate system>

Workbench Parameter

Search Envelope Coordinate System

CLIP_TO_ENVELOPE

This directive specifies whether or not FME should clip features to the envelope specified in the SEARCH_ENVELOPE directive.

Values

YES | NO (default)

Mapping File Syntax

<ReaderKeyword>_CLIP_TO_ENVELOPE [yes | no]

Workbench Parameter

Clip To Envelope