[certi-cvs] certi libRTI/RTIambassador.cc include/RTIambSer...

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      11/01/31 11:34:53

Modified files:
        libRTI         : RTIambassador.cc 
        include        : RTIambServices.hh 

Log message:
        Update doxygen comment

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/libRTI/RTIambassador.cc?cvsroot=certi&r1=3.124&r2=3.125
http://cvs.savannah.gnu.org/viewcvs/certi/include/RTIambServices.hh?cvsroot=certi&r1=3.10&r2=3.11

Patches:
Index: libRTI/RTIambassador.cc
===================================================================
RCS file: /sources/certi/certi/libRTI/RTIambassador.cc,v
retrieving revision 3.124
retrieving revision 3.125
diff -u -b -r3.124 -r3.125
--- libRTI/RTIambassador.cc     2 Dec 2010 07:31:19 -0000       3.124
+++ libRTI/RTIambassador.cc     31 Jan 2011 11:34:53 -0000      3.125
@@ -19,7 +19,7 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 // USA
 //
-// $Id: RTIambassador.cc,v 3.124 2010/12/02 07:31:19 erk Exp $
+// $Id: RTIambassador.cc,v 3.125 2011/01/31 11:34:53 erk Exp $
 // ----------------------------------------------------------------------------
 
 #include "RTI.hh"
@@ -1065,16 +1065,6 @@
 
 // ----------------------------------------------------------------------------
 // Update Attribute Values with time
-/** Realization of the Create Federation Execution federation management 
service
-    with time (HLA 1.3).
-    Provide current values to the federation for instance attributes owned by
-    the federate.
-    Un event retraction designator is returned.
-    @param theObject     Object instance designator
-    @param theAttributes Set of attribute designator and value pairs
-    @param theTime       Federation time
-    @param theTag        User supplied tag
- */
 RTI::EventRetractionHandle
 RTI::RTIambassador::
 updateAttributeValues(ObjectHandle theObject,
@@ -1223,13 +1213,6 @@
 }
 
 // ----------------------------------------------------------------------------
-/** Delete Object with time
-    This service (HLA 1.3) deletes an object instance.
-    As the federation time argument is supplied, an event retraction 
designator is returned.
-    @param theObject Object designator
-    @param theTime Federation time
-    @param theTag user supplied tag
- */
 RTI::EventRetractionHandle
 RTI::RTIambassador::deleteObjectInstance(ObjectHandle theObject,
                const RTI::FedTime& theTime,
@@ -1262,11 +1245,6 @@
                }
 
 // ----------------------------------------------------------------------------
-/** Delete Object without time
-    This service (HLA 1.3) deletes an object instance.
-    @param theObject Object designator
-    @param theTag user supplied tag
- */
 void
 RTI::RTIambassador::deleteObjectInstance(ObjectHandle theObject,
                const char *theTag)
@@ -2872,4 +2850,4 @@
        privateRefs->executeService(&req, &rep);
                }
 
-// $Id: RTIambassador.cc,v 3.124 2010/12/02 07:31:19 erk Exp $
+// $Id: RTIambassador.cc,v 3.125 2011/01/31 11:34:53 erk Exp $

Index: include/RTIambServices.hh
===================================================================
RCS file: /sources/certi/certi/include/RTIambServices.hh,v
retrieving revision 3.10
retrieving revision 3.11
diff -u -b -r3.10 -r3.11
--- include/RTIambServices.hh   19 Nov 2010 20:32:26 -0000      3.10
+++ include/RTIambServices.hh   31 Jan 2011 11:34:53 -0000      3.11
@@ -1,5 +1,5 @@
 // HLA 1.3 Header "RTIambServices.hh"
-// $Id: RTIambServices.hh,v 3.10 2010/11/19 20:32:26 erk Exp $
+// $Id: RTIambServices.hh,v 3.11 2011/01/31 11:34:53 erk Exp $
 
 typedef FederateAmbassador *FederateAmbassadorPtr ;
 
@@ -146,6 +146,14 @@
     throw (ObjectClassNotDefined, ObjectClassNotPublished, 
FederateNotExecutionMember,
           ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress, 
RTIinternalError);
 
+/**
+ * Update Attribute Values (with time) service (HLA 1.3, §6.4).
+ * Provide current values to the federation for instance attributes owned by
+ * the federate.
+ * @param[in] object     Object instance designator
+ * @param[in] attributes Set of attribute designator and value pairs
+ * @param[in] tag        User supplied tag
+ */
 EventRetractionHandle updateAttributeValues(ObjectHandle, const 
AttributeHandleValuePairSet &,
                                            const FedTime &, const char *)
     throw (ObjectNotKnown, AttributeNotDefined, AttributeNotOwned, 
InvalidFederationTime,
@@ -153,12 +161,12 @@
           RestoreInProgress, RTIinternalError);
 
 /**
- * Realization of the Update Attribute Values (without time) service (HLA 1.3).
+ * Update Attribute Values (without time) service (HLA 1.3, §6.4).
  *  Provide current values to the federation for instance attributes owned by
  *  the federate.
- *   @param object     Object instance designator
- *   @param attributes Set of attribute designator and value pairs
- *   @param tag        User supplied tag
+ * @param[in] object     Object instance designator
+ * @param[in] attributes Set of attribute designator and value pairs
+ * @param[in] tag        User supplied tag
  */
 void updateAttributeValues(ObjectHandle object, const 
AttributeHandleValuePairSet& attributes, const char * tag)
     throw (ObjectNotKnown, AttributeNotDefined, AttributeNotOwned, 
FederateNotExecutionMember,
@@ -184,10 +192,24 @@
           FederateNotExecutionMember, ConcurrentAccessAttempted, 
SaveInProgress, RestoreInProgress,
           RTIinternalError);
 
+/**
+ * Delete Object with time
+ * This service (HLA 1.3, §6.8) deletes an object instance.
+ * As the federation time argument is supplied, an event retraction designator 
is returned.
+ * @param theObject Object designator
+ * @param theTime Federation time
+ * @param theTag user supplied tag
+ */
 EventRetractionHandle deleteObjectInstance(ObjectHandle, const FedTime &, 
const char *)
     throw (ObjectNotKnown, DeletePrivilegeNotHeld, InvalidFederationTime, 
FederateNotExecutionMember,
           ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress, 
RTIinternalError);
 
+/**
+ * Delete Object without time
+ * This service (HLA 1.3) deletes an object instance.
+ * @param theObject Object designator
+ * @param theTag user supplied tag
+ */
 void deleteObjectInstance(ObjectHandle, const char *)
     throw (ObjectNotKnown, DeletePrivilegeNotHeld, FederateNotExecutionMember,
           ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress, 
RTIinternalError);
@@ -784,4 +806,4 @@
 
 
 
-// $Id: RTIambServices.hh,v 3.10 2010/11/19 20:32:26 erk Exp $
+// $Id: RTIambServices.hh,v 3.11 2011/01/31 11:34:53 erk Exp $