Writer Directives

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

DATASET

Required/Optional: Required

The value for this directive is the file containing the NTX dataset to write out. A typical mapping file fragment specifying an input NTX dataset looks like:

NTX_DATASET /usr/data/caris/output.ntx

Workbench Parameter: Destination Caris NTX File

YRES

Required/Optional: Optional

This setting determines the file’s X and Y disk unit resolution based on ground units. For example, if the ground units are METERS and the value of XYRES is 0.001, then the disk unit resolution is millimeters. This setting overrides any resolution settings if the input file is also NTX. The default resolution value used is 1.0 if XYRES is not set unless the input file type is NTX; the resolution from the input file is used. A typical mapping file fragment specifying the X and Y resolutions in this example looks like:

NTX_XYRES 0.001

Workbench Parameter: X/Y Resolution (GroundUnits)

ZRES

Required/Optional: Optional

This setting determines the file’s Z disk unit resolution based on ground units, similar to the XYRES keyword. This setting overrides any resolution settings if the input file is also NTX. Here, too, the default resolution value used is 1.0 if ZRES is not set unless the input file type is NTX; the resolution from the input file is used. A typical mapping file fragment specifying the Z resolution looks like:

NTX_ZRES 0.001

Workbench Parameter: Z Resolution (Ground Units)

TITLE_STRING

Required/Optional: Optional

This setting determines the Title String stored in the header of the NTX file. This Title String can be any character string with a maximum length of 80. This keyword overrides any Title String settings if the input file is also NTX. The default Title String value used is "This file was created by FME(c) program by Safe Software Inc. (www.safe.com)" if TITLE_STRING is not set unless the input file type is NTX; the Title String from the input file is used. A typical mapping file fragment specifying the Title String in the example above looks like:

NTX_TITLE_STRING "This file was created by FME(c) program by Safe Software Inc. (www.safe.com)"

FILE_ID_STRING

Required/Optional: Optional

This setting determines the File ID String stored in the header of the NTX file. This File ID String can be any character string with a maximum length of 12. This keyword overrides any File ID String settings if the input file is also NTX. The default File ID String value used is "SAFESOFTWARE" if FILE_ID_STRING is not set unless the input file type is NTX; the File ID String from the input file is used. A typical mapping file fragment specifying the File ID String in the example above looks like:

NTX_FILE_ID_STRING "SAFESOFTWARE"

SCALE

Required/Optional: Optional

This setting determines the file’s scale. For example, if the scale is 1:50000, then this keyword should have the value 50000.0. This keyword overrides any scale settings if the input file is also NTX. The default scale value used is 1.0 if SCALE is not set unless the input file type is NTX; the scale from the input file is used. A typical mapping file fragment specifying the scale in the example above looks like:

NTX_SCALE 50000.0

Workbench Parameter: Scale

WRITE_UNIX_FORMAT

Required/Optional: Optional

This keyword should be set to either YES or NO. It indicates whether the output NTX file should be in the UNIX (Big Endian) format or in the PC (Little Endian) format.

If this keyword is not present, the default value will be NO and the FME will produce an NTX file in the PC format.

NTX_WRITE_UNIX_FORMAT YES

Workbench Parameter: Binary Format

CALCULATE_BOUNDING_BOX

Required/Optional: Optional

This keyword should be set to either YES or NO. It indicates whether the bounding box values are calculated or passed in through the header feature.

If this keyword is not present, the default value will be YES and the FME will calculate the bounding box values. In a mapping file, the line should look like this:

NTX_CALCULATE_BOUNDING_BOX YES

Workbench Parameter: Calculate Bounding Box