Procedures Added to the TCL Translator

The special procedures that have been added by NX to the TCL interpreter for you to use in Event Handler procedures are:

Abort

Procedure Name

MOM_abort <message>

Description

This function causes MOM to write message to the syslog and then terminate by ERROR_raising().

Input

message

Example

MOM_abort "Error occurred. Postprocessing has been aborted."

Add To Address Buffer

Procedure Name

MOM_add_to_address_buffer <address name> <start|end> <value>+

Description

Depending on the start/end attribute specified, this extension will add "value(s)" to either the address start buffer or the address end buffer. Each time that this extension is called, it adds to the specified buffer.

When the contents of the address is sent to the output buffer, the contents of the address start buffer will preceed it and the contents of the end buffer will go after it.

The address start buffer and the address end buffer are cleared once the they have been sent to the output buffer.

Input

address name, start/end attribute, value(s)

Example

MOM_add_to_address_buffer X end [append end $list2 $list1]

MOM_add_to_address_buffer X start $prefix

MOM_add_to_address_buffer X start [MOM_do_template Seq_no CREATE]

MOM_add_to_address_buffer X start "X"

Add To Block Buffer

Procedure Name

MOM_add_to_block_buffer <block name> <start|end> <value>+

Description

Depending on the start/end attribute specified, this extension will add "value(s)" to either the block start buffer or the block end buffer. Each time that this extension is called, it adds to the specified buffer.

When the block is sent to the output buffer, the contents of the block start buffer will preceed it on the line and the contents of the block end buffer will go after it.

The block start buffer and the block end buffer are cleared once the they have been written to the output buffer.

Input

block name, start/end attribute, value(s)

Example

MOM_add_to_block_buffer From end [append end $list2 $list1]

MOM_add_to_block_buffer From start $prefix

MOM_add_to_block_buffer Linear start [MOM_do_template Seq_no CREATE]

MOM_add_to_block _buffer From start "Remark"

Add To Line Buffer

Procedure Name

MOM_add_to_line_buffer <start|end> <value>+

Description

Depending on the start/end attribute specified, this extension will add "value(s)" to either the line's start buffer or the line's end buffer. Each time that this extension is called, it adds to the specified buffer.

When the contents of the output buffer is sent to the output file, the contents of the line's start buffer will preceed it on the line and the contents of the end buffer will go on the same line after it.

The line start buffer, line end buffer, and output buffer are all cleared once the they have been written to the output file.

Input

start/end attribute, value(s)

Example

MOM_add_to_line_buffer start [MOM_do_template Linear CREATE]

MOM_add_to_line_buffer start [append start $list1 $list2]

MOM_add_to_line_buffer start $prefix

MOM_add_to_line_buffer start "****"

Ask Address

Procedure Name

MOM_ask_address_value <address name>

Description

Always returns the absolute address value NOT the incremental value.

Input

address name

Example

MOM_ask_address_value X

Ask Environment Variable

Procedure Name

MOM_ask_env_var <variable name>

Description

This extension allows you to determine how environment variable "variable name" is set.

Input

variable name

Example

set path [MOM_ask_env_var UGII_CAM_POST_CONFIG_FILE]

Ask Event Type

Procedure Name

MOM_ask_event_type

Description

Returns the name of the current event. This is the last event that the event generator executed.

Input

None

Example

set event[MOM_ask_event_time]