diff options
Diffstat (limited to 'CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html')
| -rw-r--r-- | CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html | 127 |
1 files changed, 127 insertions, 0 deletions
diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html new file mode 100644 index 00000000000..f0dd8e70a50 --- /dev/null +++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html @@ -0,0 +1,127 @@ +<!--//$Id$ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <title>DDS4CCM Tutorial Shapes - General</title> +</head> + +<body> + <table width="100%" border="0"> + <tr> + <td align="left"></td> + <td align="center"><img width="4%" height="5%" src="./images/images.png"/></td> + <td align="right"><a href="./02_idl.html">Next</a></td> + </tr> + </table> + <hr /> + + <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> + In this tutorial RTI DDS is used to transfer data from the sender to the receiver. + Therefor both the sender and receiver are using a DDS4CCM connector.<br/> + The data consists of a struct with the following members: + <ul> + <li>color : represents the color of the shape.</li> + <li>x : represents the location on the x-axis.</li> + <li>y : represents the location on the y-axis</li> + <li>shapesize : represents the size of the shape.</li> + </ul> + The controller controls the location and size of the registered shape.<br/> + The only thing the sender does is registering a shape with DDS and transferring + the data received from the controller to DDS.<br/> + The receiver listens to DDS and receives the updates regarding the shapes data. + </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> + + <hr /> + <table width="100%" border="0"> + <tr> + <td align="left"></td> + <td align="center"><img width="4%" height="5%" src="./images/images.png"/></td> + <td align="right"><a href="./02_idl.html">Next</a></td> + </tr> + </table> +</body> |