Skip to content
Snippets Groups Projects

Task 4006 online help content

Merged Task 4006 online help content
task_4006-Online_help_content_ into master
Merged Saad bin Abid requested to merge task_4006-Online_help_content_ into master
Compare
and
Show latest version
18 files
+ 216
− 177
Compare changes
  • Side-by-side
  • Inline
Files
18
org.fortiss.af3.rcp.help/html/ModandSim/model_element_attributes.html
+ 79
− 44
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!--
Documentation of Model Element Attributes.
@author barner
@ConQAT.Rating GREEN Hash: 8E5B1642E00C9DF56CF6AA58B0048260
-->
<!-- Documentation of MIRA - Model-based Integrated Requirements. -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="../layout/stylesheet.css">
<title>General structure of the graphical interface -- Editor, Properties, Annotations</title>
</head>
<body>
<div class="header">
<div class="box">
<div class="navbar">
<!--a href="https://www.fortiss.org/" align="left">
<img src="fortiss-logo.png" width="90px" height="20px" align="left">
</a-->
<div class="dropdown">
<button class="btn" id="hamburger">
<label for="hamburger" class="hamburger">
<span class="hamburgerLine"></span>
<span class="hamburgerLine"></span>
<span class="hamburgerLine"></span>
</label>
</button>
<div class="dropdown-content">
<a href="../getting_started.html"> Main Page</a>
<a href="../requirements/MIRA.requirements.html">Requirements Engineering</a>
<a href="#">Deployment and Code Generation</a>
<a href="#">Design Space Exploration (DSE)</a>
<a href="#">Assurance Case Modeling</a>
<a href="#">Further Resources</a>
</div>
</div>
<div class="dropdown">
<button class="dropbtn">Modeling and Simulation <i class="triangle"></i></button>
<div class="dropdown-content">
<a href="component_architecture.html">Component Architecture Modeling</a>
<a href="data_dictionary.html">Data Dictionary: Types and Functions</a>
<a href="code_specification.html">Behavior Modeling -> Code Specifications</a>
<a href="state_automaton.html">Behavior Modeling -> State Automata</a>
<a href="hierarchical_state_automaton.html">Behavior Modeling -> Hierarchical State Automata</a>
<a href="mode_automaton.html">Behavior Modeling -> Mode Automata</a>
<a href="simulation_with_af3.html">Simulation -> Simulation</a>
<a href="operatorpanels.html">Simulation -> Operator Panels</a>
<a href="operatorpanels_advanced.html">Simulation -> Advanced interface</a>
<a href="cosimulation_with_af3.html">Simulation -> Co-Simulation and FMI Support</a>
<a href="refactoring.html">Refactoring</a>
<a href="model_markers_view.html">On-the-fly Checks</a>
</div>
</div>
<div class="topnav-right">
<a href="mailto:af_user@lists.fortiss.org?subject=Reporting 'model_element_attribute.html' Documentation Problem!&body= Dear Af3 team, I am reporting an issue related to 'modelling and simulation'.
{Please specify the problem precisely here.}.">Report a Problem?</a>
</div>
</div>
</head>
</div>
</div>
<div class="box">
<h2><u><font color="#336699">Introduction to Graphical Modeling Interface</font></u></h2>
<button onclick="topFunction()" id="upBtn" title="Go to top">Top</button>
<h2>Introduction to Graphical Modeling Interface</h2>
<p>The graphical interface provides three different entry points for modelling:</p>
@@ -37,30 +85,21 @@ the name of the currently selected element only, you can also see in a convenien
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>
<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>
<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>
<h3>Editor</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>
<img src="./pictures/ModelElementAttributesSpecifications.png" style='height: auto; width: auto'>
<p>In the example, <i>Component1</i> contains two model elements:</p>
<ul>
@@ -69,14 +108,12 @@ from the Model Elements pane, or by right-clicking the elements in the model nav
</ul>
<h3><font color="#336699">Properties View</font></h3>
<h3>Properties View</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>.
<p>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>.</p>
<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>
@@ -92,23 +129,21 @@ 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>
<h3>Annotation View</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>).
<p> The <i>Annotation View</i> provides a global view on all model elements annotations within
the current project root element (e.g., within a <a href="component_architecture.html">Component Architecture</a> or a
<a href="ta/platform_architecture.html">Platform Architecture</a>).</p>
<h4><font color="#336699">Overview</font></h4>
<h4>Overview</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
<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">
<img src="./pictures/ModelElementAttributesAnnotationView.png" style='height: 100%; width: 100%; object-fit: contain'>
<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>
<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>
@@ -118,18 +153,15 @@ 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.
<p>Like the <i>Properties View</i>, the <i>Annotation View</i> provides the following two annotations for any model element. </p>
<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>
<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>
<h4>Annotation View Filters</h4>
<p>At the bottom, the <i>Annotation View</i> provides a number of row and column filters.</p>
@@ -151,7 +183,10 @@ as the model element that is selected in the associated model diagram editor.</l
<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>
</ul>
</div>
<script src="../layout/jsscript/topBtn.js">
</script>
</body>
</html>
\ No newline at end of file