From 16608cb9940ef3d87822a815adfce14617e0898f Mon Sep 17 00:00:00 2001 From: Christoph Brandau Date: Tue, 22 Jul 2025 07:21:47 +0200 Subject: [PATCH] add more items --- server/src/common/completion_list.json | 276 ++++++++++++++++++++++++- 1 file changed, 266 insertions(+), 10 deletions(-) diff --git a/server/src/common/completion_list.json b/server/src/common/completion_list.json index 2a9390c..159a3d3 100644 --- a/server/src/common/completion_list.json +++ b/server/src/common/completion_list.json @@ -409,25 +409,207 @@ "desc": "List of operations." } ], - "returns": [], "example": [ "set opr_list \"PLANER_MILL FACE_MILLING1 GENERIC_MOTION1\"", "MOM_ask_oper_info opr_list" ] }, { - "label": "MOM_ask_ude_info", + "label": "MOM_ask_oper_nc_axes_info", "kind": "function", - "description": "This command is used to retrieve the information about a user-defined event (UDE) of a specified object.", - "format": "MOM_ask_ude_info object_name object_type ", + "description": "This command is used to get all the nc axis names in a kinematic chain from the workpiece to the device. A workpiece and tool (device) are attached to each operation. The results for linear axis names are saved in the array variable `mom_result`, and the rotary axis names are stored in the array variable `mom_result1`.", + "format": "MOM_ask_oper_nc_axes_info ", "parameters": [ { - "name": "Object_name", - "desc": "The name of the object to which the UDE is attached. It can be a group, an operation, a tool, a geometry, or a method." + "name": "operation_name", + "desc": "Name of the operation." + } + ], + "example": [ + "set opr_name FACE_MILL_FLOOR", + "MOM_ask_oper_nc_axes_info $opr_name" + ] + }, + { + "label": "MOM_ask_oper_tool_path_type", + "kind": "function", + "description": "This command is used to retrieve the tool path type for a specific operation or optimized group.", + "format": "MOM_ask_oper_tool_path_type ", + "parameters": [ + { + "name": "opr_name", + "desc": "Name of the operation or optimized group from which the tool path type is to be retrieved." + } + ], + "returns": [ + "`mom_sys_tool_path_type(oper_name)` The parameter contains the tool path type for the specified operation or optimized group. The possible values are:", + " NO_MOVE—Indicates no movement in the tool path.", + " NO_CUT—Indicates no cutting motion in the tool path.", + " FIXED_AXIS—Indicates tool axis is fixed throughout the cutting motions.", + " POSITIONING—Indicates tool axis changes in the non-cutting motion. However, the tool axis is fixed in all cutting motions.", + " MULTI_PLANES—Indicates tool axis does not have continuous changes in the cutting motions.", + " SIMULTANEOUS—Indicates simultaneous tool motions in the tool path.", + "`mom_init_tool_axis` - The parameter contains tool axis vector of the first motion in the specified operation.", + "0 - The command execution failed.", + "1 - The command executed successfully." + ], + "example": [ + "set opr_name FACE_MILL_FLOOR", + "MOM_ask_oper_nc_axes_info $opr_name" + ] + }, + { + "label": "MOM_ask_part_units", + "kind": "function", + "description": "This command sets the units of the current work part in a variable `mom_part_units`.", + "format": "MOM_ask_part_units", + "parameters": [], + "returns": [ + "The possible values for mom_part_units are \"metric\" or \"english\"." + ], + "example": [ + "global mom_part_units", + "MOM_ask_part_units", + "set part_units $mom_part_units" + ] + }, + { + "label": "MOM_ask_syslog_name", + "kind": "function", + "description": "This command returns the name of syslog file of current session.", + "format": "MOM_ask_syslog_name", + "parameters": [], + "returns": [ + "String." + ], + "example": [ + "set syslog [MOM_ask_syslog_name]" + ] + }, + { + "label": "MOM_cancel_suppress_force_once_per_event", + "kind": "function", + "description": "Resets the state of the `MOM_force` and `MOM_suppress` commands that use the Once option at the end of each event.", + "format": "MOM_cancel_suppress_force_once_per_event ", + "parameters": [ + { + "name": "On|Off", + "desc": "Turn the Once option for `MOM_force` and `MOM_suppress` commands on or off." + } + ], + "returns": [ + "1 - On", + "0 - Off" + ], + "example": [] + }, + { + "label": "MOM_check_out_license", + "kind": "function", + "description": "Obtains Flexlm license until the end of the posting job. Returns 1 (true) for success or 0 (false) for failure.", + "format": "MOM_check_out_license ", + "parameters": [ + { + "name": "license", + "desc": "String name of a valid license." + } + ], + "returns": [ + "1 - True", + "0 - False" + ], + "example": [] + }, + { + "label": "MOM_close_output_file", + "kind": "function", + "description": "This procedure allows you to suspend writing output to a particular file until it is opened again.", + "format": "MOM_close_output_file ", + "parameters": [ + { + "name": "filename", + "desc": "Name of output file." + } + ], + "example": [ + "# Example 1", + "MOM_close_output_file $mom_output_doc_file2" + ] + }, + { + "label": "MOM_convert_point", + "kind": "function", + "description": "Converts a point from a tool path position to an MCS position in machine tool coordinates.", + "format": "MOM_convert_point ", + "parameters": [ + { + "name": "point", + "desc": "Array variable of three values defining tool path position." }, { - "name": "object_type", - "desc": "The type of the object to which the UDE is attached. The following types are available.(group || operation/oper || tool || geometry/geom || method/meth)" + "name": "vector", + "desc": "Array variable of three values defining vector of tool axis." + } + ], + "returns": [ + "Returns pimary and alternate solutions as TCL lists of X, Y, Z, 4th, and 5th axes in the variables `mom_post_result` for the primary and `mom_post_result1` for the alternate." + ], + "example": [] + }, + { + "label": "MOM_disable_address", + "kind": "function", + "description": "Suppresses all output for an address. The commands `MOM_force` ONCE and `MOM_force` ALWAYS are ignored while `MOM_disable_address` is active. `MOM_enable_address` cancels `MOM_disable_address`.", + "format": "MOM_disable_address
", + "parameters": [ + { + "name": "address", + "desc": "Name of output address." + } + ], + "example": [] + }, + { + "label": "MOM_display_message", + "kind": "function", + "description": "Displays a message dialog box in NX.", + "format": "MOM_display_message <type> [<button1>] [<button2>] [<button3>]", + "parameters": [ + { + "name": "message", + "desc": "Text string for message." + }, + { + "name": "title", + "desc": "Text string for title." + }, + { + "name": "type", + "desc": "Style of the message box, I|E|W|Q, where I is info, E is error, W is warning, and Q is question." + }, + { + "name": "button1, button2, button3", + "desc": "Optional. Text string for button label." + } + ], + "returns": [ + "Returns the number of the button (1, 2, or 3) that the user clicks. Displays OK button if no label specified, and returns 1." + ], + "example": [] + }, + { + "label": "MOM_do_template", + "kind": "function", + "description": "This procedure generates output based upon the block template.", + "format": "MOM_do_template <template_name> [BUFFER|CREATE]", + "parameters": [ + { + "name": "template", + "desc": "Name of block template." + }, + { + "name": "BUFFER|CREATE", + "desc": "Optional. `BUFFER` has the usual meaning and generates the value for the block template and adds it to the output buffer. It does not send the value to the output file yet. `CREATE` generates the value for the block template but does not output to the output buffer, and hence, does not output it to the output file." }, { "name": "Start/End/\"\"", @@ -435,11 +617,85 @@ } ], "returns": [ - "0 - The UDE information retrieval failed.", - "1 - The UDE information successfully retrieved." + "String" + ], + "example": [ + "# Example 1", + "MOM_do_template linear_move" + ] + }, + { + "label": "MOM_do_template_file", + "kind": "function", + "description": "This command opens the specified Shop Documentation template file and executes each line in the file accordingly.", + "format": "MOM_do_template_file <template_file>", + "parameters": [ + { + "name": "template_file", + "desc": "Shop Documentation template file name (.tpl)." + } + ], + "example": [ + "# Example 1", + "MOM_do_template_file tool_list.tpl" + ] + }, + { + "label": "MOM_enable_address", + "kind": "function", + "description": "Restores output status for an address that MOM_disable_address suppressed.", + "format": "MOM_enable_address <address>", + "parameters": [ + { + "name": "address", + "desc": "Name of address." + } + ], + "returns": [ + "Returns output status to the initial state." ], "example": [] }, + { + "label": "MOM_force", + "kind": "function", + "description": "This procedure sets the modality of the address.", + "format": "MOM_force <Always|Once|Off> <address_1 ... address_n>", + "parameters": [ + { + "name": "Always|Once|Off", + "desc": "Always - Sets the address to be to be non-modal (always output).\nOnce - 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 is not output regardless of its modality attribute. 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 is never output. All MOM_force Once and `MOM_suppress` Once commands are ignored.\nff - Sets the address to be to be modal (output only if value changes)." + }, + { + "name": "address_1 ... address_n", + "desc": "Name of output address(es)." + } + ], + "example": [ + "# Example 1", + "MOM_force Once \"X\" \"Y\" \"Z\"" + ] + }, + { + "label": "MOM_force_block", + "kind": "function", + "description": "Same as `MOM_force` for entire block insead of single address.", + "format": "MOM_force_block <Always|Once|Off> <block_1 ... block_n>", + "parameters": [ + { + "name": "Always|Once|Off", + "desc": "`Always` - Sets the block to be to be non-modal (always output). `Once` - The next time that a block template is evaluated, the block is output regardless of its modality attribute. `Off` - Sets the block to be to be modal (output only if value changes)." + }, + { + "name": "block_1 ... block_n", + "desc": "Name of output block(s)." + } + ], + "example": [ + "# Example 1", + "MOM_force_block \"Once\" \"linear_move\"" + ] + }, { "label": "MOM_source", "kind": "function", -- 2.54.0