Documentation

In this page, you will find a set of tips to create a SAM model. Those guidelines are dependent on the diagram you are editing : thus this documentation page is composed of three sections, one concerning the System Diagram, another for the Automaton Diagram and a last one for the tips that are useful for both diagrams.

System diagram
Port and Flow naming conventions
When connecting two Ports, the new Flow is automatically named as follow :
  • copy the name of the Flow connected to the other side of the origin Port if it exists
  • copy the name of the Flow connected to the other side of the destination Port if it exists (and is unique)
  • copy the name of the origin Port if none flow is connected neither to the other side of the origin Port nor to the other side of the destination Port.
As the graphical connection of a Flow is not labelled, we use the Port label to display this information. Thus the label is calculated as follow :
  • when the Port is not connected to any Flow, the label correspond to the name of the Port. The name is then directly editable in the editing window.
  • when the Port is connected with a Flow as its input, output or both, the label displayed is input_flow_name>output_flow_name
  • when the Flows connected to each side of the Port have the same name, the label correspond to the name of the Flow.
Automaton diagram
Build a simple automaton diagram
  1. Create an InitialState : an InitialState is displayed differently from other States. An Automaton should contains one InitialState at the most.
  2. Create other States : add as many States as you can use only numbers or explicit name for the naming of these States. It will depend of course of the type of your automaton and its semantic. Of course you could use the Documentation View to associate more informations with your diagram elements.
  3. Create Transitions between these States : the label that is displayed is a concatenation of two properties of the Transition ('condition' and 'emission'). automatonDiagramExample
General
Feature Synchronization Ports and MultiPorts container (System and Automaton mainly) are synchronized with their model. It means that these elements always display Ports and MultiPorts that they contain. Consequently the Delete action that would apply only for the graphical representation is disabled for the Port and MultiPort model objects.