src/ParametersPlugin/doc/managerFeature.rst

   1 .. _parameters:
   2 .. |paper_roll.icon|    image:: images/paper_roll.png
   3
   4
   5 Parameters manager
   6 ==================
   7
   8 To create/edit simultaneously a set of parameters  in the active partset or part instead of calling them one by one:
   9
  10 #. select in the Main Menu *Part - > Parameters* item or
  11 #. click |paper_roll.icon| **Parameters** button in the toolbar:
  12
  13 The following dialog box with parameter table appears:
  14
  15 .. image:: images/parameters.png
  16    :align: center
  17
  18 .. centered::
  19    Parameters dialog box
  20
  21 **Input fields**:
  22
  23 - **Name** defines parameter name. Name follows the naming rules of the python language for variables;
  24 - **Expression** allows manual input of python expression;
  25 - **Result** evaluates expression as real number by python *eval()* function;
  26 - **Comment** contains any text. This field is optional;
  27 - **Add** button adds a new empty string in the end of table. Default  **Name** is *<NoName>*, **Expression** is   *<NoValue>*
  28 - **Insert** button adds a new empty string before the selected parameter;
  29 - **Delete** button removes the selected parameter from the table;
  30 - **Modify parameter position** button moves the selected parameter
  31     .. image:: images/parameters_up.png
  32       :align: left
  33     one string higher in the table,
  34
  35     .. image:: images/parameters_down.png
  36       :align: left
  37     one string lower in the table.
  38
  39
  40 **TUI Command**:
  41
  42 .. py:function:: model.addParameter(Part_doc, Name, Value, Comment)
  43
  44     :param part: The current part object
  45     :param string: The parameter name
  46     :param number: The parameter value
  47     :param string: The parameter comment
  48     :return: Created object.
  49
  50 **See Also** a sample TUI Script of :ref:`tui_parametersFeature` operation.
  51
  52 Result
  53 ------
  54
  55 Created parameters and their current values are displayed in the Object Browser, in a special section **Parameters**.
  56
  57 .. image:: images/object_browser_parameters.png
  58    :align: center
  59
  60 .. centered::
  61    **Parameters** in object browser