MOM Commands

This function causes MOM to terminate with an error message. Example: MOM_abort ''Error occurred. Postprocessing has been aborted.''

MOM_abort <message>

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.  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''

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

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.  Examples:  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''

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

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.  Examples: 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 ''****''

MOM_add_to_line_buffer <start|end> <value>+

Always returns the absolute address value NOT the incremental value.  Examples: MOM_ask_address_value X

MOM_ask_address_value <address name>

This extension allows you to determine how environment variable ''variable name'' is set.  Example: set path [MOM_ask_env_var UGII_CAM_POST_CONFIG_FILE]

MOM_ask_env_var <variable name>

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

NX has as an Expression module. This allows users to define variables and expressions and then use those variables as parameters for entities such as Modeling features.  This MOM function provides access to the variables of the Expression module, i.e., it returns the value of the Expression variable.  Example:  MOM_ask_ess_exp_value diameter

MOM_ask_ess_exp_value <variable_name>

This extension allows you to suspend writing output to a particular file until it is opened again.  Example: MOM_close_output_file $mom_output_doc_file2

MOM_close_output_file <filename>

This will activate, deactivate, and resume the debugger. Like any TCL extension, this command may be called from any place in the TCL script.  If ON, the debugger will activate by initializing with data entered in the debugger dialog or stdout.  If OFF, the debugger will be deactivated.  Examples: MOM_set_debug_mode ON  MOM_set_debug_mode OFF

MOM_set_debug_mode <ON | OFF>

Generate output based upon the Block Template template_name.  BUFFER has the same meaning as before. BUFFER will generate the output value for Block Template template_name but does not add it to the output buffer, and hence, does not output it to the output file.  CREATE will generate the value for Block Template template_name but does not output to the output buffer.  This function returns the string created as the result of the template name.  Example: MOM_do _template Linear

MOM_do_template <template_name> {BUFFER | CREATE}

Reads and evaluates a template file.  If you use HDRF='filename', BDYF='filename', or FTRF='filename', MOM_do_template_file is invoked automatically with filename as its argument.

MOM_do_template_file <template_file>

The next time that a block template that contains a reference to any of the input address names is evaluated, the word that contains that address will be output regardless of its modality attribute.  Example: MOM_force_address Once X Y Z, If both MOM_force ONCE and MOM_suppress once are programmed, the last one will take effect.  If MOM_suppress ALWAYS is programmed, the address will never be output. All MOM_force ONCE and MOM_suppress ONCE commands are ignored. In the definition file, Force OFF or Force ALWAYS should define the modality of the address. Using MOM_force OFF or MOM_force ALWAYS to redefine the modality in the tcl is not recommended.

MOM_force <Always | Once | Off > <Address_1 ... Address_n>

Example: MOM_force_block Once linear

MOM_force_block <Always | Once | Off > <Block_1 ... Block_n>

The next time that a block template contains a reference to any of the input address names is evaluated, the deference (increment) from the previous value is output.  If ON, then for each Address_i, always output increment.  If OFF, then for each Address_i, always output absolute.  Example: MOM_incremental ON X Y Z

MOM_incremental <ON | OFF> <Address_1 ... Address_n>

This will load the definition file given by filename. If data in filename (or any of its included files) matches data already loaded by previous definition files, that duplicate data will be overridden by the new version. Like any TCL extension, this command may be called from any place in the TCL script.  Example: MOM_load_definition_file lathe

MOM_load_definition_file <filename>

This function causes MOM to write message to the syslog.  Example: MOM_log_message ''Postprocessing Terminated''

MOM_log_message <message>

If the TCL interpreter reports an error this procedure is invoked prior to raising a system error. The {_debug} procedure is invoked only if DEBUG mode is true. 

MOM_on_event_error {_debug}

If a syntax error is found in the Definition File these procedures are invoked prior to raising a system error. The {_debug} procedure is invoked only if DEBUG mode is true.

MOM_on_parse_error {_debug}

This extension allows you to redirect output to other output files.  If a file ''filename'' does not exist, a new one will be created with that file name.  Example: MOM_open_output_file $mom_output_doc_file2

MOM_open_output_file <filename>

Output a list of literals and variable as a single line. If BUFFER is present then only place string in the output buffer. Do not send it to the output yet.  Example: MOM_output_literal ''Start of path $mom_path_name''

MOM_output_literal ''string'' {BUFFER}

This extension will output a list of literals and variable as a single line, just like MOM_output_literal except that no sequence number will be output.  If BUFFER is present then only place string in the output buffer. Do not send it to the output yet.  Example: MOM_output_text ''Start of path $mom_path_name''

MOM_output_text <literal> {BUFFER}

If running in an interactive session then output string to the listing window, otherwise do nothing.  Example: MOM_output to listing_device ''Error occurred while postprocessing.''

MOM_output_to_listing_device <''string''>

Refresh the event generator with the current values of all the kinematics variables.

Update the event generator with the current value of variable_name in the event handler.  Example: The following command will load the current values of mom_pos [0] to [4] into the event generator. MOM_reload_variable -a mom_pos

MOM_reload_variable [-a] variable_name

A sequence is a block template that is output at the beginning of each line. It will typically be used to output sequence numbers but it may also be used to output any block template.  Example: MOM_reset_sequence 10 10 1

MOM_reset_sequence <start> <increment> {frequency}

This function causes MOM to call the function named entry_point_name in the shared library named shared_library_name. That function can then extend the translator from which MOM_run_user_function was called. It will do this by calling a User Function function named UF_MOM_extend_translator( param, ''extension_name'', extension_entry_point ). The param will be passed into entry_point_name as the first argument. The signature of entry_point_name is the same as ufusr. The extension_name is the name of the function as it will appear in a TCL script. The extension_entry_point is the actual address of the function to be called by the interpreter when interpreting the extension_name call. (See Tcl_CmdProc.)  Example: MOM_run_user_function /usr/local/shlib/lib.sl extendInterp

For a more thorough example click here.

MOM_run_user_function <shared_library_name> <entry_point_name>

This function redefines the format to be used for the <Address Name> as <Format Name> for outputting in a block. The <Format Name> must be defined in the Definition File.  Example: MOM_set_address_format F F_ipm

MOM_set_address_format <Address Name> <Format Name>

This function causes MOM to set the line leader to string with the indicated status. If a line leader is to be output is output as the first characters of the output line (i.e., before the SEQUENCE).  Example:  MOM_set_line_leader Always ''/''

MOM_set_line_leader <Always | Once | Off > <''string''>

Allows output of the sequence number if a SEQUENCE specifier was given in the definition file.  Return the sequence setting at the time the command is exectued.  Example: set current_status [MOM_set_seq_on]  ... if ($current_status = = ''off'') { MOM_set_seq_off }

Does not output a sequence number. Returns the sequence setting at the time the command is exectued. Example: set current_status [MOM_set_seq_off] ... if ($current_status = = ''on'') { MOM_set_seq_on }

The Tcl function "toupper" on the Windows platform has been found to cause a crash when there are some special characters present in a string. To correct this problem this MOM command has been provided to perform the same action.

MOM_string_toupper <string>