diff options
| author | msmit <msmit@remedy.nl> | 2010-06-17 11:31:01 +0000 |
|---|---|---|
| committer | msmit <msmit@remedy.nl> | 2010-06-17 11:31:01 +0000 |
| commit | b73e5686fa2387e44fc55ae469405bf393720cbb (patch) | |
| tree | 9d5ac7c8233b3b60e9f2a928c8b5e745285f246e | |
| parent | f92026a6d83661ae1579246521f01040c565fe70 (diff) | |
| download | ATCD-b73e5686fa2387e44fc55ae469405bf393720cbb.tar.gz | |
Thu Jun 17 11:27:31 UTC 2010 Marcel Smit <msmit@remedy.nl>
* connectors/dds4ccm/tutorials/Shapes/Shapes_asm/ports/Shapes_defn.idl:
Removed COLOR enum since it isn't used.
* connectors/dds4ccm/tutorials/Shapes/Tutorial/general.html:
* connectors/dds4ccm/tutorials/Shapes/Tutorial/idl.html:
* connectors/dds4ccm/tutorials/Shapes/Tutorial/images:
* connectors/dds4ccm/tutorials/Shapes/Tutorial/images/system.png:
Starter.
| -rw-r--r-- | CIAO/ChangeLog | 11 | ||||
| -rw-r--r-- | CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/ports/Shapes_defn.idl | 8 | ||||
| -rw-r--r-- | CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/general.html | 100 | ||||
| -rw-r--r-- | CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/idl.html | 92 | ||||
| -rw-r--r-- | CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/images/system.png | bin | 0 -> 14963 bytes |
5 files changed, 203 insertions, 8 deletions
diff --git a/CIAO/ChangeLog b/CIAO/ChangeLog index 322f00d1b50..d0c58270e90 100644 --- a/CIAO/ChangeLog +++ b/CIAO/ChangeLog @@ -1,3 +1,14 @@ +Thu Jun 17 11:27:31 UTC 2010 Marcel Smit <msmit@remedy.nl> + + * connectors/dds4ccm/tutorials/Shapes/Shapes_asm/ports/Shapes_defn.idl: + Removed COLOR enum since it isn't used. + + * connectors/dds4ccm/tutorials/Shapes/Tutorial/general.html: + * connectors/dds4ccm/tutorials/Shapes/Tutorial/idl.html: + * connectors/dds4ccm/tutorials/Shapes/Tutorial/images: + * connectors/dds4ccm/tutorials/Shapes/Tutorial/images/system.png: + Starter. + Thu Jun 17 11:22:27 UTC 2010 Johnny Willemsen <jwillemsen@remedy.nl> * connectors/dds4ccm/tests/CSLQoS/Sender/CSL_QoSTest_Sender_exec.cpp: diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/ports/Shapes_defn.idl b/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/ports/Shapes_defn.idl index bb47b8153b6..cb44c82cdca 100644 --- a/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/ports/Shapes_defn.idl +++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Shapes_asm/ports/Shapes_defn.idl @@ -5,14 +5,6 @@ module Shapes { - enum COLOR - { - WHITE, - RED, - YELLOW, - GREEN - }; - enum ReturnStatus { RETURN_OK, diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/general.html b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/general.html new file mode 100644 index 00000000000..8aa60136241 --- /dev/null +++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/general.html @@ -0,0 +1,100 @@ +<!--//$Id$ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <title>DDS4CCM Tutorial Shapes</title> +</head> + +<body> + <h1>General</h1> + <p> + This tutorial explains how to use a DDS4CCM connector in + combination with a CCM component.<br/> + </p> + + <h2>System</h2> + <p> + The system consists of three components: + <ul> + <li>A sender component</li> + <li>A receiver component</li> + <li>A controller component</li> + </ul> + Both the sender and receiver using a DDS4CCM connector. The controller runs a + timer and periodically sends updates regarding location and size to the sender. + </p> + <img width="60%" height="40%" src="./images/system.png" /> + <p><i><b>to-be-replaced</b></i></p> + + <p> + This tutorial runs in conjuntion with the RTI shapes demo + (see <a href="./rti_shapes.html">this page<a/> how to run the + RTI shapes demo). + </p> + + <h2>Directory structure</h2> + <p> + The following convention is used: + <ul> + <li>|--<b>*_asm</b> + : Directory contains an assembly. + </li> + <li> |--<b>ports</b> + + : Directory contains common IDL code for the assembly. + </li> + <li> |--<b>*_comp</b> + : Directory contains an component. + </li> + <li> |-- + <b>ports</b> + : Directory contains common IDL code for the component. + </li> + <li> |-- + <b>src</b> + : Directory contains the IDL and *_exec-files for the component. + </li> + </ul> + </p> + + <h2>File naming convention</h2> + <p> + The following convention is used: + <ul> + <li><b>*_defn.idl</b> - These files will contain definitions, + like enumerations, constants and so on<br/> + Typically located in *_asm/ports. + </li> + <li><b>*_msg.idl</b> - These files will contain the messages (data structure) + send by DDS.<br/> + Typically located in *_asm/ports. + </li> + <li><b>*_conn.idl</b> - These files will contain the connector + declarations.<br/> + Typically located in *_asm/ports. + </li> + <li><b>*_obj.idl</b> - These files will contain the interfaces between + components.<br/> + Typically located in *_asm/*_comp/ports. + </li> + <li><b>*_comp.idl</b> - These files will contain the component declaration.<br/> + Typically located in *_asm/*_comp/src. + </li> + </ul> + </p> + + <h2>Additional conventions</h2> + <p> + <ul> + <li>MPC files are located in the same directory as the IDL and executor + files. + </li> + <li>Files that were generated by the TOA IDL compiler or the RTI DDS gen + compiler should be located in a subdirectory. In this tutorial the name + of this subdirectory is "GeneratedCode". + </li> + </u> + </p> + <a align="right" href="./idl.html">Next</a> + +</body>
\ No newline at end of file diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/idl.html b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/idl.html new file mode 100644 index 00000000000..fa4496ee7bf --- /dev/null +++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/idl.html @@ -0,0 +1,92 @@ +<!--//$Id$ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <title>DDS4CCM Tutorial Shapes</title> +</head> + +<body> + <h1>IDL files</h1> + <p> + The IDL files are generated by the modeling tools.<br/> + To understand this shapes tutorial better, it'll give an overview of + which IDL files are generated. + </p> + + <h2>Common IDL files</h2> + <p> + Below an simplied represenation of the common IDL files. Use the links to view + the file itself.<br/> + The following IDL files can be found in Shapes_asm/ports: + <ul> + <li><a href="../Shapes_asm/ports/Shapes_defn.idl">Shapes_defn.idl<a><br/> + <code>module Shapes<br/> + {<br/> + enum ReturnStatus<br/> + {<br/> + RETURN_OK,<br/> + RETURN_ERROR<br/> + };<br/>}; + </code> + </li> + <li><a href="../Shapes_asm/ports/Shapes_conn.idl">Shapes_conn.idl<a><br/> + <code>module Shapes<br/> + {<br/> + typedef sequence<ShapeType> ShapeTypeSeq;<br/> + module ::CCM_DDS::Typed < ::ShapeType, ShapeTypeSeq> + ShapesConnector;<br/> + };<br/> + </code> + This IDL contains the declaration of the DDS4CCM connector. The used + module is typed. + </li> + <li><a href="../Shapes_asm/ports/Shapes_msg.idl">Shapes_msg.idl<a><br/> + <code>struct ShapeType {<br/> + string color; //@key<br/> + long x;<br/> + long y;<br/> + long shapesize;<br/> + };<br/> + </code> + The ShapeType struct is the the data structure that is send from the + sender to the receiver through DDS.<br/> + This file is also used as input for the RTI DDS generator. Since we're + using RTI DDS in this example, the key of this struct is defined with + <code>//@key</code> as shown above. + </li> + </ul> + </p> + + <h2>Controller IDL files</h2> + <p> + The controller is used to modify the location and the size of the registered + shape. The controller invokes methods on the sender component to establish this. + These methods are part of an interface which the sender should provide. The + controller uses this interface.<br/> + The interface declaration is in + <a href="../Shapes_asm/Shapes_Control_comp/ports/Shapes_Control_obj.idl"> + Shapes_asm/Shapes_Control_comp/ports/Shapes_Control_obj.idl<a><br/> + The IDL looks like this:<br/> + </p> + <p> + <code>module Shapes<br/> + {<br/> + interface Control_obj<br/> + {<br/> + ReturnStatus setSize (in unsigned short size);<br/> + ReturnStatus setLocation (in unsigned short x,<br/> + in unsigned short y);<br/> + };<br/> + };<br/> + </code> + The controller component periodically calls the setSize and setLocation methods + on the sender component. + </p> + <p> + The component IDL file itself is located in + <a href="../Shapes_asm/Shapes_Control_comp/src/Shapes_Control_comp.idl"> + Shapes_asm/Shapes_Control_comp/ports/Shapes_Control_comp.idl<a><br/> + and looks like this: + </p> + +</body>
\ No newline at end of file diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/images/system.png b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/images/system.png Binary files differnew file mode 100644 index 00000000000..244210cd285 --- /dev/null +++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/images/system.png |
