Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/org.eclipse.etrice.doc/targets/eclipse-help')
-rw-r--r--plugins/org.eclipse.etrice.doc/targets/eclipse-help/developers-reference.html2
-rw-r--r--plugins/org.eclipse.etrice.doc/targets/eclipse-help/etrice-doc.html9
-rw-r--r--plugins/org.eclipse.etrice.doc/targets/eclipse-help/feature-reference.html77
-rw-r--r--plugins/org.eclipse.etrice.doc/targets/eclipse-help/toc-topics.xml.html1
4 files changed, 86 insertions, 3 deletions
diff --git a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/developers-reference.html b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/developers-reference.html
index 277378db5..56844b550 100644
--- a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/developers-reference.html
+++ b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/developers-reference.html
@@ -233,8 +233,6 @@
<li>
<p>the default <code>multiplicity</code> of the <code>ActorRef</code> is set to 1</p></li>
<li>
- <p>an operation <code>getGeneralProtocol</code> is added to the <code>InterfaceItem</code></p></li>
- <li>
<p>an operation <code>getSemantics</code> is added to the <code>InterfaceItem</code></p></li>
<li>
<p>an operation <code>getAllIncomingAbstractMessages</code> is added to the <code>InterfaceItem</code></p></li>
diff --git a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/etrice-doc.html b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/etrice-doc.html
index 1e1b73720..3d99b4f7a 100644
--- a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/etrice-doc.html
+++ b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/etrice-doc.html
@@ -934,6 +934,15 @@
+<li><a href="feature-reference.html#portclass">PortClass</a></li>
+
+
+
+
+
+
+
+
<li><a href="feature-reference.html#primitivetype">PrimitiveType</a></li>
diff --git a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/feature-reference.html b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/feature-reference.html
index aaaa65316..9e6f5cbf7 100644
--- a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/feature-reference.html
+++ b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/feature-reference.html
@@ -1517,6 +1517,77 @@
</tbody>
</table>
<hr>
+<h3><a href="#portclass" name="portclass"></a>PortClass</h3>
+<p>A PortClass allows a specifc implementation of a port class of a protocol</p>
+<p><em>This is an advanced feature which is highly target language specific.</em></p>
+<p>A ProtocolClass may define a port class which can be used to intercept messages within a port either on the sending or on the receiving side. On the sending side the messages are intercepted before they are passed to the message service. On the receiving side they are intercepted before they are passed to the receiving actor.</p>
+<p>A PortClass is always either <em>regular</em>, i.e. it “lives” within a regular port, or <em>conjugated</em>. A PortClass may define local attributes, operations and/or handlers for incoming or outgoing messages. The message direction of handlers in PortClasses always matches the message direction of the ProtocolClass. It is not switched for the <em>conjugated</em> PortClass. Whether a message is passed from the message service into the handler and has to be forwarded to the actor or vise versa depends on the type of the PortClass (*regular*, <em>conjugated</em>) and the message direction in the ProtocolClass.</p>
+<table style="vertical-align: middle;" class="table">
+<thead>
+<tr>
+ <th colspan="3">Feature Usage</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+ <td rowspan="1" style="white-space: nowrap;"><p>Is contained in:</p></td>
+ <td><p><a href="#protocolclass">ProtocolClass</a></p></td>
+ <td><p>A ProtocolClass defines messages and is the interface specification for a Port</p></td>
+</tr>
+</tbody>
+</table>
+<p><strong>Example</strong>:</p>
+<pre><code class="room customHighlighted"><span class="comment">// This example uses the port class interface provided by the c code generator
+</span><span class="keyword">ProtocolClass</span> PingPong {
+ <span class="keyword">incoming</span> {
+ <span class="keyword">Message</span> ping(uint8)
+ }
+ <span class="keyword">outgoing</span> {
+ <span class="keyword">Message</span> pong(uint8)
+ }
+ <span class="keyword">regular</span> <span class="keyword">PortClass</span> {
+ <span class="keyword">handle</span> <span class="keyword">incoming</span> ping <span class="string">'''
+ uint8 msgDataOffset = MEM_CEIL(sizeof(etMessage));
+ uint8 transitionData = (uint8)((char*)msg + msgDataOffset);;
+
+ // do something here
+
+ /* hand over the message to the actor: */
+ (*receiveMessageFunc)(actor, self, msg);
+ '''</span>
+ <span class="keyword">handle</span> <span class="keyword">outgoing</span> pong <span class="string">'''
+ uint8 transitionData = data__et;
+
+ // do something with the data here
+
+ // hand over data to message service
+ etPort_sendMessage(self, PingPong_OUT_pong, sizeof(uint8), &amp;transitionData);
+ '''</span>
+ }
+ <span class="keyword">conjugated</span> <span class="keyword">PortClass</span> {
+ <span class="keyword">handle</span> <span class="keyword">incoming</span> ping <span class="string">'''
+ // The ping message is outgoing in the conjugated portclass
+ uint8 transitionData = data__et;
+
+ // do something with the data here
+
+ // hand over data to message service
+ etPort_sendMessage(self, PingPong_IN_ping, sizeof(uint8), &amp;transitionData);
+ '''</span>
+ <span class="keyword">handle</span> <span class="keyword">outgoing</span> pong <span class="string">'''
+ // The pong message is incoming in the conjugated portclass
+ uint8 msgDataOffset = MEM_CEIL(sizeof(etMessage));
+ uint8 transitionData = (uint8)((char*)msg + msgDataOffset);;
+
+ // do something here
+
+ /* hand over the message to the actor: */
+ (*receiveMessageFunc)(actor, self, msg);
+ '''</span>
+ }
+}
+</code></pre>
+<hr>
<h3><a href="#primitivetype" name="primitivetype"></a>PrimitiveType</h3>
<p>A PrimitiveType is an abstraction of a target language’s basic type (e.g. integer or boolean)</p>
<table style="vertical-align: middle;" class="table">
@@ -1575,7 +1646,7 @@
</thead>
<tbody>
<tr>
- <td rowspan="4" style="white-space: nowrap;"><p>Contains:</p></td>
+ <td rowspan="5" style="white-space: nowrap;"><p>Contains:</p></td>
<td><p><a href="#communicationtype">CommunicationType</a></p></td>
<td><p>The CommunicationType defines the communication semantics of a ProtocolClass</p></td>
</tr>
@@ -1592,6 +1663,10 @@
<td><p>An Annotation can be attached to a ROOM class to specify the properties of its AnnotationType</p></td>
</tr>
<tr>
+ <td><p><a href="#portclass">PortClass</a></p></td>
+ <td><p>A PortClass allows a specifc implementation of a port class of a protocol</p></td>
+</tr>
+<tr>
<td rowspan="1" style="white-space: nowrap;"><p>Uses:</p></td>
<td><p><a href="#inheritance">Inheritance</a></p></td>
<td><p>A class can specify a single super class and inherits elements from the super class hierarchy</p></td>
diff --git a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/toc-topics.xml.html b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/toc-topics.xml.html
index b7916c604..ae468bda0 100644
--- a/plugins/org.eclipse.etrice.doc/targets/eclipse-help/toc-topics.xml.html
+++ b/plugins/org.eclipse.etrice.doc/targets/eclipse-help/toc-topics.xml.html
@@ -117,6 +117,7 @@
</topic><topic href="targets/eclipse-help/feature-reference.html#logicalsystem" label="LogicalSystem">
</topic><topic href="targets/eclipse-help/feature-reference.html#operation" label="Operation">
</topic><topic href="targets/eclipse-help/feature-reference.html#port" label="Port">
+</topic><topic href="targets/eclipse-help/feature-reference.html#portclass" label="PortClass">
</topic><topic href="targets/eclipse-help/feature-reference.html#primitivetype" label="PrimitiveType">
</topic><topic href="targets/eclipse-help/feature-reference.html#protocolclass" label="ProtocolClass">
</topic><topic href="targets/eclipse-help/feature-reference.html#refinedstate" label="RefinedState">

Back to the top