eTrice 2.0.0 documentation
Change-Id: Id209756ed8dcb76756f335aa52c4e3c1410c4812
diff --git a/documentation/release/Dave-Integration.html b/documentation/release/Dave-Integration.html
index afc5691..f42c9ed 100644
--- a/documentation/release/Dave-Integration.html
+++ b/documentation/release/Dave-Integration.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#dave-etrice-toolchain-tutorial" name="dave-etrice-toolchain-tutorial"></a>DAVE-eTrice Toolchain Tutorial</h1>
<h2><a href="#introduction" name="introduction"></a>Introduction</h2>
@@ -1163,9 +1179,9 @@
<p>Open <em>BlinkyTutorial.room</em> and create a new Actor called AHWAbstraction by adding the following text:</p>
<pre><code class="room customHighlighted"><span class="keyword">ActorClass</span> AHWAbstraction {
<span class="keyword">Structure</span> {
- <span class="keyword">usercode1</span> <span class="string">'''
- #include "Dave.h"
- '''</span>
+ <span class="keyword">usercode1</span> '''
+ #include <span class="string">"Dave.h"</span>
+ '''
}
}
</code></pre>
@@ -1197,9 +1213,9 @@
<span class="keyword">Port</span> LED1: POnOff
}
<span class="keyword">Structure</span> {
- <span class="keyword">usercode1</span> <span class="string">'''
- #include "Dave.h"
- '''</span>
+ <span class="keyword">usercode1</span> '''
+ #include <span class="string">"Dave.h"</span>
+ '''
<span class="keyword">external</span> <span class="keyword">Port</span> LED1
}
<span class="keyword">Behavior</span> {
@@ -1210,17 +1226,17 @@
<span class="keyword">triggers</span> {
<on: LED1>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputHigh(&LED1_P5_9);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr1: state0 -> state0 {
<span class="keyword">triggers</span> {
<off: LED1>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputLow(&LED1_P5_9);
- '''</span>
+ '''
}
}
}
@@ -1253,25 +1269,25 @@
<span class="keyword">State</span> state0
<span class="keyword">State</span> state1
<span class="keyword">Transition</span> init: <span class="keyword">initial</span> -> state0 {
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
timer.startTimer(300);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr0: state0 -> state1 {
<span class="keyword">triggers</span> {
<timeout: timer>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
out.on();
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr1: state1 -> state0 {
<span class="keyword">triggers</span> {
<timeout: timer>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
out.off();
- '''</span>
+ '''
}
}
}
@@ -1310,25 +1326,25 @@
<span class="keyword">State</span> state0
<span class="keyword">State</span> state1
<span class="keyword">Transition</span> init: <span class="keyword">initial</span> -> state0 {
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
timer.startTimer(300);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr0: state0 -> state1 {
<span class="keyword">triggers</span> {
<timeout: timer>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
out.on();
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr1: state1 -> state0 {
<span class="keyword">triggers</span> {
<timeout: timer>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
out.off();
- '''</span>
+ '''
}
}
}
@@ -1339,9 +1355,9 @@
<span class="keyword">Port</span> LED1: POnOff
}
<span class="keyword">Structure</span> {
- <span class="keyword">usercode1</span> <span class="string">'''
- #include "Dave.h"
- '''</span>
+ <span class="keyword">usercode1</span> '''
+ #include <span class="string">"Dave.h"</span>
+ '''
<span class="keyword">external</span> <span class="keyword">Port</span> LED1
}
<span class="keyword">Behavior</span> {
@@ -1352,17 +1368,17 @@
<span class="keyword">triggers</span> {
<on: LED1>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputHigh(&LED1_P5_9);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr1: state0 -> state0 {
<span class="keyword">triggers</span> {
<off: LED1>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputLow(&LED1_P5_9);
- '''</span>
+ '''
}
}
}
@@ -1445,14 +1461,14 @@
<span class="keyword">State</span> blinking {
<span class="keyword">subgraph</span> {
<span class="keyword">State</span> on {
- <span class="keyword">entry</span> <span class="string">'''
+ <span class="keyword">entry</span> '''
out.on();
- '''</span>
+ '''
}
<span class="keyword">State</span> off {
- <span class="keyword">entry</span> <span class="string">'''
+ <span class="keyword">entry</span> '''
out.off();
- '''</span>
+ '''
}
<span class="keyword">EntryPoint</span> tp0
<span class="keyword">Transition</span> tr0: on -> off {
@@ -1466,9 +1482,9 @@
}
}
<span class="keyword">Transition</span> tr2: <span class="keyword">my</span> tp0 -> on {
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
timer.startTimer(300);
- '''</span>
+ '''
}
}
}
@@ -1484,10 +1500,10 @@
<span class="keyword">triggers</span> {
<off: ctrl>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
timer.kill();
out.off();
- '''</span>
+ '''
}
}
}
@@ -1501,9 +1517,9 @@
<span class="keyword">conjugated</span> <span class="keyword">Port</span> BUTTON2: POnOff
}
<span class="keyword">Structure</span> {
- <span class="keyword">usercode1</span> <span class="string">'''
- #include "Dave.h"
- '''</span>
+ <span class="keyword">usercode1</span> '''
+ #include <span class="string">"Dave.h"</span>
+ '''
<span class="keyword">SAP</span> timer: PTimer
<span class="keyword">external</span> <span class="keyword">Port</span> LED1
<span class="keyword">external</span> <span class="keyword">Port</span> LED2
@@ -1516,77 +1532,77 @@
<span class="keyword">StateMachine</span> {
<span class="keyword">State</span> state0
<span class="keyword">Transition</span> init: <span class="keyword">initial</span> -> state0 {
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
timer.startTimer(50);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr0: state0 -> state0 {
<span class="keyword">triggers</span> {
<on: LED1>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputHigh(&LED1_P5_9);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr1: state0 -> state0 {
<span class="keyword">triggers</span> {
<off: LED1>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputLow(&LED1_P5_9);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr2: state0 -> state0 {
<span class="keyword">triggers</span> {
<on: LED2>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputHigh(&LED2_P5_8);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr3: state0 -> state0 {
<span class="keyword">triggers</span> {
<off: LED2>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
DIGITAL_IO_SetOutputLow(&LED2_P5_8);
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr4: state0 -> state0 {
<span class="keyword">triggers</span> {
<timeout: timer>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
if (DIGITAL_IO_GetInput(&BUTTON1_P15_13) == 0) {
if (b1Status == 0) {
- // input changed
- b1Status = 1;
+ <span class="comment">// input changed
+</span> b1Status = 1;
BUTTON1.on();
}
}
else {
if (b1Status == 1) {
- // input changed
- b1Status = 0;
+ <span class="comment">// input changed
+</span> b1Status = 0;
BUTTON1.off();
}
}
if (DIGITAL_IO_GetInput(&BUTTON2_P15_12) == 0) {
if (b2Status == 0){
- // input changed
- b2Status = 1;
+ <span class="comment">// input changed
+</span> b2Status = 1;
BUTTON2.on();
}
}
else {
if (b2Status == 1) {
- // input changed
- b2Status = 0;
+ <span class="comment">// input changed
+</span> b2Status = 0;
BUTTON2.off();
}
}
- '''</span>
+ '''
}
}
}
@@ -1617,17 +1633,17 @@
<span class="keyword">triggers</span> {
<on: ctrl>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
out.on();
- '''</span>
+ '''
}
<span class="keyword">Transition</span> tr1: on -> off {
<span class="keyword">triggers</span> {
<on: ctrl>
}
- <span class="keyword">action</span> <span class="string">'''
+ <span class="keyword">action</span> '''
out.off();
- '''</span>
+ '''
}
}
}
@@ -1765,7 +1781,7 @@
</code></pre>
<p>Generate your code, compile and debug the application.<br>Have fun.</p>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/ResourceRequirements.html b/documentation/release/ResourceRequirements.html
index 04908bf..0c06c1d 100644
--- a/documentation/release/ResourceRequirements.html
+++ b/documentation/release/ResourceRequirements.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#resource-requirements" name="resource-requirements"></a>Resource Requirements</h1>
<p>There is often the question: What are the costs of the high level modeling language? The answer depends on many parameters e.g. compiler settings, uC architecture, configuration of the runtime system, model size…</p>
@@ -1131,7 +1147,7 @@
</table>
<p>As a result from the above table you should be able to assess the costs on the one hand and the benefits of a model on the other hand for your specific application. As a rough recommendation and depending on your specific application it might be reasonable to start modeling with a single threaded application on a microcontroller starting from 16KByte Flash an 4KByte RAM. For example a XMC™ Cortex M0 from Infineon with 64KByte Flash and 16kByte RAM provides a comfortable platform for modelling even multi threaded systems with underlaying operating system. </p>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/developers-reference.html b/documentation/release/developers-reference.html
index 08936b8..88b3fdb 100644
--- a/documentation/release/developers-reference.html
+++ b/documentation/release/developers-reference.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#etrice-tool-developer-s-reference" name="etrice-tool-developer-s-reference"></a>eTrice Tool Developer’s Reference</h1>
<h2><a href="#architecture" name="architecture"></a>Architecture</h2>
@@ -1468,7 +1484,7 @@
<h4><a href="#the-documentation-generator" name="the-documentation-generator"></a>The Documentation Generator</h4>
<p>The documentation generator creates documentation in LaTex format which can be converted into PDF and many other formats.</p>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/etrice-features.html b/documentation/release/etrice-features.html
index f8113b6..e00d11f 100644
--- a/documentation/release/etrice-features.html
+++ b/documentation/release/etrice-features.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#etrice-features" name="etrice-features"></a>eTrice Features</h1>
<h2><a href="#model-navigation" name="model-navigation"></a>Model Navigation</h2>
@@ -1411,7 +1427,7 @@
<p>The last model finally combines all this information by mapping logical to physical entities.</p>
<p>The result of the mapping is also depicted in above <a href="#room-instance-diagram">instance tree diagram</a> of the instances. All actor instances (the white boxes) are mapped to a node and a thread running on this node (shown as @*node* : <em>thread</em>).</p>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/examples.html b/documentation/release/examples.html
index e1c0660..f11c780 100644
--- a/documentation/release/examples.html
+++ b/documentation/release/examples.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#examples" name="examples"></a>Examples</h1>
<p>The eTrice examples can be installed using the new wizard.</p>
@@ -1365,7 +1381,7 @@
<li><em>Caution:</em> currently the generator informs about unsatisfied services in dynamic actors. But it is still possible to create such an instance. The consequence is an unbound SAP</li>
</ul>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/feature-reference.html b/documentation/release/feature-reference.html
index 3694cae..6eee3e1 100644
--- a/documentation/release/feature-reference.html
+++ b/documentation/release/feature-reference.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<!-- generated by featurizer -->
<h1><a href="#roomlanguage" name="roomlanguage"></a>ROOMLanguage</h1>
@@ -1718,7 +1734,7 @@
<span class="comment">// explicit: eventdriven ProtocolClass EventdrivenProtocolClass {
</span> <span class="keyword">incoming</span> {
<span class="keyword">Message</span> msg1() [<span class="string">"message without data"</span>]
- <span class="keyword">Message</span> msg2(data: int32) [<span class="string">"message with data"</span>]
+ <span class="keyword">Message</span> msg2(int32) [<span class="string">"message with data"</span>]
}
<span class="keyword">outgoing</span> {
<span class="keyword">Message</span> msg4() [<span class="string">"eventdriven ProtocolClass can have message into two directions"</span>]
@@ -1727,7 +1743,7 @@
<span class="keyword">datadriven</span> <span class="keyword">ProtocolClass</span> DatadrivenProtocolClass {
<span class="keyword">incoming</span> {
- <span class="keyword">Message</span> signal1 (data: int32) [<span class="string">"a datadriven message needs data"</span>]
+ <span class="keyword">Message</span> signal1 (int32) [<span class="string">"a datadriven message needs data"</span>]
}
<span class="comment">// datadriven ProtocolClass can only have incoming messages (signals)
</span>}
@@ -1779,22 +1795,20 @@
</tbody>
</table>
<p><strong>Example</strong>:</p>
-<pre><code class="room customHighlighted"><span class="keyword">DataClass</span> SimpleDataClass {
- <span class="keyword">Attribute</span> attribute1: uint16
- <span class="keyword">Attribute</span> attribute2: uint32
-}
+<p>¦¦¦<br> ```room<br/> DataClass SimpleDataClass {<br/> Attribute attribute1: uint16<br/> Attribute attribute2: uint32<br/> }</p>
+<pre><code> DataClass DataClassExample {
+ Attribute attribute1: uint32
+ Attribute attribute2: SimpleDataClass
+ Attribute attribute3: voidType ref
-<span class="keyword">DataClass</span> DataClassExample {
- <span class="keyword">Attribute</span> attribute1: uint32
- <span class="keyword">Attribute</span> attribute2: SimpleDataClass
- <span class="keyword">Attribute</span> attribute3: voidType <span class="keyword">ref</span>
-
- <span class="keyword">Operation</span> operation1(param1: uint32, param2: uint16): boolean <span class="string">'''
- return true;
- '''</span>
-}
-</code></pre>
-<hr>
+ Operation operation1(param1: uint32, param2: uint16): boolean &#39;&#39;&#39;
+ return true;
+ &#39;&#39;&#39;
+ }
+ ```
+¦¦¦
+
+</p><hr>
<h3><a href="#datatype" name="datatype"></a>DataType</h3>
<p>A DataType can take 4 forms and types data elements like an Attribute or Operation argument</p>
<table style="vertical-align: middle;" class="table">
@@ -2017,25 +2031,25 @@
</tbody>
</table>
<p><strong>Example</strong>:</p>
-<pre><code class="room customHighlighted"><span class="comment">// Include is needed when used (e.g. in ActorClassWithExternalType)
-</span><span class="keyword">ExternalType</span> someStructType -> <span class="string">"struct FILE_HANDLE"</span>
+<p>¦¦¦<br> ```room<br/> // Include is needed when used (e.g. in ActorClassWithExternalType)<br/> ExternalType someStructType -&gt; &ldquo;struct FILE_HANDLE&rdquo;</p>
+<pre><code> ActorClass ActorClassWithExternalType{
+ Structure {
+ usercode1 &#39;&#39;&#39;
+ // #include &lt;___.h&gt; /* User includes here*/
+ &#39;&#39;&#39;
+ Attribute someHandle : someStructType ref // needs include
+ }
+ Behavior {
+ Operation operation1(param1: charPtr) &#39;&#39;&#39;
+ // external calls or casts may need includes
+ write(someHandle, param1);
+ &#39;&#39;&#39;
+ }
+ }
+ ```
+¦¦¦
-<span class="keyword">ActorClass</span> ActorClassWithExternalType{
- <span class="keyword">Structure</span> {
- <span class="keyword">usercode1</span> <span class="string">'''
- // #include <___.h> /* User includes here*/
- '''</span>
- <span class="keyword">Attribute</span> someHandle : someStructType <span class="keyword">ref</span> <span class="comment">// needs include
-</span> }
- <span class="keyword">Behavior</span> {
- <span class="keyword">Operation</span> operation1(param1: charPtr) <span class="string">'''
- // external calls or casts may need includes
- write(someHandle, param1);
- '''</span>
- }
-}
-</code></pre>
-<hr>
+</p><hr>
<h3><a href="#inheritance" name="inheritance"></a>Inheritance</h3>
<p>A class can specify a super class and inherits elements from the super class hierarchy</p>
<p>When a ROOM class specifies a super class, it generally inherits all elements and properties.<br>In several cases, it is possible, to override these inherited elements. Generally, eTrice has two semantics of overriding: refinement and replacement.<br>Refinement is used in most cases (e.g. StateMachine) and realizes an extension of the overridden elements.<br>In this case, if a sub class overrides a piece of logic from a super class, it will always be executed subsequently to the inherited.<br>Contrary to this, replacement is applied to overridden Operations, similar to programming languages C++ and Java.</p>
@@ -2075,43 +2089,42 @@
</tbody>
</table>
<p><strong>Example</strong>:</p>
-<pre><code class="room customHighlighted"><span class="keyword">ActorClass</span> ActorSubClass <span class="keyword">extends</span> ActorBaseClass {
- <span class="comment">// inherits all elements from super type hierarchy
-</span>}
+<p>¦¦¦<br> ```room<br/> ActorClass ActorSubClass extends ActorBaseClass {<br/> // inherits all elements from super type hierarchy<br/> }</p>
+<pre><code> ActorClass ActorBaseClass {
+ Interface {
+ Port port1 : ProtocolBaseClass
+ }
+ Structure {
+ Attribute attribute1 : uint32
+ }
+ Behavior {
+ Operation operation1() &#39;&#39;&#39;
+ return;
+ &#39;&#39;&#39;
+ }
+ }
-<span class="keyword">ActorClass</span> ActorBaseClass {
- <span class="keyword">Interface</span> {
- <span class="keyword">Port</span> port1 : ProtocolBaseClass
- }
- <span class="keyword">Structure</span> {
- <span class="keyword">Attribute</span> attribute1 : uint32
- }
- <span class="keyword">Behavior</span> {
- <span class="keyword">Operation</span> operation1() <span class="string">'''
- return;
- '''</span>
- }
-}
+ ProtocolClass ProtocolSubClass extends ProtocolBaseClass {
+ // inherits all elements from super type hierarchy
+ }
-<span class="keyword">ProtocolClass</span> ProtocolSubClass <span class="keyword">extends</span> ProtocolBaseClass {
- <span class="comment">// inherits all elements from super type hierarchy
-</span>}
+ ProtocolClass ProtocolBaseClass {
+ incoming {
+ Message message1()
+ }
+ }
-<span class="keyword">ProtocolClass</span> ProtocolBaseClass {
- <span class="keyword">incoming</span> {
- <span class="keyword">Message</span> message1()
- }
-}
+ DataClass DataSubClass extends DataBaseClass {
+ // inherits all elements from super type hierarchy
+ }
-<span class="keyword">DataClass</span> DataSubClass <span class="keyword">extends</span> DataBaseClass {
- <span class="comment">// inherits all elements from super type hierarchy
-</span>}
+ DataClass DataBaseClass {
+ Attribute attribute1 : uint32
+ }
+ ```
+ ¦¦¦
-<span class="keyword">DataClass</span> DataBaseClass {
- <span class="keyword">Attribute</span> attribute1 : uint32
-}
-</code></pre>
-<hr>
+</p><hr>
<h3><a href="#internalendport" name="internalendport"></a>InternalEndPort</h3>
<p>A InternalEndPort is an local Port, that is declared in the internal interface of an ActorClass</p>
<pre><code class="room customHighlighted"><span class="keyword">ActorClass</span> InternalEndPortExample {
@@ -2298,43 +2311,44 @@
</tbody>
</table>
<p><strong>Example</strong>:</p>
-<pre><code class="room customHighlighted"><span class="keyword">import</span> room.basic.types.* <span class="keyword">from</span> <span class="string">"../../../org.eclipse.etrice.modellib.c/model/Types.room"</span>
+<p>¦¦¦<br> ```room<br/> import room.basic.types.* from &ldquo;../../../org.eclipse.etrice.modellib.c/model/Types.room&rdquo;</p>
+<pre><code> DataClass DataClassWithOperation {
+ Attribute attribute1 : uint32
-<span class="keyword">DataClass</span> DataClassWithOperation {
- <span class="keyword">Attribute</span> attribute1 : uint32
-
- <span class="keyword">Operation</span> operation1(param1: uint32, param2: int32): boolean <span class="string">'''
- return attribute1 > (param1 - param2);
- '''</span>
-}
+ Operation operation1(param1: uint32, param2: int32): boolean &#39;&#39;&#39;
+ return attribute1 &gt; (param1 - param2);
+ &#39;&#39;&#39;
+ }
-<span class="keyword">ActorClass</span> ActorClassWithOperation {
- <span class="keyword">Structure</span> {
- <span class="keyword">Attribute</span> attribute1 : uint32
- }
- <span class="keyword">Behavior</span> {
- <span class="keyword">Operation</span> operation1(param1: uint32, param2: int32): boolean <span class="string">'''
- return attribute1 > (param1 - param2);
- '''</span>
- }
-}
+ ActorClass ActorClassWithOperation {
+ Structure {
+ Attribute attribute1 : uint32
+ }
+ Behavior {
+ Operation operation1(param1: uint32, param2: int32): boolean &#39;&#39;&#39;
+ return attribute1 &gt; (param1 - param2);
+ &#39;&#39;&#39;
+ }
+ }
-<span class="keyword">ActorClass</span> ActorClassWithOperation2 {
- <span class="keyword">Structure</span> {
- <span class="keyword">usercode1</span> <span class="string">'''
- // #include <___.h> /* User includes here */
- '''</span>
- <span class="keyword">Attribute</span> someHandle : voidType <span class="keyword">ref</span>
- }
- <span class="keyword">Behavior</span> {
- <span class="keyword">Operation</span> operation1(param1: charPtr) <span class="string">'''
- // external calls or casts may need includes
- write(someHandle, param1);
- '''</span>
- }
-}
-</code></pre>
-<hr>
+ ActorClass ActorClassWithOperation2 {
+ Structure {
+ usercode1 &#39;&#39;&#39;
+ // #include &lt;___.h&gt; /* User includes here */
+ &#39;&#39;&#39;
+ Attribute someHandle : voidType ref
+ }
+ Behavior {
+ Operation operation1(param1: charPtr) &#39;&#39;&#39;
+ // external calls or casts may need includes
+ write(someHandle, param1);
+ &#39;&#39;&#39;
+ }
+ }
+ ```
+¦¦¦
+
+</p><hr>
<h3><a href="#port" name="port"></a>Port</h3>
<p>A Port is an instance of a ProtocolClass and the interface for an ActorClass</p>
<p>Once a ProtocolClass has been created, it can be used to define actor interfaces. This is accomplished by means of Ports.<br>A Port is a declaration that the set of messages defined by its ProtocolClass is now part of the actor’s interface.<br>It provides strong decoupling of ActorClasses from each other, thus enabling easy testability, reusability and deployment of actors to different threads or nodes.</p>
@@ -2473,11 +2487,11 @@
<p>A ProtocolClass provides a reusable interface specification for ports. It defines a set of incoming and outgoing Messages that can be exchanged between two ports.<br>The exact semantics of a message is defined by the CommunicationType.<br>Protocol classes have only textual notation.</p>
<pre><code class="room customHighlighted"><span class="keyword">ProtocolClass</span> SimpleProtocolClass {
<span class="keyword">incoming</span> {
- <span class="keyword">Message</span> msg1(data: int32}
+ <span class="keyword">Message</span> msg1(int32}
<span class="keyword">Message</span> msg2()
}
<span class="keyword">outgoing</span> {
- <span class="keyword">Message</span> msg3(data: DataClass1}
+ <span class="keyword">Message</span> msg3(DataClass1}
<span class="keyword">Message</span> msg4()
}
}
@@ -2549,13 +2563,13 @@
</span> <span class="keyword">incoming</span> {
<span class="comment">// incoming means incoming for a regular port and outgoing for a conjugated port
</span> <span class="keyword">Message</span> message1() <span class="comment">// message without data
-</span> <span class="keyword">Message</span> message2(data: int32) <span class="comment">// message with simple data
-</span> <span class="keyword">Message</span> message3(data: DMessageData) <span class="comment">// message with complex data (DataClass)
+</span> <span class="keyword">Message</span> message2(int32) <span class="comment">// message with simple data
+</span> <span class="keyword">Message</span> message3(DMessageData) <span class="comment">// message with complex data (DataClass)
</span>
}
<span class="keyword">outgoing</span> {
<span class="comment">// outgoing means outgoing for a regular port and incoming for a conjugated port
-</span> <span class="keyword">Message</span> message1(data: int32) <span class="comment">// incoming and outgoing Messages can have the same name to enable symmetric protocols
+</span> <span class="keyword">Message</span> message1(int32) <span class="comment">// incoming and outgoing Messages can have the same name to enable symmetric protocols
</span> }
}
@@ -2569,9 +2583,9 @@
</span><span class="keyword">datadriven</span> <span class="keyword">ProtocolClass</span> ProtocolClassData {
<span class="keyword">incoming</span> {
<span class="comment">// incoming means incoming for a regular port and outgoing for a conjugated port
-</span> <span class="keyword">Message</span> value1(value: int32) <span class="comment">// a datadriven message (signal) always needs data
-</span> <span class="keyword">Message</span> value2(value: int16) <span class="comment">// datadriven message with simple data
-</span> <span class="keyword">Message</span> value3(value: DMessageData) <span class="comment">// datadriven message with complex data (DataClass)
+</span> <span class="keyword">Message</span> value1(int32) <span class="comment">// a datadriven message (signal) always needs data
+</span> <span class="keyword">Message</span> value2(int16) <span class="comment">// datadriven message with simple data
+</span> <span class="keyword">Message</span> value3(DMessageData) <span class="comment">// datadriven message with complex data (DataClass)
</span>
}
<span class="comment">// no outgoing messages for datadriven ports allowed
@@ -3488,7 +3502,7 @@
</table>
<hr>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/images/600-DetailcodeMigration.png b/documentation/release/images/600-DetailcodeMigration.png
new file mode 100644
index 0000000..4d81ea7
--- /dev/null
+++ b/documentation/release/images/600-DetailcodeMigration.png
Binary files differ
diff --git a/documentation/release/images/600-TransitionDataMigration.png b/documentation/release/images/600-TransitionDataMigration.png
new file mode 100644
index 0000000..cf4544d
--- /dev/null
+++ b/documentation/release/images/600-TransitionDataMigration.png
Binary files differ
diff --git a/documentation/release/images/600-TransitionDataMigrationAssitant.png b/documentation/release/images/600-TransitionDataMigrationAssitant.png
new file mode 100644
index 0000000..02fa1d8
--- /dev/null
+++ b/documentation/release/images/600-TransitionDataMigrationAssitant.png
Binary files differ
diff --git a/documentation/release/introduction.html b/documentation/release/introduction.html
index cb348c1..6018946 100644
--- a/documentation/release/introduction.html
+++ b/documentation/release/introduction.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#introduction" name="introduction"></a>Introduction</h1>
<h2><a href="#etrice-overview" name="etrice-overview"></a>eTrice Overview</h2>
@@ -1195,11 +1211,11 @@
<td><p><img src="images/040-ActorClass.png" alt="image"></p></td>
<td><pre><code class="room customHighlighted"><span class="keyword">ProtocolClass</span> ProtocolClass1 {
<span class="keyword">incoming</span> {
- <span class="keyword">Message</span> m1(data : int32)
+ <span class="keyword">Message</span> m1(int32)
<span class="keyword">Message</span> m2()
}
<span class="keyword">outgoing</span> {
- <span class="keyword">Message</span> m3(data: DataClass1)
+ <span class="keyword">Message</span> m3(DataClass1)
<span class="keyword">Message</span> m4()
}
}
@@ -1264,7 +1280,7 @@
<h5><a href="#synchronous" name="synchronous"></a>synchronous</h5>
<p>The synchronous execution model could also be called <em>function calls</em>. This model in general is not very well suited to support the <em>run to completion</em> semantics typical for ROOM models, but could also be generated from ROOM models. With this execution model also lower levels of a software system, such as device drivers, could be generated from ROOM models.</p>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/release-notes.html b/documentation/release/release-notes.html
new file mode 100644
index 0000000..83d5723
--- /dev/null
+++ b/documentation/release/release-notes.html
@@ -0,0 +1,1126 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+<title>eTrice Documentation</title>
+
+<!-- Bootstrap -->
+<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css"/>
+<link rel="stylesheet" type="text/css" href="css/metisMenu.min.css"/>
+<link rel="stylesheet" type="text/css" href="css/font-awesome.min.css"/>
+<link rel="stylesheet" type="text/css" href="css/prettify.css"/>
+<link rel="stylesheet" type="text/css" href="css/custom.css"/>
+<link rel="stylesheet" type="text/css" href="css/custom-common.css"/>
+
+<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
+<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+<!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+<![endif]-->
+
+</head>
+<body>
+
+<!-- Fixed navbar -->
+<nav class="navbar navbar-default navbar-static-top" role="navigation">
+<div class="container">
+<div class="navbar-header">
+<a class="navbar-brand" style="padding-bottom: 2px; padding-top: 4px;" href="introduction.html"><img style="height: 100%;" src="images/logo/etrice-logo-interim.png"></a>
+</div>
+<div id="navbar" class="collapse navbar-collapse">
+<ul class="nav navbar-nav">
+<li class="active"><a href="introduction.html">Online Documentation</a></li>
+<li><a href="http://www.eclipse.org/forums/eclipse.etrice">Newsgroup</a></li>
+<li><a href="https://www.eclipse.org/etrice/">eTrice Home</a></li>
+<li><a href="https://www.eclipse.org/etrice/download.php">Downloads</a></li>
+
+<li><a href="https://git.eclipse.org/c/etrice/org.eclipse.etrice.git/">Git repository</a></li>
+
+</ul>
+</div><!--/.nav-collapse -->
+</div>
+</nav>
+
+
+
+<div class="container">
+<div class="row">
+<div class="col-sm-3">
+<div id="sidebar" role="navigation">
+<ul class="nav metismenu" id="sidebarMenu">
+<li><a href="introduction.html" aria-expanded="false">Introduction <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="introduction.html#etrice-overview" aria-expanded="false">eTrice Overview <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="introduction.html#what-is-etrice-">What is eTrice?</a></li>
+
+
+
+
+
+
+<li><a href="introduction.html#reduction-of-complexity">Reduction of Complexity</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="introduction.html#introduction-room-language" aria-expanded="false">Introduction ROOM Language <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="introduction.html#scope-of-room">Scope of ROOM</a></li>
+
+
+
+
+
+
+<li><a href="introduction.html#basic-concepts">Basic Concepts</a></li>
+
+
+
+
+
+
+<li><a href="introduction.html#execution-models">Execution Models</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="tutorials.html" aria-expanded="false">Tutorials <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="tutorials.html#working-with-the-tutorials">Working with the tutorials</a></li>
+
+
+
+
+
+
+<li><a href="tutorials.html#getting-started-c">Getting Started C</a></li>
+
+
+
+
+
+
+<li><a href="tutorials.html#getting-started-c-">Getting Started C++</a></li>
+
+
+
+
+
+
+<li><a href="tutorials.html#getting-started-java">Getting Started Java</a></li>
+
+
+
+
+
+
+<li><a href="tutorials.html#tutorial-ping-pong-java-c-and-c-" aria-expanded="false">Tutorial Ping Pong Java, C and C++ <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="tutorials.html#scope">Scope</a></li>
+
+
+
+
+
+
+<li><a href="tutorials.html#create-the-structure">Create the structure</a></li>
+
+
+
+
+
+
+<li><a href="tutorials.html#implement-the-behavior">Implement the Behavior</a></li>
+
+
+
+
+
+
+<li><a href="tutorials.html#summary">Summary</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="tutorials.html#troubleshooting">Troubleshooting</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="standalone-generators.html">Standalone Generators</a></li>
+
+
+
+
+
+
+<li><a href="examples.html" aria-expanded="false">Examples <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="examples.html#the-c-examples-project" aria-expanded="false">The C examples project <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="examples.html#traffic-light-step-1">Traffic light - step 1</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#traffic-light-step-2">Traffic light - step 2</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#traffic-light-step-3">Traffic light - step 3</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#traffic-light-step-4">Traffic light - step 4</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#features">Features</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="examples.html#the-java-examples-project" aria-expanded="false">The Java examples project <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="examples.html#dynamic-actors-1">Dynamic Actors 1</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-2">Dynamic Actors 2</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-3">Dynamic Actors 3</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-4">Dynamic Actors 4</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-5">Dynamic Actors 5</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-6">Dynamic Actors 6</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-7">Dynamic Actors 7</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-8">Dynamic Actors 8</a></li>
+
+
+
+
+
+
+<li><a href="examples.html#dynamic-actors-9">Dynamic Actors 9</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="room-concepts.html" aria-expanded="false">ROOM Concepts <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="room-concepts.html#actors">Actors</a></li>
+
+
+
+
+
+
+<li><a href="room-concepts.html#protocols">Protocols</a></li>
+
+
+
+
+
+
+<li><a href="room-concepts.html#ports">Ports</a></li>
+
+
+
+
+
+
+<li><a href="room-concepts.html#dataclass">DataClass</a></li>
+
+
+
+
+
+
+<li><a href="room-concepts.html#layering">Layering</a></li>
+
+
+
+
+
+
+<li><a href="room-concepts.html#finite-state-machines">Finite State Machines</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="etrice-features.html" aria-expanded="false">eTrice Features <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="etrice-features.html#model-navigation" aria-expanded="false">Model Navigation <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="etrice-features.html#from-model-to-behavior-to-structure">From Model to Behavior to Structure</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#model-navigation">Model Navigation</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#navigating-behavior-diagrams">Navigating Behavior Diagrams</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#navigating-structure-diagrams">Navigating Structure Diagrams</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="etrice-features.html#etrice-java-projects" aria-expanded="false">eTrice Java Projects <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="etrice-features.html#eclipse-jdt-build">Eclipse JDT Build</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#maven-build">Maven Build</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="etrice-features.html#automatic-diagram-layout-with-kieler" aria-expanded="false">Automatic Diagram Layout with KIELER <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="etrice-features.html#overview">Overview</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#performing-automatic-layout">Performing Automatic Layout</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#layout-options">Layout Options</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#configuring-layout-options">Configuring Layout Options</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#special-layout-options">Special Layout Options</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#further-references">Further References</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="etrice-features.html#annotations" aria-expanded="false">Annotations <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="etrice-features.html#annotation-type-definitions">Annotation Type Definitions</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#usage-and-effect-of-the-pre-defined-annotations">Usage and Effect of the Pre-defined Annotations</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="etrice-features.html#enumerations">Enumerations</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#etrice-models-and-their-relations" aria-expanded="false">eTrice Models and Their Relations <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="etrice-features.html#the-room-model">The ROOM Model</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#the-config-model">The Config Model</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#the-physical-model">The Physical Model</a></li>
+
+
+
+
+
+
+<li><a href="etrice-features.html#the-mapping-model">The Mapping Model</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="feature-reference.html" aria-expanded="false">Feature Reference <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#roomlanguage" aria-expanded="false">ROOMLanguage <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#configmodel">ConfigModel</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#logicalmodel" aria-expanded="false">LogicalModel <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#actorclass">ActorClass</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#actorref">ActorRef</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#annotation">Annotation</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#annotationtype">AnnotationType</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#attribute">Attribute</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#binding">Binding</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#communicationtype">CommunicationType</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#dataclass">DataClass</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#datatype">DataType</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#enumeration">Enumeration</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#executiontype">ExecutionType</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#externalendport">ExternalEndPort</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#externaltype">ExternalType</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#inheritance">Inheritance</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#internalendport">InternalEndPort</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#layerconnection">LayerConnection</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#logicalsystem">LogicalSystem</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#operation">Operation</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#port">Port</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#primitivetype">PrimitiveType</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#protocolclass">ProtocolClass</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#relayport">RelayPort</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#replication">Replication</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#sap">SAP</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#spp">SPP</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#serviceimplementation">ServiceImplementation</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#statemachine">StateMachine</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#subsystemclass">SubSystemClass</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#subsystemref">SubSystemRef</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="feature-reference.html#mappingmodel">MappingModel</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#physicalmodel">PhysicalModel</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="feature-reference.html#modeleditors" aria-expanded="false">ModelEditors <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#graphicalbehavioreditor">GraphicalBehaviorEditor</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#graphicalstructureeditor" aria-expanded="false">GraphicalStructureEditor <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#actorrefpropertydialog">ActorRefPropertyDialog</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#portpropertydialog">PortPropertyDialog</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#spppropertydialog">SPPPropertyDialog</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#structureeditorpalette">StructureEditorPalette</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="feature-reference.html#textualroomeditor" aria-expanded="false">TextualROOMEditor <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#outlineview">OutlineView</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="feature-reference.html#codegenerators" aria-expanded="false">CodeGenerators <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#ccodegenerator" aria-expanded="false">CCodeGenerator <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="feature-reference.html#datalogging">DataLogging</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="feature-reference.html#cppcodegenerator">CPPCodeGenerator</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#generationoptions">GenerationOptions</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#javacodegenerator">JavaCodeGenerator</a></li>
+
+
+
+
+
+
+<li><a href="feature-reference.html#msclogging">MSCLogging</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="Dave-Integration.html" aria-expanded="false">Dave Integration <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="Dave-Integration.html#dave-etrice-toolchain-tutorial" aria-expanded="false">DAVE-eTrice Toolchain Tutorial <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="Dave-Integration.html#introduction">Introduction</a></li>
+
+
+
+
+
+
+<li><a href="Dave-Integration.html#getting-started-without-operating-system">Getting Started without Operating System</a></li>
+
+
+
+
+
+
+<li><a href="Dave-Integration.html#getting-started-with-freertos">Getting Started with FreeRTOS</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="ResourceRequirements.html">Resource Requirements</a></li>
+
+
+
+
+
+
+<li><a href="developers-reference.html" aria-expanded="false">Developer's Reference <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="developers-reference.html#etrice-tool-developer-s-reference" aria-expanded="false">eTrice Tool Developer’s Reference <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="developers-reference.html#architecture" aria-expanded="false">Architecture <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="developers-reference.html#editor-and-generator-components">Editor and Generator Components</a></li>
+
+
+
+
+
+
+<li><a href="developers-reference.html#the-abstract-finite-state-machine-concept">The Abstract Finite State Machine Concept</a></li>
+
+
+
+
+
+
+<li><a href="developers-reference.html#runtimes">Runtimes</a></li>
+
+
+
+
+
+
+<li><a href="developers-reference.html#unit-tests">Unit Tests</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="developers-reference.html#component-overview" aria-expanded="false">Component Overview <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="developers-reference.html#room-language-overview">Room Language Overview</a></li>
+
+
+
+
+
+
+<li><a href="developers-reference.html#config-language-overview">Config Language Overview</a></li>
+
+
+
+
+
+
+<li><a href="developers-reference.html#aggregation-layer-overview">Aggregation Layer Overview</a></li>
+
+
+
+
+
+
+<li><a href="developers-reference.html#generator-overview">Generator Overview</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
+</ul>
+</div>
+</div>
+<span class="version pull-right">version 2.x</span></p>
+<div class="col-sm-9">
+<h1><a href="#release-notes" name="release-notes"></a>Release Notes</h1>
+<p>Noteworthy release changes are described here.</p>
+<h2><a href="#2-0-0-migration" name="2-0-0-migration"></a>2.0.0 Migration</h2>
+<p><span class="label label-danger">Breaking Changes:</span> This release contains a breaking change to models used with previous versions.</p>
+<p>The name of the data for protocol messages is not longer used and is marked as deprecated. In state machines the message data is now named <code>transitionData</code>. Thus <strong>all occurrences of the message data have to be renamed</strong>. The changes to the model are depicted in the picture below:</p>
+<p><img src="images/600-TransitionDataMigration.png" alt="image"></p>
+<p>eTrice provides a <strong>migration action</strong> which automatically applies the modification to a complete model file. But it is not guaranteed to find all instances of the message data, thus it may be necessary to apply the changes manually. The migration can be triggered via editor right click and hitting <em>Migration Transition Data Style</em> action.</p>
+<p><img src="images/600-TransitionDataMigrationAssitant.png" alt="image"></p>
+<p><span class="label label-info">Note:</span> The migration assistant relies on the message data names, thus the names should not be removed until you have fully migrated your project and all dependent projects.</p>
+<br>
+<p>In addition eTrice now uses the so-called <strong>Smart Strings</strong> for user code. This is not a breaking change, but it is recommended to migrate to this new syntax also. Using the Transition Data migration action will automatically convert all affected user codes into Smart Strings. Further there is a dedicated migration action for the Smart Strings, see <em>Migrate to Smart Action Codes</em> above. Additionally there is a quickfix available:</p>
+<p><img src="images/600-DetailcodeMigration.png" alt="image"></p>
+<hr>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
+</div>
+</div>
+</div>
+
+<!-- jQuery (necessary for Bootstrap's JavaScript plugins) -->
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+<!-- Include all compiled plugins (below), or include individual files as needed -->
+<script src="js/bootstrap.min.js"></script>
+<script src="js/metisMenu.min.js"></script>
+<script src="js/prettify.js"></script>
+<script src="js/custom.js"></script>
+</body>
+</html>
diff --git a/documentation/release/room-concepts.html b/documentation/release/room-concepts.html
index 8a7373b..efeb9a6 100644
--- a/documentation/release/room-concepts.html
+++ b/documentation/release/room-concepts.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#room-concepts" name="room-concepts"></a>ROOM Concepts</h1>
<p>This chapter gives an overview over the ROOM language elements and their textual and graphical notation. The formal ROOM grammar based on Xtext (EBNF) you can find in the eTrice repository:<br><a href="http://git.eclipse.org/c/etrice/org.eclipse.etrice.git/plain/plugins/org.eclipse.etrice.core.room/src/org/eclipse/etrice/core/Room.xtext">http://git.eclipse.org/c/etrice/org.eclipse.etrice.git/plain/plugins/org.eclipse.etrice.core.room/src/org/eclipse/etrice/core/Room.xtext</a></p>
@@ -1187,21 +1203,21 @@
<pre><code class="room customHighlighted"><span class="keyword">ActorClass</span> ActorClass4 {
<span class="keyword">Behavior</span> {
<span class="comment">// no arguments, no return value
-</span> <span class="keyword">Operation</span> operation1(): <span class="keyword">void</span> <span class="string">'''
+</span> <span class="keyword">Operation</span> operation1(): <span class="keyword">void</span> '''
user code
- '''</span>
+ '''
<span class="comment">// argument of primitive type, return value of primitive type
-</span> <span class="keyword">Operation</span> operation2(Param1: int32, Param2: float64): uint16 <span class="string">'''
+</span> <span class="keyword">Operation</span> operation2(Param1: int32, Param2: float64): uint16 '''
user code
- '''</span>
+ '''
<span class="comment">// arguments and return value by value
-</span> <span class="keyword">Operation</span> operation3(Param1: int32, Param2: DataClass1): DataClass1 <span class="string">'''
+</span> <span class="keyword">Operation</span> operation3(Param1: int32, Param2: DataClass1): DataClass1 '''
user code
- '''</span>
+ '''
<span class="comment">// arguments and return value by reference except for primitive types
-</span> <span class="keyword">Operation</span> operation4(Param1: int32, Param2: DataClass1 ref): DataClass1 <span class="keyword">ref</span> <span class="string">'''
+</span> <span class="keyword">Operation</span> operation4(Param1: int32, Param2: DataClass1 ref): DataClass1 <span class="keyword">ref</span> '''
user code
- '''</span>
+ '''
}
}
</code></pre>
@@ -1219,11 +1235,11 @@
<p>Protocol classes have only textual notation. The example defines a protocol class with 2 incoming and two outgoing messages. Messages can have data attached. The data can be of a primitive type (e.g. int32, float64, …) or a data class.</p>
<pre><code class="room customHighlighted"><span class="keyword">ProtocolClass</span> ProtocolClass1 {
<span class="keyword">incoming</span> {
- <span class="keyword">Message</span> m1(data: int32}
+ <span class="keyword">Message</span> m1(int32}
<span class="keyword">Message</span> m2()
}
<span class="keyword">outgoing</span> {
- <span class="keyword">Message</span> m3(data: DataClass1}
+ <span class="keyword">Message</span> m3(DataClass1}
<span class="keyword">Message</span> m4()
}
}
@@ -1443,17 +1459,17 @@
</span> <span class="keyword">Attribute</span> attribute2: float32 <span class="comment">// attribute of another primitive type
</span>
<span class="comment">// no arguments, no return value
-</span> <span class="keyword">Operation</span> operation1(): <span class="keyword">void</span> <span class="string">'''
+</span> <span class="keyword">Operation</span> operation1(): <span class="keyword">void</span> '''
user code
- '''</span>
+ '''
<span class="comment">// argument of primitive type, no return value
-</span> <span class="keyword">Operation</span> operation2(Param1: int32): <span class="keyword">void</span> <span class="string">'''
+</span> <span class="keyword">Operation</span> operation2(Param1: int32): <span class="keyword">void</span> '''
user code
- '''</span>
+ '''
<span class="comment">// argument of primitive type, return value of primitive type
-</span> <span class="keyword">Operation</span> operation3(Param1: int32): float64 <span class="string">'''
+</span> <span class="keyword">Operation</span> operation3(Param1: int32): float64 '''
user code
- '''</span>
+ '''
}
</code></pre>
<p>Example: DataClass using other DataClasses:</p>
@@ -1462,13 +1478,13 @@
</span> <span class="keyword">Attribute</span> attribute2: DataClass1 <span class="comment">// attribute of DataClass
</span>
<span class="comment">// arguments and return value by value
-</span> <span class="keyword">Operation</span> operation1(Param1: int32, Param2: DataClass1): DataClass1 <span class="string">'''
+</span> <span class="keyword">Operation</span> operation1(Param1: int32, Param2: DataClass1): DataClass1 '''
user code
- '''</span>
+ '''
<span class="comment">// arguments and return value by reference except for primitive types
-</span> <span class="keyword">Operation</span> operation2(Param1: int32, Param2: DataClass1 ref): DataClass1 <span class="keyword">ref</span> <span class="string">'''
+</span> <span class="keyword">Operation</span> operation2(Param1: int32, Param2: DataClass1 ref): DataClass1 <span class="keyword">ref</span> '''
user code
- '''</span>
+ '''
}
</code></pre>
<h2><a href="#layering" name="layering"></a>Layering</h2>
@@ -1667,7 +1683,7 @@
<p><img src="images/040-HierarchicalFSMRunning.jpg" alt="Hierarchical finite state machine – sub state machine of <em>Running</em>"></p>
<!-- Abbreviations --->
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/standalone-generators.html b/documentation/release/standalone-generators.html
index 5107a80..1bec82a 100644
--- a/documentation/release/standalone-generators.html
+++ b/documentation/release/standalone-generators.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#standalone-generators" name="standalone-generators"></a>Standalone Generators</h1>
<p>The eTrice generators can be called from the command line. This is useful e.g. if they should participate in a build process driven by command line tools like make.</p>
@@ -1138,7 +1154,7 @@
-help # display this help text
</code></pre>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
diff --git a/documentation/release/tutorials.html b/documentation/release/tutorials.html
index 2308eab..5b3db9e 100644
--- a/documentation/release/tutorials.html
+++ b/documentation/release/tutorials.html
@@ -1076,10 +1076,26 @@
+<li><a href="release-notes.html" aria-expanded="false">Release Notes <span class="fa arrow"></span></a>
+<ul class="nav" aria-expanded="false">
+<li><a href="release-notes.html#2-0-0-migration">2.0.0 Migration</a></li>
+
+
+
+
+
+
+</ul>
+</li>
+
+
+
+
+
</ul>
</div>
</div>
-<span class="version pull-right">version 1.0</span></p>
+<span class="version pull-right">version 2.x</span></p>
<div class="col-sm-9">
<h1><a href="#tutorials" name="tutorials"></a>Tutorials</h1>
<h2><a href="#working-with-the-tutorials" name="working-with-the-tutorials"></a>Working with the tutorials</h2>
@@ -1445,7 +1461,7 @@
<h4><a href="#missing-msc" name="missing-msc"></a>Missing MSC</h4>
<p>The MSC is created when the application has been shutdown in proper form, thus has been terminated by typing <em>quit</em> in the Console of the application.<br>Depending on the Eclipse workspace settings, it might be necessary to refresh (F5) the <em>log</em> folder manually.</p>
<hr>
-<p><a href="#navbar">back to top</a> <span class="version pull-right">version 1.0</span></p>
+<p><a href="#navbar">back to top</a> <span class="version pull-right">version 2.x</span></p>
</div>
</div>
</div>
