summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormsmit <msmit@remedy.nl>2010-06-30 06:07:31 +0000
committermsmit <msmit@remedy.nl>2010-06-30 06:07:31 +0000
commite36b1a423a662e7241c92771736181bd69c0ebef (patch)
tree8880ac851ec38596c8ae66cf0eb916e63efe45bb
parentdaffbc51e8050b65c3ea384e941b5b608b3a2936 (diff)
downloadATCD-e36b1a423a662e7241c92771736181bd69c0ebef.tar.gz
Wed Jun 30 06:04:09 UTC 2010 Marcel Smit <msmit@remedy.nl>
* connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html: * connectors/dds4ccm/tutorials/Shapes/Tutorial/02_idl.html: * connectors/dds4ccm/tutorials/Shapes/Tutorial/04_dds4ccm.html: Changes after review.
-rw-r--r--CIAO/ChangeLog7
-rw-r--r--CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html17
-rw-r--r--CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/02_idl.html20
-rw-r--r--CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/04_dds4ccm.html6
4 files changed, 33 insertions, 17 deletions
diff --git a/CIAO/ChangeLog b/CIAO/ChangeLog
index 04d19b9477c..d0815d2b3bd 100644
--- a/CIAO/ChangeLog
+++ b/CIAO/ChangeLog
@@ -1,3 +1,10 @@
+Wed Jun 30 06:04:09 UTC 2010 Marcel Smit <msmit@remedy.nl>
+
+ * connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html:
+ * connectors/dds4ccm/tutorials/Shapes/Tutorial/02_idl.html:
+ * connectors/dds4ccm/tutorials/Shapes/Tutorial/04_dds4ccm.html:
+ Changes after review.
+
Tue Jun 29 17:54:23 UTC 2010 William R. Otte <wotte@dre.vanderbilt.edu>
* DAnCE/LocalityManager/Handler/LocalityActivator_Impl.h:
diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html
index d5dd94ec2a9..aa958912a90 100644
--- a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html
+++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/01_general.html
@@ -30,24 +30,31 @@
<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:
+ Since the sender and receiver are separate components, each use a DDS4CCM connector.<br/>
+ The exchanged 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>
+ Separate DDS Topics are used to represent different shapes, i.e., Circle,
+ Square, and Triangle.<br/>
+ The color field is a DDS "key" value, which causes DDS to treat each color
+ as an unique "instance" of a shape.<br/>
+ Each of these instances is registered with DDS and is independently
+ maintained in regards to Quality of Service (QoS).<br/>
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 sender registers a shape instance with DDS and transfers 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.
+ This tutorial runs in conjuntion with the RTI shapes demo, available for download from
+ http://www.rti.com/downloads/index.html .
</p>
<h2>Directory structure</h2>
diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/02_idl.html b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/02_idl.html
index fcd700fd43c..874415d57c7 100644
--- a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/02_idl.html
+++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/02_idl.html
@@ -18,13 +18,13 @@
<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
+ To understand this shapes tutorial better, the following is 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
+ Below a 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>
@@ -58,10 +58,13 @@
};<br/>
</code>
The ShapeType struct is the the data structure that is send from the
- sender to the receiver through DDS. In DDS this struct is called a sample.<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.
+ sender to the receiver through DDS. In DDS, a single instantiation
+ of this struct is called a sample.<br/>
+ This file is also used as input for the RTI DDS code generator (rtiddsgen). Since we're
+ using RTI DDS in this example, the key value for this struct is defined with
+ <code>//@key</code> as shown above. The key value indicates to DDS that
+ QoS features may apply to every unique instance of the color field
+ (e.g. a "red" square is a different instance than a "green" square).
</li>
</ul>
</p>
@@ -69,7 +72,7 @@
<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.
+ shape by invoking methods on the sender component.
These methods are part of an interface which the sender should provide. The
controller uses this interface.<br/>
The interface declaration is in
@@ -155,8 +158,7 @@
Shapes_asm/Shapes_Sender_comp/src/Shapes_Sender_comp.idl<a><br/>
</p>
<p>
- The Sender uses the DDS_Write port of the DDS4CCM connector. This means that
- the Sender is able to write data to DDS.<br/>
+ The Sender uses the DDS_Write port of the DDS4CCM connector to write data to DDS.<br/>
The Sender provides the Control_obj interface to the Controller component. This
means that the sender component implements the Control_obj interface so that the
controller is able to invoke the provided methods.
diff --git a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/04_dds4ccm.html b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/04_dds4ccm.html
index dc943287082..90647ba9719 100644
--- a/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/04_dds4ccm.html
+++ b/CIAO/connectors/dds4ccm/tutorials/Shapes/Tutorial/04_dds4ccm.html
@@ -19,9 +19,9 @@
<p>
The DDS4CCM connector itself is a CCM component placed between your component
and DDS itself.<br/>
- In DDS there're basically two entities: DataWriters and DataReaders.
- To gain access to these entities, the DDS4CCM connector offers two basic types
- of ports (connectors) : DDS_Event and DDS_State.
+ In DDS there're basically two entities which exchange data: DataWriters and
+ DataReaders. To gain access to these entities, the DDS4CCM connector offers
+ two basic types of ports (connectors) : DDS_Event and DDS_State.
These basic ports have extended ports which allow the user to access the actual
datareaders and datawriters. It'll depend on the functionality of your component
which type of basic port you're going to use.<br/>