add more items
This commit is contained in:
Christoph Brandau
@@ -784,7 +784,7 @@
|
||||
"parameters": [
|
||||
{
|
||||
"name": "ON|OFF",
|
||||
"desc": "urns rotary axis output limit ON or OFF."
|
||||
"desc": "Turns rotary axis output limit ON or OFF."
|
||||
},
|
||||
{
|
||||
"name": "4|5",
|
||||
@@ -804,6 +804,340 @@
|
||||
"MOM_limit_output_angle ON 5 360.0 0.0"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_list_user_defined_events",
|
||||
"kind": "function",
|
||||
"description": "This procedure allows you to output or list User Defined Events (UDE) defined in the operation.",
|
||||
"format": "MOM_list_user_defined_events <Start|End> <operation_name> <definition> <event_handler> [<output>]",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "Start|End",
|
||||
"desc": "Indicates the UDE list at the start or end of the operation."
|
||||
},
|
||||
{
|
||||
"name": "operation_name",
|
||||
"desc": "Operation name to output list of UDEs."
|
||||
},
|
||||
{
|
||||
"name": "definition",
|
||||
"desc": "Name of the definition file (.def)."
|
||||
},
|
||||
{
|
||||
"name": "event_handler",
|
||||
"desc": "Name of event handler file (.tcl). This file should contain a procedure to output the UDE list, such as MOM_info_user_defined_event."
|
||||
},
|
||||
{
|
||||
"name": "output",
|
||||
"desc": "Optional. The file where the UDE lists are output. If NOT specified, the UDE lists are output in mom_output_file (as defined in the Manufacturing part report dialog)."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_list_user_defined_events \"Start\" `$mom_operation_name` \"$mom_source_directory\\test_info.def\" \"$mom_source_directory\\\\test_info.tcl\" \"c:\\\\Temp\\\\XYZ.txt\" "
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_load_definition_file",
|
||||
"kind": "function",
|
||||
"description": "This procedure loads the definition file given by filename. If the data in filename (or any of its included files) matches data already loaded by previous definition files, the duplicate data is overridden by the new version. Like any TCL extension, this command may be called from any place in the TCL script.",
|
||||
"format": "MOM_load_definition_file <filename>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "filename",
|
||||
"desc": "Name of definition file."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_load_definition_file lathe"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_load_lathe_thread_cycle_params",
|
||||
"kind": "function",
|
||||
"description": "This command loads the parameters of a lathe threading cycle of the current operation. Note: This command should be called after the desired CSYS is set.",
|
||||
"format": "MOM_load_lathe_thread_cycle_params",
|
||||
"parameters": [],
|
||||
"returns": [
|
||||
"1 - Successfully loaded parameters.",
|
||||
"0 - Failed to load."
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"if {[MOM_load_lathe_thread_cycle_params]} {# Do your thing...}"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_log_message",
|
||||
"kind": "function",
|
||||
"description": "This function causes MOM to write a message to the syslog.",
|
||||
"format": "MOM_log_message <message>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "message",
|
||||
"desc": "Text string defining the message."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_log_message \"Postprocessing Terminated\""
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_on_event_error",
|
||||
"kind": "function",
|
||||
"description": "If the TCL interpreter reports an error, this procedure is invoked by NX prior to raising a system error.",
|
||||
"format": "MOM_on_event_error [_debug]",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "_debug",
|
||||
"desc": "Optional. Name of procedure that is invoked only if DEBUG mode is true."
|
||||
}
|
||||
],
|
||||
"returns": [
|
||||
"1 - True (error).",
|
||||
"0 - False"
|
||||
],
|
||||
"example": []
|
||||
},
|
||||
{
|
||||
"label": "MOM_on_parse_error",
|
||||
"kind": "function",
|
||||
"description": "If a syntax error is found in the Definition File, this procedure is invoked by NX prior to raising a system error.",
|
||||
"format": "MOM_on_parse_error [_debug]",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "_debug",
|
||||
"desc": "Optional. Name of procedure that is invoked only if DEBUG mode is true."
|
||||
}
|
||||
],
|
||||
"returns": [
|
||||
"1 - True (error).",
|
||||
"0 - False"
|
||||
],
|
||||
"example": []
|
||||
},
|
||||
{
|
||||
"label": "MOM_open_output_file",
|
||||
"kind": "function",
|
||||
"description": "This procedure allows you to redirect output to other output files. If the specified file does not exist, a new one is created with that file name.",
|
||||
"format": "MOM_open_output_file <filename>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "filename",
|
||||
"desc": "Name of output file."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_open_output_file $mom_output_doc_file2"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_output_literal",
|
||||
"kind": "function",
|
||||
"description": "This procedure outputs a list of literals and variables as a single line.",
|
||||
"format": "MOM_output_literal <string> [BUFFER]",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"desc": "Text string and variables to be output."
|
||||
},
|
||||
{
|
||||
"name": "BUFFER",
|
||||
"desc": "Optional. Places the string only in the output buffer. Does not send it to the output file yet."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_output_literal \"Start of path $mom_path_name\""
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_output_text",
|
||||
"kind": "function",
|
||||
"description": "This procedure outputs a list of literals and variables as a single line. The resulting output is just like MOM_output_literal except that no sequence number is output.",
|
||||
"format": "MOM_output_text <string> [BUFFER]",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"desc": "Text string and variables to be output."
|
||||
},
|
||||
{
|
||||
"name": "BUFFER",
|
||||
"desc": "Optional. Places the string only in the output buffer. Does not send it to the output file yet."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_output_text \"Start of path $mom_path_name\""
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_output_to_listing_device",
|
||||
"kind": "function",
|
||||
"description": "If running in an interactive NX session, this extension outputs string to the NX listing window, otherwise do nothing.",
|
||||
"format": "MOM_output_to_listing_device <string>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "string",
|
||||
"desc": "Text string to be output."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_output_to_listing_device \"Error occurred while postprocessing.\""
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_polar_convert_point",
|
||||
"kind": "function",
|
||||
"description": "Converts a point from a Cartesian coordinate system to a polar coordinate system.",
|
||||
"format": "MOM_polar_convert_point <init_vector> <point>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "init_vector",
|
||||
"desc": "Initial vector of the rotary axis at the zero position (i, j, k)."
|
||||
},
|
||||
{
|
||||
"name": "point",
|
||||
"desc": "Point to be converted (X, Y, Z, 4th_angle, 5th_angle)."
|
||||
}
|
||||
],
|
||||
"returns": [
|
||||
"The result is saved in the array variable mom_polar_pos."
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_polar_convert_point polar_vector_ref mom_pos"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_polar_motion",
|
||||
"kind": "function",
|
||||
"description": "Outputs polar motion directly to the NC code output file. If the move is linearized, all of linearized data is output as polar motion.",
|
||||
"format": "MOM_polar_motion <polar_block_template> <init_vector> <target_pos>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "polar_block_template",
|
||||
"desc": "Block template name used to output polar coordinates."
|
||||
},
|
||||
{
|
||||
"name": "init_vector",
|
||||
"desc": "Initial vector of the rotary axis at the zero position (i, j, k)."
|
||||
},
|
||||
{
|
||||
"name": "target_pos",
|
||||
"desc": "Target position of the polar motion (X, Y, Z, 4th_angle, 5th_angle)."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_polar_motion linear_move polar_vector_ref mom_pos"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_post_oper_path",
|
||||
"kind": "function",
|
||||
"description": "Postprocesses the named operation. During execution, the variable mom_post_oper_path exists and has a value of 1. The called process uses the same units specifed in the Postprocess dialog box.",
|
||||
"format": "MOM_post_oper_path <operation_name> [<output_file>] [<postprocessor>] [ <event_handler_file> <definition_file>]",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "operation_name",
|
||||
"desc": "Description."
|
||||
},
|
||||
{
|
||||
"name": "output_file",
|
||||
"desc": "Optional. Name of the output file. If the output_file argument is specified without a post, the default post is used. When the file name is given without a preceding path, the primary output directory is used. When a post is specified, the output_file argument SAME outputs to the active output file."
|
||||
},
|
||||
{
|
||||
"name": "postprocessor",
|
||||
"desc": "Optional. Name of the postprocessor. If a post is named, the review file option and warning output setting are governed by the named post."
|
||||
},
|
||||
{
|
||||
"name": "event_handler_file, definition_file",
|
||||
"desc": "Optional. The postprocessor TCL and DEF files."
|
||||
}
|
||||
],
|
||||
"returns": [
|
||||
"Returns 1 (True) when the execution is successful, 0 (False) if it is not successful, and -1 if the post is calling itself."
|
||||
],
|
||||
"example": []
|
||||
},
|
||||
{
|
||||
"label": "MOM_reload_iks_parameters",
|
||||
"kind": "function",
|
||||
"description": "Retrieves kinematic parameters during postprocessing for the current axis chain that is defined in the machine tool loaded in the current CAM setup.",
|
||||
"format": "MOM_reload_iks_parameters <axis_chain>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "axis_chain",
|
||||
"desc": "Name of the axis chain.."
|
||||
}
|
||||
],
|
||||
"example": []
|
||||
},
|
||||
{
|
||||
"label": "MOM_reload_kinematics",
|
||||
"kind": "function",
|
||||
"description": "Refresh the event generator with the current values of all the kinematics variables.",
|
||||
"format": "MOM_reload_kinematics",
|
||||
"parameters": [],
|
||||
"example": []
|
||||
},
|
||||
{
|
||||
"label": "MOM_reload_kinematics_variable",
|
||||
"kind": "function",
|
||||
"description": "Refresh the event generator with the current values of only the specified kinematics variables. Both scalar and array variables can be reloaded in one call of the command.",
|
||||
"format": "MOM_reload_kinematics_variable var1 var2 … varN",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "var1 var2 … varN",
|
||||
"desc": "Name of kinematic variable(s)."
|
||||
}
|
||||
],
|
||||
"returns": [
|
||||
"The total number of scalar variables and array elements are output to the variable mom_result. If a specified variable does not exist, a warning is written to the syslog."
|
||||
],
|
||||
"example": []
|
||||
},
|
||||
{
|
||||
"label": "MOM_reload_variable",
|
||||
"kind": "function",
|
||||
"description": "This procedure updates the event generator with the current value of variable_name in the event handler.",
|
||||
"format": "MOM_reload_variable [-a] <variable_name>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "-a",
|
||||
"desc": "Optional. Specifies that variable is an array."
|
||||
},
|
||||
{
|
||||
"name": "variable_name",
|
||||
"desc": "Name of variable"
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"# The following command will load the current five values of the mom_pos array variable into the event generator.",
|
||||
"MOM_reload_variable -a mom_pos"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_remove_file",
|
||||
"kind": "function",
|
||||
"description": "This command deletes a file with the given name. The permissions on the file that is being asked to be removed should be compatible for removal.",
|
||||
"format": "MOM_remove_file <filename>",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "filename",
|
||||
"desc": "Name of file to be deleted."
|
||||
}
|
||||
],
|
||||
"example": [
|
||||
"# Example 1",
|
||||
"MOM_remove_file temp_file"
|
||||
]
|
||||
},
|
||||
{
|
||||
"label": "MOM_source",
|
||||
"kind": "function",
|
||||
|
||||
Reference in New Issue
Block a user