Bcc.GetCamObjParameters(ObjectID, {ParamNames}, {OptionParams})

Description

This function will return the selected input parameters for the given operation.  Optionally, you may also include a table of parameter names to only retrieve those parameters values in the return table.


The parameter name and format matches the exact structure of the default parameter templates which can be found in the following directory of your BobCAD-CAM V32 or newer system:


\BobCAD-CAM Data\BobCAD-CAM V##\Technology\Templates\CAM\DefaultParameters\Inch\System Default.xml


or 


\BobCAD-CAM Data\BobCAD-CAM V##\Technology\Templates\CAM\DefaultParameters\Metric\System Default.xml

Parameters

  • ObjectID - integer number representing the object ID
  • ParamNames - optional table including the parameter names which you would like to return.  If this table is excluded, all parameters will be returned.  


NOTE:  The valid parameter names are the same names that are used in the default parameter templates.


  • OptionParams - optional table with option parameters, currently only supporting Unit at this time.  If this table is excluded, the values will be in the current document unit.
    • Unit - valid inputs are:
      • Metric - (not case sensitive) -The values returned will be in millimeters
      • Inch -  (not case sensitive) -The values returned will be in inches
      • Any other string the values will be in the current document unit

Return

Returns a tree style table with each of the operation parameters.

Examples

-- Get every parameter from the operation in the current document unit

retTable = Bcc.GetCamObjParameters(objID)


-- Get every parameter from the operation in inch units

retTable = Bcc.GetCamObjParameters(objID, nil, {Unit=inch})


-- Retrieve 4 specific parameters from the operation only in the current document unit

retTable = Bcc.GetCamObjParameters(objID, {{"Patterns","system_compensation" },

                                                    {"Parameters", "side_allowance"},

                                                        {"Patterns", "machine_compensation" },

                                                        {"Parameters", "depth_of_cut"}})