Commit 9252a900 authored by Lenard Nagy's avatar Lenard Nagy
Browse files

Added information about Ports with translation capability in online help


Signed-off-by: Lenard Nagy's avatarLenard Nagy <lenard.nagy@ericsson.com>
parent 47d2c266
......@@ -11,6 +11,7 @@
Farkas, Laszlo
Feher, Csaba
Szabados, Kristof
Nagy, Lenard
-->
<HTML>
<HEAD>
......@@ -623,10 +624,41 @@ This ABNF browser was generated from file &lt;mockup_bnf.txt&gt; on Tue Jul 20 1
</TR>
<TR VALIGN=TOP>
<TD>
<P><A NAME="portdefbody"></a><A HREF="#Xref.PortDefBody">PortDefBody</A>
<P>
<A NAME="portdefbody"></A>
<A HREF="#Xref.PortDefBody">PortDefBody</A>
</P>
</TD>
<TD VALIGN=TOP>=</TD>
<TD>
<A HREF="#porttypeidentifier">PortTypeIdentifier</A>
<A HREF="#portdefattribs">PortDefAttribs</A>
[<A HREF="#portmaptoport">PortMapToPort</A>]
</TD>
</TR>
<TR>
<TD>
<P>
<A NAME="portmaptoport"></A>
<A HREF="#Xref.PortMapToPort">PortMapToPort</A>
</P>
</TD>
<TD VALIGN=TOP>=</TD>
<TD><A HREF="#porttypeidentifier">PortTypeIdentifier</A> <A HREF="#portdefattribs">PortDefAttribs</A></TD>
<TD><A HREF="#portmaptokeyword">PortMapToKeyword</A>
<A HREF="#porttypeidentifier">PortTypeIdentifier</A></TD>
</TR>
<TR VALIGN=TOP>
<TD>
<P>
<A NAME="portmaptokeyword"></A>
<A HREF="#Xref.PortMapToKeyword">PortMapToKeyword</A>
</P>
</TD>
<TD VALIGN=TOP>=</TD>
<TD>"<FONT COLOR="black">map to</FONT>"</TD>
</TR>
<TR VALIGN=TOP>
<TD></TD>
<TD></TD>
......@@ -723,10 +755,19 @@ This ABNF browser was generated from file &lt;mockup_bnf.txt&gt; on Tue Jul 20 1
</TR>
<TR VALIGN=TOP>
<TD>
<P><A NAME="typelist"></a><A HREF="#Xref.TypeList">TypeList</A>
<A NAME="typelist"></a><A HREF="#Xref.TypeList">TypeList</A>
<TD VALIGN=TOP>=</TD>
<TD><A HREF="#type">Type</A> *( "<FONT COLOR="black">,</FONT>" <A HREF="#type">Type</A> )</TD>
<TD><A HREF="#transportedtype">TransportedType</A> *( "<FONT COLOR="black">,</FONT>" <A HREF="#transportedtype">TransportedType</A> )</TD>
</TR>
<TR>
<TD>
<A NAME="transportedtype"></a><A HREF="#Xref.TransportedType">TransportedType</A>
</TD>
<TD VALIGN=TOP>=</TD>
<TD><A HREF="#type">Type</A> ([<A HREF="#tokeyword">ToKeyword</A>|<A HREF="#fromkeyword">FromKeyword</A>] <A HREF="#type">Type</A> <A HREF="#withkeyword">WithKeyword</A> <A HREF="#functionidentifier">FunctionIdentifier</A>)</TD>
</TR>
<TR VALIGN=TOP>
<TD></TD>
<TD></TD>
......@@ -6490,6 +6531,14 @@ This ABNF browser was generated from file &lt;mockup_bnf.txt&gt; on Tue Jul 20 1
<TD><A NAME="Xref.PortDefBody"></a><A HREF="#portdefbody">PortDefBody</A></TD>
<TD><A HREF="#portdef">PortDef</A></TD>
</TR>
<TR VALIGN=TOP>
<TD><A NAME="Xref.PortMapToPort"></a><A HREF="#portmaptoport">PortMapToPort</A></TD>
<TD><A HREF="#portdef">PortDef</A></TD>
</TR>
<TR VALIGN=TOP>
<TD><A NAME="Xref.PortMapToKeyword"></a><A HREF="#portmaptokeyword">PortMapToKeyword</A></TD>
<TD><A HREF="#portdef">PortDef</A></TD>
</TR>
<TR VALIGN=TOP>
<TD><A NAME="Xref.PortElement"></a><A HREF="#portelement">PortElement</A></TD>
<TD><A HREF="#portinstance">PortInstance</A>, <A HREF="#portinstance">PortInstance</A></TD>
......@@ -7242,6 +7291,10 @@ This ABNF browser was generated from file &lt;mockup_bnf.txt&gt; on Tue Jul 20 1
<TD><A NAME="Xref.TypeList"></a><A HREF="#typelist">TypeList</A></TD>
<TD><A HREF="#allortypelist">AllOrTypeList</A></TD>
</TR>
<TR VALIGN=TOP>
<TD><A NAME="Xref.TransportedType"></a><A HREF="#transportedtype">TransportedType</A></TD>
<TD><A HREF="#portdef">PortDef</A></TD>
</TR>
<TR VALIGN=TOP>
<TD><A NAME="Xref.TypeRefList"></a><A HREF="#typereflist">TypeRefList</A></TD>
<TD><A HREF="#excepttypedefspec">ExceptTypeDefSpec</A>, <A HREF="#importtypedefspec">ImportTypeDefSpec</A>, <A HREF="#alltypeswithexcept">AllTypesWithExcept</A>, <A HREF="#allref">AllRef</A></TD>
......
......@@ -10,6 +10,7 @@
Balasko, Jeno
Farkas, Laszlo
Szabados, Kristof
Nagy, Lenard
-->
<html>
<head>
......@@ -28,7 +29,7 @@
<td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
<td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
<td><a href="log.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
<td><a href="match.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
<td><a href="map_to.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
</tr>
</table>
<p><br clear="all">
......
<!--
Copyright (c) 2000-2020 Ericsson Telecom AB
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html
Contributors:
Nagy, Lenard
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-us">
<title>map to</title>
</head>
<body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
<table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
<tr>
<td width=105 height=40><a href="https://projects.eclipse.org/projects/tools.titan"><img src="../images/titan_transparent.gif" border=0 width=105 height=40 align="left" alt="Titan"></a></td>
</tr>
</table>
<table border="0" align="right" cellpadding="0" cellspacing="0">
<tr>
<td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
<td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
<td><a href="map.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
<td><a href="match.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
</tr>
</table>
<p><br clear="all">
</p>
<hr>
<h1>map to</h1>
<hr align="left" width="75%">
<p>The keyword pair is used in case of ports with translation capability mechanism to indicate the mapping of a port working in translation mode to the outwards facing (transport) port.
When a message is sent on a port with translation capability which is working in translation mode
(mapped to a port which is present in the <b><font face="Courier New">map to</font></b> clause of the port with translation capability),
message will be translated using the translation functions specified using the <b><font face="Courier New">with</font></b> keyword</p>
<p>Related keywords:</p>
<ul>
<li><a href="port.html"><b><font face="Courier New" color="#003258" size="4">port</font></b></a></li>
<li><a href="with_pwtc.html"><b><font face="Courier New" color="#003258" size="4">with</font></b></a></li>
</ul>
<hr align="left" width="50%">
<div align="center">
<center>
<table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
<tr>
<td width="100%">
<h3>type port PortTypeId message [ <font face="Courier New" color="#003258" size="5"><b>map to</b></font> { OuterPortType [ "," ] }+ ] { </br>
&ensp;( in { InnerInType [ from { OuterInType with InFunction "(" ")" [ "," ] }+ ] [ "," ] }+ |</br>
&emsp;out { InnerOutType [ to { OuterOutType with OutFunction "(" ")" [ "," ]}+ ] [ "," ] }+ |</br>
&emsp;inout { InOutType [ "," ] }+ |</br>
&emsp;address AddrType [ to { OuterAddrTypewith AddrOutFunction "(" ")" [ "," ] }+ ] }</h3>
</td>
</tr>
</table>
</center>
</div>
<hr align="left" width="50%">
<p>Example:
<p><font face="Courier New">
type port OneM2MPort message map to IPL4asp_PT {</br>
&ensp;out</br>
&ensp;&ensp;MsgOut to ASP_Send with f_enc_M2MPrimitive_to_ASPSend()</br>
&ensp;in</br>
&ensp;&ensp;MsgIn from ASP_RecvFrom with f_dec_ASPRecvFrom_to_M2MPrimitive(),</br>
&ensp;&ensp;ASP_Event</br>
}</font></p>
<p>If a MsgOut type message is being sent on the OneM2MPort
it will automatically be translated to ASP_Send type to be
sent out on the IPL4 port using f_enc_M2MPrimitive_to_ASPSend function.</br>
The same applies in the incoming direction: if an ASP_RecvFrom type message is received
on the IPL4asp_PT the f_dec_ASPRecvFrom_to_M2MPrimitive function will convert it to
MsgIn type.</br>
In this example ASP_Event is an incoming type, which will be received in OneM2MPort
unconverted, as it has no conversion function specified in this mapping.</p>
<hr align="left" width="50%">
<p><a HREF="BNF.html#mapstatement">BNF definition</a> of <font face="Courier New"> map</font></p>
</body>
</html>
......@@ -10,6 +10,7 @@
Balasko, Jeno
Farkas, Laszlo
Szabados, Kristof
Nagy, Lenard
-->
<html>
<head>
......@@ -28,7 +29,7 @@
<td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
<td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
<td><a href="while.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
<td><a href="xor.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
<td><a href="with_pwtc.html.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
</tr>
</table>
<p><br clear="all">
......
<!--
Copyright (c) 2000-2020 Ericsson Telecom AB
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html
Contributors:
Nagy, Lenard
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-us">
<title>with (PWTC)</title>
</head>
<body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
<table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
<tr>
<td width=105 height=40><a href="https://projects.eclipse.org/projects/tools.titan"><img src="../images/titan_transparent.gif" border=0 width=105 height=40 align="left" alt="Titan"></a></td>
</tr>
</table>
<table border="0" align="right" cellpadding="0" cellspacing="0">
<tr>
<td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
<td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
<td><a href="with.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
<td><a href="xor.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
</tr>
</table>
<p><br clear="all">
</p>
<hr>
<h1>with (Port with translation capabilitiy)</h1>
<hr align="left" width="75%">
<p>
The function identifyer after the with keyword specifies the translation function which converts the types of the inner and outer ports.
</p>
<p>Related keywords:</p>
<ul>
<li><a href="port.html"><b><font face="Courier New" color="#003258" size="4">port</font></b></a></li>
<li><a href="map_to.html"><b><font face="Courier New" color="#003258" size="4">map to</font></b></a></li>
</ul>
<hr align="left" width="50%">
<div align="center">
<center>
<table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
<tr>
<td width="100%">
<h3>type port PortTypeId message [ map to { OuterPortType [ "," ] }+ ] { </br>
&ensp;( in { InnerInType [ from { OuterInType <font face="Courier New" color="#003258" size="5"><b>with</b></font> InFunction "(" ")" [ "," ] }+ ] [ "," ] }+ |</br>
&emsp;out { InnerOutType [ to { OuterOutType <font face="Courier New" color="#003258" size="5"><b>with</b></font> OutFunction "(" ")" [ "," ]}+ ] [ "," ] }+ |</br>
&emsp;inout { InOutType [ "," ] }+ |</br>
&emsp;address AddrType [ to { OuterAddrTypewith AddrOutFunction "(" ")" [ "," ] }+ ] }</h3>
</td>
</tr>
</table>
</center>
</div>
<ul>
<li>
<p>the <b><font face="Courier New">InFunction</font></b> will convert the outgoing <b><font face="Courier New">InnerOutType</font></b> to <b><font face="Courier New">OuterOutType</font></b> before sending it out on the OuterPortType</p>
</li>
<li>
<p>the <b><font face="Courier New">InFunction</font></b> will convert the incoming <b><font face="Courier New">OuterInType</font></b> to <b><font face="Courier New">InnerInType</font></b> after receiving it on the OuterPortType </p>
</li>
</ul>
<hr align="left" width="50%">
<p>Example:
<p><font face="Courier New">
type port OneM2MPort message map to IPL4asp_PT {</br>
&ensp;out</br>
&ensp;&ensp;MsgOut to ASP_Send with f_enc_M2MPrimitive_to_ASPSend()</br>
&ensp;in</br>
&ensp;&ensp;MsgIn from ASP_RecvFrom with f_dec_ASPRecvFrom_to_M2MPrimitive(),</br>
&ensp;&ensp;ASP_Event</br>
}</font></p>
<p>If a MsgOut type message is being sent on the OneM2MPort
it will automatically be translated to ASP_Send type to be
sent out on the IPL4 port using f_enc_M2MPrimitive_to_ASPSend function.</br>
The same applies in the incoming direction: if an ASP_RecvFrom type message is received
on the IPL4asp_PT the f_dec_ASPRecvFrom_to_M2MPrimitive function will convert it to
MsgIn type.</br>
In this example ASP_Event is an incoming type, which will be received in OneM2MPort
unconverted, as it has no conversion function specified in this mapping.</p>
</p>
<hr align="left" width="50%">
<p>
<a HREF="BNF.html#transportedtype">BNF definition</a> of <font face="Courier New"> with (PWTC)</font></p>
</body>
</html>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment