src/ParametersPlugin/doc/managerFeature.rst

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