<Sub-system>: <Summary>

* Issue-Ref: 4006 Issue-Url: https://af3-developer.fortiss.org/issues/4006 Signed-off-by: saadbinabid1 <abid@fortiss.org>

<Sub-system>: <Summary>
9eb78df5 · Saad bin Abid · 5a9167c2 · 9eb78df5 · 9eb78df5
Commit 9eb78df5 authored 4 years ago by Saad bin Abid
--- a/org.fortiss.af3.rcp.help/html/ModandSim/pictures/HSA.Base.Automaton.png
+++ b/org.fortiss.af3.rcp.help/html/ModandSim/pictures/HSA.Base.Automaton.png
--- a/org.fortiss.af3.rcp.help/html/mode_automaton.html
+++ b/org.fortiss.af3.rcp.help/html/mode_automaton.html
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+
+<!--
+ Documentation of Creating a Mode Automaton.
+ 
+ @author li
+ @ConQAT.Rating GREEN Hash: 6733BA0E9A74573CC0D7350749795980
+-->
+ 
+<html>
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<title>Creating a Mode Automaton using AutoFOCUS3 (AF3)</title>
+</head>
+<body>
+
+<h2><u><font color="#336699">Creating a Mode Automaton</font></u></h2>
+
+<h4><font color="#336699">Motivation and Introduction</font></h4>
+
+Beside the usage of <a href="ModandSim/state_automaton.html"><i>State Automaton</i></a>, there exists another way to model the behavior of components in a graphical Mode Automaton Diagram.
+
+<br><br>
+
+A component may contain some running modes, which should be used in distinct periods of the time. The control model for such modes is <b>mode automaton</b>. 
+The usage of the mode automaton my have consequences on the code efficiency as well as on the correctness of the design. There are four kinds of the model elements in mode automaton.
+
+<br><br>
+
+<b>Mode</b>: A mode automaton contains at least one mode. A mode describes the current configuration of computational data flow a component is in. 
+This configuration computes outputs for given component depending on the current inputs as well as the state of the local variables. A mode must have a sub component structure, in order to describe the current computation for the component.
+An initial mode, which the mode automaton starts with, is required in mode automaton.
+
+<br><br>
+
+<b>Switch</b>: Switch controls the change of the mode to execute. Switch element contains the <i>Guards</i>, which takes cares of the switch conditions.
+
+<br><br>
+
+<b>Input and Output Ports</b>: A port belongs to a mode, and is the start and the end of a switch.
+
+<br><br>
+
+<b>Mode Component Structure</b>: This model element contains the component architecture, which is used to compute the outputs when the corresponding mode active is. Every mode must contain one sub component structure.
+A mode component structure must have the same ports with the component, which contains this mode automaton. 
+
+<br><br>
+
+<h4><font color="#336699">Mode Automaton</font></h4>
+
+The mode automaton editor is very similar to state automaton editor. You can add a mode automaton to your component as shown in figure 1. In mode automaton editor, you might drag&drop a mode from the right Model Elements View to your diagram. In the same way you can add ports and mode component structure to your modes.
+
+<br><br>
+<img src="./pictures/modes.add_mode_automaton.png">
+<br>Figure 1: Add mode automaton.
+<br><br>
+
+You can select the mode and drag it to everywhere in the editor. Same for ports, just pick them and move around the border of the mode.
+To resize a mode, pick the lower, the right, or the lower-right point of its bounding-box and then move it.
+
+<br><br>
+
+In order to create switches between your modes, press the <b>&lt;alt&gt;-Key</b> on your keyboard and drag the switch from one port to another port of different I/O-kind. 
+You can also create the switch from one mode to another mode, new ports will be created automatically and the switch will be created between the new ports.
+Invalid switches (e.g., between two Output-Ports) are avoided by disabling the dragging.
+
+<br><br>
+<img src="./pictures/modes.mode_automaton_editor.png">
+<br>Figure 2: Mode automaton editor.
+<br><br>
+
+<h4><font color="#336699">Mode</font></h4>
+
+A mode automaton requires an <b>initial mode</b>. This can be done in the <i>Properties View</i> after you selected a mode. 
+This mode is marked with a little black dot afterwards(see figure 3).
+
+<br><br>
+<img src="./pictures/modes.initial_mode.png">
+<br>Figure 3: Initial mode.
+<br><br>
+
+In the <i>Properties View</i>, you can also edit the names of selected modes and also specify comments.
+
+<br><br>
+
+<h4><font color="#336699">Switch</font></h4>
+
+Just like transition in state automaton, you can change the route of switches by selecting it, pick the point shown in the middle and move it. 
+Afterwards, two new points are shown between the moved middle point and the two ports. By moving these points, you can further define the route more precisely.
+The conditions for switch between modes are done by specifying <i>Guards</i> of a switch. If no Guard of an outgoing switch is fulfilled, the current mode remains active. 
+If a switch can be fired, then new mode will be active, and the sub component architecture of this mode will take over the computation job. 
+
+<br><br>
+<img src="./pictures/modes.switch_blendpoint.png">
+<img src="./pictures/modes.switch_properties.png">
+<br>Figure 4: Edit the switch.
+<br><br>
+
+Note that, unlike transitions of a state automaton, mode switches do not have <i>actions</i>.
+Modifying the outputs should be done instead through <i>component structure inside a mode</i>.
+
+<h4><a id="ModeComponentStructure"><font color="#336699">Mode Component Structure</font></a></h4>
+
+A mode generally contains a component structure.
+Editing such a structure is done in the same way as for <a href="component_architecture.html"><i>Component Architectures</i></a>.
+You can add a mode component structure as shown in figure 5. 
+
+<br><br>
+<img src="./pictures/modes.add_mode_component_structure.png">
+<br>Figure 5: Add mode component structure.
+<br><br>
+
+Figure 6 shows an example of a mode component structure.
+You can drag and drop the component and channels and like a component architecture.
+The ports, which are highlighted in blue rectangles, should correspond to the ports of the component of the mode automaton.
+
+<br><br>
+<img src="./pictures/modes.example_mode_component_struct.png">
+<br>Figure 6: Example of a mode component structure.
+<br><br>
+
+
+<!--
+MODE DIAGRAMS DO NOT HAVE DATA YET
+
+<h4><font color="#336699">Data State Variables</font></h4>
+
+Data State Variables (DSVs) are internal variables that can be accessed in all modes of the corresponding mode automaton. 
+To edit such a variable to a mode automaton, click the <i>Mode Data</i> tab in your Mode Automaton View(see Figure 7).
+
+<br><br>
+<img src="./pictures/modes.data_state_view.png">
+<br>Figure 7: open the data state view.
+<br><br>
+
+The way to edit the variable is described in <a href="state_automaton.html"><i>State Automaton</i></a>. Please check there for more information about Data State Variable.
+--->
+
+
+<br><br>
+
+</body>
+</html>
\ No newline at end of file