Salome HOME
Merge from V6_main_20120808 08Aug12
[modules/yacs.git] / doc / dataflow.rst
index a4e36022c2328b2e5c5cc6d311c6480226d8e3e1..f4677feef94e3b4f6b8551337190edaad8a58c9e 100644 (file)
@@ -5,10 +5,10 @@ A standard dataflow
 -------------------
 Let's consider a YACS schema containing Block, FOR loop and inline script nodes with data ports.
 
-The first step is to import the schema from YACS XML file. One of the ways for the user to do it is to click on the **Import schema** button on the :ref:`schema` and choose **YACS XML** item from the pull-down list. Let's open legendre7.xml from YACS_SRC/src/gui directory.
-
-After import operation, arrangement of the schema nodes and **Fit All** operation we have the following state of Salome 4.1 application.
+The first step is to import the schema from YACS XML file. One of the ways for the user to do it is to click on the **Import schema** button 
+on the :ref:`schema`. Let's open legendre7.xml from YACS_SRC/src/yacsloader/samples directory.
 
+After import operation, click on the **Fit All** button of the 2D Viewer. We have the following state of SALOME application.
 
 
 .. image:: images/functionality_list_98.jpg
@@ -19,7 +19,9 @@ After import operation, arrangement of the schema nodes and **Fit All** operatio
   **The result of legendre7.xml import**
 
 
-For more convenient view of a schema representation in 2D Viewer the user can rebuild schemas' links with help of **Rebuild links** command from :ref:`visualization`. The result will be the following.
+For more convenient view of a schema representation in 2D Viewer the user can arrange nodes and links with help of 
+the **arrange nodes recursion** command of the **proc** node context menu.
+The result will be the following.
 
 
 
@@ -28,118 +30,123 @@ For more convenient view of a schema representation in 2D Viewer the user can re
 
 
 .. centered::
-  **Representation of a schema after rebuild links operation**
+  **Representation of a schema after arrange nodes operation**
 
 
-To change input value of the schemas' node it is needed to select this node either in schema 2D Viewer or in the Tree View of a schema. And after that change input ports values with help of corresponding controls on the property page of the selected node. But in our case, if we want to execute a body of the **loopiter** node 5 times we have to change the **nsteps** output port value of **init**
-node from 3 to 5 with help of its property page, and press "Apply" button on the Input Panel schema 2D Viewer.
+To change input value of the schemas' node it is needed to select this node either in schema 2D Viewer or in the Tree View of a schema. 
+And after that change input ports values with help of corresponding controls on the property page of the selected node. 
+But in our case, if we want to execute a body of the **loopiter** node 5 times we have to change the **nsteps** output port value of **init**
+node from 3 to 5 with help of its property page (python editor), and press "Apply" button on the Input Panel schema 2D Viewer.
 
 
 .. image:: images/functionality_list_100.jpg
   :align: center
-  :width: 38ex
 
 
 .. centered::
   **Property page of init node**
 
 
-In order to execute this schema the user should to create a run of the schema with help of **New execution** button on the :ref:`execution_toolbar`. After a new schema run has been created, schema run Tree View is constructed and schema run object is published in the Object Browser.
+In order to execute this schema the user should create a run of the schema with help of **New execution** button on 
+the :ref:`execution_toolbar`. After a new schema run has been created, schema run Tree View is constructed and schema run object 
+is published in the Object Browser.
+
 
+.. image:: images/functionality_list_101a.jpg
+  :align: center
 
 .. image:: images/functionality_list_101.jpg
   :align: center
-  :width: 40ex
 
 
 .. centered::
   **Object Browser content and schema run Tree View**
 
 
-If the user selects schema object in the Tree View, Input Panel with schema property page will occur. Errors raised during create execution process is shown in the 'Error Log' list box of schema property page in the run mode. In our case there are no errors occured during creation of execution.
+If the user selects schema object in the Tree View, Input Panel with schema property page is presented. Errors raised during 
+create execution process are shown in the list box of schema property page in the run mode. In our case there is 
+no error.
 
 
 .. image:: images/functionality_list_102.jpg
   :align: center
-  :width: 38ex
 
 
 .. centered::
   **Schema property page in the run mode**
 
 
-To use :ref:`breakpoints run mode <breakpoints_mode>` it is sufficient for the user to set breakpoints on nodes using check boxes in the run Tree View. Let's set one breakpoint - on **iter2** node inside **deuxIter** block.
+To use :ref:`breakpoints run mode <breakpoints_mode>` it is sufficient for the user to set breakpoints on nodes using check boxes 
+in the run Tree View. Let's set one breakpoint - on **iter2** node inside **deuxIter** block.
 
 
 .. image:: images/functionality_list_103.jpg
   :align: center
-  :width: 40ex
 
 
 .. centered::
   **Set breakpoint in run Tree View**
 
 
-Start execution with help of **Start/Resume** button on :ref:`execution_toolbar` in run mode. Execution is paused on the **iter2** node inside **deuxIter** block. The run Tree View displays states of nodes.
+Start execution with help of **Start/Resume** button on :ref:`execution_toolbar` in run mode. Execution is paused on the **iter2** node 
+inside **deuxIter** block. The run Tree View displays states of nodes.
 
 
 .. image:: images/functionality_list_104.jpg
   :align: center
-  :width: 41ex
 
 
 .. centered::
   **Run Tree View of paused schema**
 
 
-Now try to save execution state of the schema by clicking :ref:`save_restore_execution_state` button on :ref:`execution_toolbar`. Save the current state of execution into /tmp/legendre7_exec_state.xml file.
+Now try to save execution state of the schema by clicking the **Save State** command in the YACS main menu or the **Save State** button in
+the :ref:`execution_toolbar`. Save the current state of execution into /tmp/legendre7_exec_state.xml file.
 
 
 
 .. image:: images/functionality_list_105.jpg
   :align: center
-  :width: 60ex
 
 .. centered::
   **Save the current execution state of legendre7.xml schema**
 
 
-Now execute the schema using **Start/Resume** button until the execution of the schema is finished, making sure that **loopiter** node had been executed 5 times.
+Now execute the schema using **Start/Resume** button until the execution of the schema is finished, making sure that **loopiter** node 
+had been executed 5 times.
 
 
 .. image:: images/functionality_list_106.jpg
   :align: center
-  :width: 40ex
 
 
 .. centered::
   **Execution of legendre7.xml schema is finished**
 
 
-The user can check values of output ports with help of 'Output ports' table on the propertty page of a node.
+The user can check values of output ports with help of 'Output ports' table on the property page of a node.
 
 
 .. image:: images/functionality_list_107.jpg
   :align: center
-  :width: 64ex
-
 
 .. centered::
   **Output port values of iter_1 node**
 
 
-Let's try to load saved execution state of legendre7.xml schema. After this operation run Tree View should be in the same state as at the moment of saving execution state.
+
+Go back to edit mode and let's try to load saved execution state of legendre7.xml schema with the **Load previous state** button
+in the :ref:`execution_toolbar`. After this operation run Tree View should be in the same state as at the moment of saving execution state.
 
 
 .. image:: images/functionality_list_108.jpg
   :align: center
-  :width: 40ex
 
 
 .. centered::
   **Run Tree View after load execution state**
 
 
-Continue execution of the schema from the saved state and check values of output ports when execution is finished. They should be the same as obtained earlier during the first execution.
-
+Continue execution of the schema from the saved state and check values of output ports when execution is finished. They should be 
+the same as obtained earlier during the first execution.