src/ParametersPlugin/doc/managerFeature.rst

   1 .. |paper_roll.icon|    image:: images/paper_roll.png
   2
   3 .. _parameters:
   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 .. figure:: images/parameters.png
  16    :align: center
  17
  18    Parameters dialog box
  19
  20 .. |param_up| image:: images/parameters_up.png
  21 .. |param_down| image:: images/parameters_down.png
  22
  23 To edit a parameter, double-click on parameter in object browser.
  24
  25 **Input fields**:
  26
  27 - **Name** defines parameter name. Name follows the naming rules of the python language for variables;
  28 - **Expression** allows manual input of python expression;
  29 - **Result** evaluates expression as real number by python *eval()* function;
  30 - **Comment** contains any text. This field is optional;
  31 - **Add** button adds a new empty string in the end of table. Default  **Name** is *<NoName>*, **Expression** is   *<NoValue>*
  32 - **Insert** button adds a new empty string before the selected parameter;
  33 - **Delete** button removes the selected parameter from the table;
  34 - **Import** button import parameters from .txt files. Parameters must be written in file in separate lines like example: **Name** **Expression** #**Comment**
  35 Sample.txt:
  36 ''Longueur 36. # Longueur de la pièce''
  37 ''Largeur 24 #Largeur de la pièce''
  38 ''Hauteur Longueur * Largeur''
  39 - **Modify parameter position** button moves the selected parameter
  40
  41     | |param_up| one string higher in the table,
  42     | |param_down| one string lower in the table.
  43
  44 **TUI Command**:
  45
  46 .. py:function:: model.importParameters(Part_doc, filename)
  47
  48     :param part: The current part object
  49     :param filename: The txt file with parameters
  50     :return: Created objects.
  51
  52 **See Also** a sample TUI Script of a :ref:`tui_parameterFeature` operation.
  53 **See Also** :ref:`parameter` operation.