[certi-cvs] applications/PyHLA/doc PyHLA.tex omt/module.tex...

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    applications
Changes by:     Petr Gotthard <gotthardp>       08/09/26 14:12:00

Modified files:
        PyHLA/doc      : PyHLA.tex 
        PyHLA/doc/omt  : module.tex 
        PyHLA/doc/rti  : federateambassador.tex module.tex 
                         rtiambassador.tex 

Log message:
        Documentation update.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/applications/PyHLA/doc/PyHLA.tex?cvsroot=certi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/applications/PyHLA/doc/omt/module.tex?cvsroot=certi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/applications/PyHLA/doc/rti/federateambassador.tex?cvsroot=certi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/applications/PyHLA/doc/rti/module.tex?cvsroot=certi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/applications/PyHLA/doc/rti/rtiambassador.tex?cvsroot=certi&r1=1.1&r2=1.2

Patches:
Index: PyHLA.tex
===================================================================
RCS file: /sources/certi/applications/PyHLA/doc/PyHLA.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- PyHLA.tex   25 Sep 2008 17:17:27 -0000      1.1
+++ PyHLA.tex   26 Sep 2008 14:11:59 -0000      1.2
@@ -72,7 +72,6 @@
 Discuss the results.
 
 \input{rti/module}
-
 \input{omt/module}
 
 \section{High-Level API (NOT IMPLEMENTED)}
@@ -125,4 +124,4 @@
 
 \end{document}
 
-% $Id: PyHLA.tex,v 1.1 2008/09/25 17:17:27 gotthardp Exp $
+% $Id: PyHLA.tex,v 1.2 2008/09/26 14:11:59 gotthardp Exp $

Index: omt/module.tex
===================================================================
RCS file: /sources/certi/applications/PyHLA/doc/omt/module.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- omt/module.tex      25 Sep 2008 17:17:28 -0000      1.1
+++ omt/module.tex      26 Sep 2008 14:12:00 -0000      1.2
@@ -1,18 +1,43 @@
 \section{Value Encoding}
 
-This module provides
+The \module{hla.omt} module provides
 \begin{itemize}
 \item Automatic IEEE1516.2 value encoding (pack and unpack functions).
 \item Direct import of OMT DIF files.
 \end{itemize}
 
-The module functions can be imported from \module{hla.omt}.
+First, import the module functions
 \begin{verbatim}
 import hla.omt as fom
 \end{verbatim}
 
-The module defines the following basis types.
-\begin{tableiii}{l|l|l}{constant}{type}{bytes}{endian}
+Each encoding object provides the \method{pack}, \method{unpack} methods, and
+the \member{octetBoundary} property.
+
+\begin{classdesc}{HLAbasic}{}
+\begin{methoddesc}[HLAbasic]{pack}{value}
+Returns encoded value.
+\begin{verbatim}
+encodedValue = fom.HLAfloat64LE.pack(3.14)
+encodedValue += fom.HLAinteger16BE.pack(42)
+\end{verbatim}
+\end{methoddesc}
+\begin{methoddesc}[HLAbasic]{unpack}{value}
+Returns a (value, offset) tuple. The offset indicates number of consumed
+bytes, i.e. offset of the next unpack operation.
+\begin{verbatim}
+value1, offset2 = fom.HLAfloat64LE.unpack(encodedValue)
+value2, offset3 = fom.HLAinteger16BE.unpack(encodedValue[offset2:])
+print value1, value2
+\end{verbatim}
+\end{methoddesc}
+\begin{memberdesc}[int]{octetBoundary}
+Read-only property. The octet boundary (in bytes) of this data type.
+\end{memberdesc}
+\end{classdesc}
+
+The \module{hla.omt} module defines the following basic types.
+\begin{tableiii}{l|l|l}{constant}{type name}{bytes}{endian}
 \lineiii{HLAinteger16BE}{2}{Big}
 \lineiii{HLAinteger32BE}{4}{Big}
 \lineiii{HLAinteger64BE}{8}{Big}
@@ -25,8 +50,13 @@
 \lineiii{HLAfloat64LE}{8}{Little}
 \end{tableiii}
 
+Additional data types can be defined using the \class{HLAencoding},
+\class{HLAfixedArray}, \class{HLAvariableArray}, or \class{HLAfixedRecord}
+class, or imported from an OMT DIF file.
+
 \begin{funcdesc}{HLAuse}{filename}
-Imports data types from an OMT DIF file.
+Imports data types from an OMT DIF file. Format of the OMT DIF file is
+defined in IEEE 1516.2.
 
 All the RPR-FOM classes and data types will become accessible from the
 module's dictionary.
@@ -41,6 +71,9 @@
 \end{funcdesc}
 
 \begin{classdesc}{HLAencoding}{typename}
+Facilitates a forward type declaration. The typename is resolved from the
+module's dictionary once the \method{pack} or \method{unpack} method is called.
+
 \begin{verbatim}
 newType = fom.HLAencoding('WorldLocationStruct')
 \end{verbatim}
@@ -51,17 +84,26 @@
 \end{classdesc}
 
 \begin{classdesc}{HLAfixedArray}{typename, cardinality}
+Defines a fixed-length array.
+
 \begin{verbatim}
-newType = fom.HLAfixedArray(fom.WorldLocationStruct, 3)
+arrayType = fom.HLAfixedArray(fom.HLAfloat32LE, 3)
 \end{verbatim}
 is equivalent to the following OMT DIF
 \begin{verbatim}
-<arrayData name="newType"
-    encoding="HLAfixedArray" dataType="WorldLocationStruct" cardinality="3"/>
+<arrayData name="arrayType"
+    encoding="HLAfixedArray" dataType="HLAfloat32LE" cardinality="3"/>
+\end{verbatim}
+
+The \method{pack} function takes a sequence object.
+\begin{verbatim}
+encodedValue = fom.arrayType.pack([3.14, 17, 42])
 \end{verbatim}
 \end{classdesc}
 
 \begin{classdesc}{HLAvariableArray}{typename, cardinality = None}
+Defines a variable-length array.
+
 \begin{verbatim}
 newType = fom.HLAvariableArray(fom.HLAinteger16BE, None)
 \end{verbatim}
@@ -73,17 +115,24 @@
 \end{classdesc}
 
 \begin{classdesc}{HLAfixedRecord}{[(fieldName, fieldType)]}
+Defines a fixed array.
+
 \begin{verbatim}
-newType = fom.HLAfixedRecord(
-    [('X',fom.HLAinteger16BE), ('Y',fom.HLAinteger16BE)])
+recordType = fom.HLAfixedRecord(
+    [('X',fom.HLAinteger16BE), ('Y',fom.HLAfloat32BE)])
 \end{verbatim}
 is equivalent to the following OMT DIF
 \begin{verbatim}
-<fixedRecordData name="newType">
+<fixedRecordData name="recordType">
     <field name="X" dataType="HLAinteger16BE"/>
-    <field name="Y" dataType="HLAinteger16BE"/>
+    <field name="Y" dataType="HLAfloat32BE"/>
 </fixedRecordData>
 \end{verbatim}
+
+The \method{pack} function takes a mapping object.
+\begin{verbatim}
+encodedValue = fom.recordType.pack({'X':0, 'Y':3.12})
+\end{verbatim}
 \end{classdesc}
 
-% $Id: module.tex,v 1.1 2008/09/25 17:17:28 gotthardp Exp $
+% $Id: module.tex,v 1.2 2008/09/26 14:12:00 gotthardp Exp $

Index: rti/federateambassador.tex
===================================================================
RCS file: /sources/certi/applications/PyHLA/doc/rti/federateambassador.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- rti/federateambassador.tex  25 Sep 2008 17:17:28 -0000      1.1
+++ rti/federateambassador.tex  26 Sep 2008 14:12:00 -0000      1.2
@@ -1,16 +1,24 @@
-Each service defined in Clause 4 through Clause 10 of IEEE 1516.1 correspond to
-one method in the Python API. This may differ from the C++ API.
+\subsection{Federate Ambassador}
 
 \begin{classdesc}{FederateAmbassador}{}
+Template of a federate ambassador. Each federate should subclass the
+\class{FederateAmbassador} and implement some of the federate ambassador
+services.
 
-Each federate should subclass the \class{FederateAmbassador} and implement some
-of the RTI callbacks.
 \begin{verbatim}
 class MyAmbassador(hla.rti.FederateAmbassador):
     def discoverObjectInstance(self, object, objectClass, objectName):
         print "DISCOVERED", objectName
 \end{verbatim}
 
+A federate ambassador object is passed to the \method{joinFederationExecution}
+service.
+
+\begin{verbatim}
+fed = MyAmbassador()
+rtia.joinFederationExecution("python-01", "MyFederation", fed)
+\end{verbatim}
+
 \medskip
 \strong{Federation Management Services}
 
@@ -98,6 +106,13 @@
 \end{methoddesc}
 
 \begin{methoddesc}{reflectAttributeValues}{object, \{attribute:value\}, tag, 
orderType, transportType\optional{, time, eventRetraction}}
+Received attribute values are received in a dictionary. Attribute handle is 
used as key.
+The value can be unpacked using the \module{hla.omt} functions.
+\begin{verbatim}
+def reflectAttributeValues(self, object, attributes, tag, order, transport):
+    location, size = 
fom.WorldLocationStruct.unpack(attributes[self.wordLocationHandle])
+    print "REFLECT", location
+\end{verbatim}
 
 May raise
 \exception{ObjectNotKnown},
@@ -267,4 +282,4 @@
 
 \end{classdesc}
 
-% $Id: federateambassador.tex,v 1.1 2008/09/25 17:17:28 gotthardp Exp $
+% $Id: federateambassador.tex,v 1.2 2008/09/26 14:12:00 gotthardp Exp $

Index: rti/module.tex
===================================================================
RCS file: /sources/certi/applications/PyHLA/doc/rti/module.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- rti/module.tex      25 Sep 2008 17:17:29 -0000      1.1
+++ rti/module.tex      26 Sep 2008 14:12:00 -0000      1.2
@@ -1,9 +1,41 @@
-\section{Basic API}
+\section{Standard API}
 
-\subsection{RTI Ambassador}
-\input{rti/rtiambassador}
+The \module{hla.rti} module provides standard HLA services.
+Each service defined in Clause 4 through Clause 10 of IEEE 1516.1 correspond to
+one method in the Python API. This may differ from the C++ API.
+
+First, import the module functions
+\begin{verbatim}
+import hla.rti
+\end{verbatim}
+
+Each federate should subclass the \class{FederateAmbassador} and implement some
+of the federate ambassador services.
+\begin{verbatim}
+class MyAmbassador(hla.rti.FederateAmbassador):
+    def discoverObjectInstance(self, object, objectClass, objectName):
+        print "DISCOVERED", objectName
+\end{verbatim}
+
+Services of a RTI ambassador are provided by the \class{RTIAmbassador} class.
+
+\begin{verbatim}
+fed = MyAmbassador()
 
-\subsection{Federate Ambassador}
+rtia = hla.rti.RTIAmbassador()
+rtia.joinFederationExecution("python-01", "MyFederation", fed)
+...
+
+try:
+    while(1):
+        rtia.tick(1.0, 1.0)
+except KeyboardInterrupt:
+    pass
+
+rtia.resignFederationExecution()
+\end{verbatim}
+
+\input{rti/rtiambassador}
 \input{rti/federateambassador}
 
-% $Id: module.tex,v 1.1 2008/09/25 17:17:29 gotthardp Exp $
+% $Id: module.tex,v 1.2 2008/09/26 14:12:00 gotthardp Exp $

Index: rti/rtiambassador.tex
===================================================================
RCS file: /sources/certi/applications/PyHLA/doc/rti/rtiambassador.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- rti/rtiambassador.tex       25 Sep 2008 17:17:29 -0000      1.1
+++ rti/rtiambassador.tex       26 Sep 2008 14:12:00 -0000      1.2
@@ -1,11 +1,11 @@
-Each service defined in Clause 4 through Clause 10 of IEEE 1516.1 correspond to
-one method in the Python API. This may differ from the C++ API.
+\subsection{RTI Ambassador}
 
 \begin{classdesc}{RTIAmbassador}{}
+Provides RTI ambassador services.
 
 \begin{verbatim} 
 rtia = hla.rti.RTIAmbassador()
-rtia.createFederationExecution("MyFederation", "model.fed")
+rtia.joinFederationExecution("python-01", "MyFederation", fed)
 \end{verbatim}
 
 \medskip
@@ -13,6 +13,14 @@
 
 \begin{methoddesc}{createFederationExecution}{executionName, FED}
 
+\begin{verbatim} 
+try:
+    rtia.createFederationExecution("MyFederation", "model.fed")
+    print "Federation created."
+except hla.rti.FederationExecutionAlreadyExists:
+    print "Federation already exists."
+\end{verbatim}
+
 May raise
 \exception{FederationExecutionAlreadyExists},
 \exception{CouldNotOpenFED},
@@ -28,7 +36,9 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[federate]{joinFederationExecution}{yourName, executionName, 
ambassador}
+\begin{methoddesc}{joinFederationExecution}{yourName, executionName, 
ambassador}
+
+Returns a federate handle.
 
 May raise
 \exception{FederateAlreadyExecutionMember},
@@ -156,6 +166,11 @@
 
 \begin{methoddesc}{publishObjectClass}{objectClass, (attribute)}
 
+\begin{verbatim} 
+wordLocationHandle = rtia.getAttributeHandle("WorldLocation", aircraftHandle)
+rtia.publishObjectClass(aircraftHandle, [wordLocationHandle])
+\end{verbatim}
+
 May raise
 \exception{ObjectClassNotDefined},
 \exception{AttributeNotDefined},
@@ -201,6 +216,11 @@
 
 \begin{methoddesc}{subscribeObjectClassAttributes}{objectClass, (attribute), 
active=True}
 
+\begin{verbatim} 
+wordLocationHandle = rtia.getAttributeHandle("WorldLocation", aircraftHandle)
+rtia.subscribeObjectClassAttributes(aircraftHandle, [wordLocationHandle])
+\end{verbatim}
+
 May raise
 \exception{ObjectClassNotDefined},
 \exception{AttributeNotDefined},
@@ -246,7 +266,9 @@
 \medskip
 \strong{Object Management Services}
 
-\begin{methoddesc}[object]{registerObjectInstance}{objectClass\optional{, 
objectName}}
+\begin{methoddesc}{registerObjectInstance}{objectClass\optional{, objectName}}
+
+Returns an object handle.
 
 May raise
 \exception{ObjectClassNotDefined},
@@ -258,7 +280,15 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[eventRetraction]{updateAttributeValues}{object, 
\{attribute:value\}, tag\optional{, time}}
+\begin{methoddesc}{updateAttributeValues}{object, \{attribute:value\}, 
tag\optional{, time}}
+
+Returns eventRetraction handle.
+
+\begin{verbatim} 
+rtia.updateAttributeValues(thisObject,
+    {wordLocationHandle:fom.WorldLocationStruct.pack({"X":1,"Y":2,"Z":3})},
+    "update")
+\end{verbatim}
 
 May raise
 \exception{ObjectNotKnown},
@@ -271,7 +301,9 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[eventRetraction]{sendInteraction}{interactionClass, 
\{parameter:value\}, tag\optional{, time}}
+\begin{methoddesc}{sendInteraction}{interactionClass, \{parameter:value\}, 
tag\optional{, time}}
+
+Returns eventRetraction handle.
 
 May raise
 \exception{InteractionClassNotDefined},
@@ -284,7 +316,9 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[eventRetraction]{deleteObjectInstance}{object, 
tag\optional{, time}}
+\begin{methoddesc}{deleteObjectInstance}{object, tag\optional{, time}}
+
+Returns eventRetraction handle.
 
 May raise
 \exception{ObjectNotKnown},
@@ -411,7 +445,9 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[(attribute)]{attributeOwnershipReleaseResponse}{object, 
(attribute)}
+\begin{methoddesc}{attributeOwnershipReleaseResponse}{object, (attribute)}
+
+Returns a sequence of attribute handles.
 
 May raise
 \exception{ObjectNotKnown},
@@ -461,7 +497,9 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[bool]{isAttributeOwnedByFederate}{object, attribute}
+\begin{methoddesc}{isAttributeOwnedByFederate}{object, attribute}
+
+Returns True or False.
 
 May raise
 \exception{ObjectNotKnown},
@@ -695,7 +733,9 @@
 \medskip
 \strong{Data Distribution Management}
 
-\begin{methoddesc}[region]{createRegion}{space, numberOfExtents}
+\begin{methoddesc}{createRegion}{space, numberOfExtents}
+
+Returns region handle.
 
 May raise
 \exception{SpaceNotDefined},
@@ -728,7 +768,9 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[object]{registerObjectInstanceWithRegion}{objectClass, 
object, (attribute), (region)}
+\begin{methoddesc}{registerObjectInstanceWithRegion}{objectClass, object, 
(attribute), (region)}
+
+Returns object handle.
 
 May raise
 \exception{ObjectClassNotDefined},
@@ -744,7 +786,9 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[object]{registerObjectInstanceWithRegion}{objectClass, 
(attribute), (region)}
+\begin{methoddesc}{registerObjectInstanceWithRegion}{objectClass, (attribute), 
(region)}
+
+Returns object handle.
 
 May raise
 \exception{ObjectClassNotDefined},
@@ -834,7 +878,9 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[eventRetraction]{sendInteractionWithRegion}{interactionClass,
 {parameter:value}, tag, region\optional{, time}}
+\begin{methoddesc}{sendInteractionWithRegion}{interactionClass, 
{parameter:value}, tag, region\optional{, time}}
+
+Returns eventRetraction handle.
 
 May raise
 \exception{InteractionClassNotDefined},
@@ -864,7 +910,12 @@
 \medskip
 \strong{RTI Support Services}
 
-\begin{methoddesc}[objectClass]{getObjectClassHandle}{objectName}
+\begin{methoddesc}{getObjectClassHandle}{objectName}
+Returns object class handle.
+
+\begin{verbatim} 
+aircraftHandle = rtia.getObjectClassHandle("Aircraft")
+\end{verbatim}
 
 May raise
 \exception{NameNotFound},
@@ -872,7 +923,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[objectName]{getObjectClassName}{objectClass}
+\begin{methoddesc}{getObjectClassName}{objectClass}
+Returns object class name.
 
 May raise
 \exception{ObjectClassNotDefined},
@@ -880,7 +932,13 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[attribute]{getAttributeHandle}{attributeName, objectClass}
+\begin{methoddesc}{getAttributeHandle}{attributeName, objectClass}
+Returns class attribute handle.
+
+\begin{verbatim} 
+aircraftHandle = rtia.getObjectClassHandle("Aircraft")
+wordLocationHandle = rtia.getAttributeHandle("WorldLocation", aircraftHandle)
+\end{verbatim}
 
 May raise
 \exception{ObjectClassNotDefined},
@@ -889,7 +947,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[attributeName]{getAttributeName}{attribute, objectClass}
+\begin{methoddesc}{getAttributeName}{attribute, objectClass}
+Returns class attribute name.
 
 May raise
 \exception{ObjectClassNotDefined},
@@ -898,7 +957,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[interactionClass]{getInteractionClassHandle}{interactionName}
+\begin{methoddesc}{getInteractionClassHandle}{interactionName}
+Returns interaction class handle.
 
 May raise
 \exception{NameNotFound},
@@ -906,7 +966,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[interactionName]{getInteractionClassName}{interactionClass}
+\begin{methoddesc}{getInteractionClassName}{interactionClass}
+Returns interaction class name.
 
 May raise
 \exception{InteractionClassNotDefined},
@@ -914,7 +975,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[parameter]{getParameterHandle}{parameterName, 
interactionClass}
+\begin{methoddesc}{getParameterHandle}{parameterName, interactionClass}
+Returns interaction parameter handle.
 
 May raise
 \exception{InteractionClassNotDefined},
@@ -923,7 +985,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[parameterName]{getParameterName}{parameter, 
interactionClass}
+\begin{methoddesc}{getParameterName}{parameter, interactionClass}
+Returns interaction parameter name.
 
 May raise
 \exception{InteractionClassNotDefined},
@@ -932,7 +995,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[object]{getObjectInstanceHandle}{objectName}
+\begin{methoddesc}{getObjectInstanceHandle}{objectName}
+Returns object handle.
 
 May raise
 \exception{ObjectNotKnown},
@@ -940,7 +1004,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[objectName]{getObjectInstanceName}{object}
+\begin{methoddesc}{getObjectInstanceName}{object}
+Returns object name.
 
 May raise
 \exception{ObjectNotKnown},
@@ -948,7 +1013,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[space]{getRoutingSpaceHandle}{spaceName}
+\begin{methoddesc}{getRoutingSpaceHandle}{spaceName}
+Returns routing space handle.
 
 May raise
 \exception{NameNotFound},
@@ -956,7 +1022,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[spaceName]{getRoutingSpaceName}{space}
+\begin{methoddesc}{getRoutingSpaceName}{space}
+Returns routing space name.
 
 May raise
 \exception{SpaceNotDefined},
@@ -964,7 +1031,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[dimension]{getDimensionHandle}{dimensionName, space}
+\begin{methoddesc}{getDimensionHandle}{dimensionName, space}
+Returns routing space dimension handle.
 
 May raise
 \exception{SpaceNotDefined},
@@ -973,7 +1041,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[dimensionName]{getDimensionName}{dimension, space}
+\begin{methoddesc}{getDimensionName}{dimension, space}
+Returns routing space dimension name.
 
 May raise
 \exception{SpaceNotDefined},
@@ -982,7 +1051,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[space]{getAttributeRoutingSpaceHandle}{attribute, 
objectClass}
+\begin{methoddesc}{getAttributeRoutingSpaceHandle}{attribute, objectClass}
+Returns routing space handle.
 
 May raise
 \exception{ObjectClassNotDefined},
@@ -991,7 +1061,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[objectClass]{getObjectClass}{object}
+\begin{methoddesc}{getObjectClass}{object}
+Returns object class handle.
 
 May raise
 \exception{ObjectNotKnown},
@@ -999,7 +1070,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[space]{getInteractionRoutingSpaceHandle}{interactionClass}
+\begin{methoddesc}{getInteractionRoutingSpaceHandle}{interactionClass}
+Returns routing space handle.
 
 May raise
 \exception{InteractionClassNotDefined},
@@ -1007,7 +1079,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[transportation]{getTransportationHandle}{transportationName}
+\begin{methoddesc}{getTransportationHandle}{transportationName}
+Returns transportation type handle.
 
 May raise
 \exception{NameNotFound},
@@ -1015,7 +1088,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[transportationName]{getTransportationName}{transportation}
+\begin{methoddesc}{getTransportationName}{transportation}
+Returns transportation type name.
 
 May raise
 \exception{InvalidTransportationHandle},
@@ -1023,7 +1097,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[ordering]{getOrderingHandle}{orderingName}
+\begin{methoddesc}{getOrderingHandle}{orderingName}
+Returns ordering handle.
 
 May raise
 \exception{NameNotFound},
@@ -1031,7 +1106,8 @@
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[orderingName]{getOrderingName}{ordering}
+\begin{methoddesc}{getOrderingName}{ordering}
+Returns ordering name.
 
 May raise
 \exception{InvalidOrderingHandle},
@@ -1111,14 +1187,16 @@
 \exception{RestoreInProgress}.
 \end{methoddesc}
 
-\begin{methoddesc}[bool]{tick}{\optional{minimum, maximum}}
+\begin{methoddesc}{tick}{\optional{minimum, maximum}}
+Returns True or False.
 
 May raise
 \exception{SpecifiedSaveLabelDoesNotExist},
 \exception{ConcurrentAccessAttempted}.
 \end{methoddesc}
 
-\begin{methoddesc}[regionToken]{getRegionToken}{region}
+\begin{methoddesc}{getRegionToken}{region}
+Returns region token.
 
 May raise
 \exception{FederateNotExecutionMember},
@@ -1126,7 +1204,8 @@
 \exception{RegionNotKnown}.
 \end{methoddesc}
 
-\begin{methoddesc}[region]{getRegion}{regionToken}
+\begin{methoddesc}{getRegion}{regionToken}
+Returns region handle.
 
 May raise
 \exception{FederateNotExecutionMember},
@@ -1136,4 +1215,4 @@
 
 \end{classdesc}
 
-% $Id: rtiambassador.tex,v 1.1 2008/09/25 17:17:29 gotthardp Exp $
+% $Id: rtiambassador.tex,v 1.2 2008/09/26 14:12:00 gotthardp Exp $