-
Simon Barner authored* Move to "ta" folder Issue-Ref: 3834 Issue-Url: https://af3-developer.fortiss.org/issues/3834 Signed-off-by:
Simon Barner <barner@fortiss.org>Simon Barner authored* Move to "ta" folder Issue-Ref: 3834 Issue-Url: https://af3-developer.fortiss.org/issues/3834 Signed-off-by:
Simon Barner <barner@fortiss.org>
model_element_attributes.html 6.53 KiB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--
Documentation of Model Element Attributes.
@author barner
@ConQAT.Rating GREEN Hash: 8E5B1642E00C9DF56CF6AA58B0048260
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>General structure of the graphical interface -- Editor, Properties, Annotations</title>
</head>
<body>
<h2><u><font color="#336699">Introduction to Graphical Modeling Interface</font></u></h2>
<p>The graphical interface provides three different entry points for modelling:</p>
<ul>
<li><i>Editor</i> - main window (by default taking the most prominent space on
the screen) allowing to edit the most common information of a given element.
This is the window which opens when double-clicking on an element in the <i>Model
Navigator</i>.</li>
<li><i>Properties</i> - Information which does not fit in the editor or would make
the editor unreadable is generally to be found and edited in the properties view.
Properties should information about the <i>currently selected element</i>.
Therefore, to see the properties of a given element, you should first click on it
in the editor or in the model navigator.
The properties view should always be present, if not type "Properties" in the
Quick Access entry of the tool bar.</li>
<li><i>Annotations</i> - Similar to properties but also presents information of
the children of the selected element. Annotations allow to have a quick overview of
similar information along the hierarchy. For instance, instead of seeing
the name of the currently selected element only, you can also see in a convenient
table the name of <i>all the children of the selected element</i>.</li>
</ul>
<p>In the following, the different ways and the associated views will be
described based on the simple <a href="component_architecture.html">component architecture</a> shown below.</p>
<br><br>
<img src="./pictures/ModelElementAttributesExample.png">
<br><br>
<p>The example is based, for the sake of simplicity, on a restricted version of AutoFOCUS containing only
the so-called "component architecture plugin". It should therefore not come as a surprise if your
version of AutoFOCUS allows more specification, more properties or more annotations than showed in
this help.</p>
<h3><font color="#336699">Editor</font></h3>
<p>The main editor allows to describe models through diagrams as in this example, through text (e.g.,
for code specifications), through tables/trees (e.g., data dictionary), or through forms (e.g.,
requirements). In diagram or tree editors, the models can be edited by drag and dropping elements
from the Model Elements pane, or by right-clicking the elements in the model navigator.</p>
<br><br>
<img src="./pictures/ModelElementAttributesSpecifications.png">
<br><br>
<p>In the example, <i>Component1</i> contains two model elements:</p>
<ul>
<li><a href="code_specification.html">Code Specification</a></li>
<li>Component Specifications (deprecated)</li>
</ul>
<h3><font color="#336699">Properties View</font></h3>
The <i>Properties View</i> provides a local view on all properties of the currently
selected component. The following screenshot illustrates the properties of <i>Component1</i>.
<br><br>
<img src="./pictures/ModelElementAttributesPropertiesView.png">
<br><br>
<p>The following properties are available (in the <i>General</i> tab) for any
model element type:</p>
<ul>
<li>Name</li>
<li>Comment</li>
<li>Strongly causal</li>
<li>Verification behavior</li>
</ul>
Note that name and comment are available for most elements in AutoFOCUS.
<p>The <i>Internal</i> is of no use for the standard user.</p>
<h3><font color="#336699">Annotation View</font></h3>
The <i>Annotation View</i> provides a global view on all model elements annotations within
the current project root element (e.g., within a <i><a href="component_architecture.html">Component Architecture</a></i> or a
<i><a href="ta/platform_architecture.html">Platform Architecture</a></i>).
<h4><font color="#336699">Overview</font></h4>
<p>In the <i>Annotation View</i>, each model element is represented as a row.
The row for the model element that is currently selected in the associated model
diagram editor is highlighted with a green background.</p>
<img src="./pictures/ModelElementAttributesAnnotationView.png">
<p>The view's columns represent the annotations that are associated with the
respective model element. Here, the following three cases can be distinguished:</p>
<ul>
<li>White cell - the model element contains the respective annotation that is
<i>editable by the user</i>.</li>
<li>Grey cell - the model element <i>does not contain</i> the respective annotation.</li>
<li>Blue cell - the model element contains the respective annotation. However, its
value is the result of a calculation (and hence the cell is read-only).
</ul>
<p>Like the <i>Properties View</i>, the <i>Annotation View</i> provides the following
two annotations for any model element.
<ul>
<li>Name</li>
<li>Comment</li>
</ul>
<p>
In fact, the <i>Name</i> and <i>Comment</i> annotations provide an alternative way to access the
corresponding properties.</p>
<h4><font color="#336699">Annotation View Filters</font></h4>
<p>At the bottom, the <i>Annotation View</i> provides a number of row and column filters.</p>
<p>Here, the following <i>row filters</i> can be used to restrict the set of model elements that is shown in the view:</p>
<ul>
<li><i>Filter model element name</i>: only model elements are shown whose name matches the filter string.</li>
<li><i>Filter model element type</i>: if checked, only model elements are shown that have the same type
as the model element that is selected in the associated model diagram editor.</li><li><i>Filter model element hierarchy level</i>: Filters the set of model elements based on the model structure. The following options are available:
<ul>
<li><i>Show all levels</i>: Any model element beneath the currently selected project root element is shown.</li>
<li><i>Show current level</i>: Only model elements are shown that have the same hierarchy level as the currently selected model element.</li>
<li><i>Show selected sub-model</i>: The currently selected sub-model and its entire offspring is shown.</li>
</ul>
</li>
</ul>
<p>The following <i>column filters</i> can be used to restrict the set of annotations that is shown in the view:</p>
<ul>
<li><i>Filter annotations name</i>: only annotations are shown whose name matches the filter string.</li>
<li><i>Filter annotation type</i>: either all annotation types, or only annotations of the selected type are shown.</li>
</ul>
</body>
</html>