doc/representation.rst

   1
   2
   3
   4 Representation of a schema
   5 ==========================
   6
   7
   8
   9
  10 .. _change_2d_representation_schema:
  11
  12
  13 Change 2D representation of a schema
  14 ------------------------------------
  15 The schema consists of several nodes of control and computation types. These nodes have input and output data, stream and control ports. Connecting these ports by links means transferring data from output port to input port of a next node.
  16
  17 At the current moment YACS GUI for SALOME 4.1 provides the user with two view modes of a schema.
  18
  19
  20 .. _full_view_of_a_schema:
  21
  22
  23 + **Full view.** Nodes are "fully" displayed, with all ports and information labels. All links between connected ports are shown.
  24
  25 .. image:: images/functionality_list_77.jpg
  26   :align: center
  27
  28
  29 .. centered::
  30   **Full view of a schema**
  31
  32
  33 .. _control_view_of_a_schema:
  34
  35 + **Control view.** Only control links between connected ports are shown. presentation of nodes are simplified in order to show only the name of a node and its input/output gate ports.
  36
  37 .. image:: images/functionality_list_78.jpg
  38   :align: center
  39
  40
  41 .. centered::
  42   **Control view of a schema**
  43
  44
  45
  46
  47
  48
  49 It's worth mentioning about two additional view modes of a schema which is planned to implement in the future version of YACS module.
  50
  51
  52
  53
  54 + **Data Flow view.** Only data links between connected ports are shown.
  55
  56
  57 + **Data Stream view.** Only stream links between connected ports are shown.
  58
  59
  60
  61
  62
  63 To change the current view mode of the active schema the user should activate Input Panel with the :ref:`pp_for_schema`, choose **Full** or **Control** view mode inside the "View Mode" radio button group and press "Apply" button on the Input Panel. The easier way to change view mode of the active schema is to click **Full View** or **Control View**
  64 buttons on the :ref:`visualization`.
  65
  66 Within YACS module the user also can zoom-in and zoom-out 2D schema presentation interactively with the mouse, fit 2D presentation of a schema into 2D Viewer bounds ("Fit all" operation) and pan content of 2D Viewer ("Panning" operation) interactively with the mouse. These commands are accessible from :ref:`View Operations toolbar <view_operations_toolbar>`.
  67
  68 .. _auto-arrange_nodes:
  69
  70 Auto-arrange schema nodes
  71 -------------------------
  72 It is a very useful operation, because of it simplifies the schema presentation in the schema 2D Viewer and makes it easier for the user perception. This operation is applicable to the whole graph.
  73
  74 The auto-arrange graph nodes operation can be performed with help of **Arrange nodes** command from :ref:`visualization` and is applicable to the active schema (see :ref:`set_active_schema_or_run` section). YACS module arranges graph nodes automatically with help of an algorithm bases
  75 on the usage of dot algorithm from Graphviz C API library.
  76
  77 .. _rebuild_links:
  78
  79 Rebuild links between nodes
  80 ---------------------------
  81 It is a very useful operation, because of it simplifies the schema presentation in the schema 2D Viewer and makes it easier for the user perception. This operation constructs links in orthogonal mode.
  82
  83 The rebuild links between nodes operation can be performed with help of **Rebuild links** command from :ref:`visualization` and is applicable to the active schema (see :ref:`set_active_schema_or_run` section). YACS GUI rebuilds graph links automatically with help of LineConn2D algorithm
  84 already implemented by OCC.
  85
  86