[certi-cvs] certi include/RTIambServices.hh libRTI/RTIambas...

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      10/11/19 20:32:27

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

Log message:
        Enhance tick related prog. comments and doc

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/include/RTIambServices.hh?cvsroot=certi&r1=3.9&r2=3.10
http://cvs.savannah.gnu.org/viewcvs/certi/libRTI/RTIambassador.cc?cvsroot=certi&r1=3.122&r2=3.123
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/RTIA_federate.cc?cvsroot=certi&r1=3.112&r2=3.113

Patches:
Index: include/RTIambServices.hh
===================================================================
RCS file: /sources/certi/certi/include/RTIambServices.hh,v
retrieving revision 3.9
retrieving revision 3.10
diff -u -b -r3.9 -r3.10
--- include/RTIambServices.hh   11 Nov 2010 11:05:03 -0000      3.9
+++ include/RTIambServices.hh   19 Nov 2010 20:32:26 -0000      3.10
@@ -1,5 +1,5 @@
 // HLA 1.3 Header "RTIambServices.hh"
-// $Id: RTIambServices.hh,v 3.9 2010/11/11 11:05:03 erk Exp $
+// $Id: RTIambServices.hh,v 3.10 2010/11/19 20:32:26 erk Exp $
 
 typedef FederateAmbassador *FederateAmbassadorPtr ;
 
@@ -691,16 +691,53 @@
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Evoke callback (HLA1.3).
+ * Non-blocking callback evocation, returns immediately with or without 1 
callback.
+ * If CERTI has been compiled in HLA13NG_LIBRTI mode then tick
+ * may evoke 0 or multiple callbacks (may even be infinite).
+ * If CERTI has been compiled in LEGACY_LIBRTI mode then tick
+ * may evoke 0 or at most 1 callback.
+ * @return Always returns false.
+ */
 Boolean tick()
     throw (SpecifiedSaveLabelDoesNotExist, ConcurrentAccessAttempted, 
RTIinternalError);
 
+/**
+ * Blocking callback evocation (CERTI extension).
+ * Blocks until a callback delivery and then evokes a single callback.
+ * Waits until a callback delivery, be careful.
+ * @return true if additional callbacks pending, false otherwise
+ * @warning This is a non-standard extension of the HLA 1.3/IEEE-1516 API.
+ */
 Boolean tick2()
     throw (SpecifiedSaveLabelDoesNotExist, ConcurrentAccessAttempted, 
RTIinternalError);
 
-Boolean __tick_kernel(Boolean, TickTime, TickTime)
+/**
+ * Generic callback evocation (CERTI extension).
+ * Blocks up to "minimum" seconds until a callback delivery
+ * and then evokes either single (multiple==false) or
+ * multiple (multiple==true) callback(s).
+ * @param[in] multiple if false will only evoke a single callback
+ *                     if true may evoke multiple
+ * @param[in] minimum the minimum amount of time spent in the tick call.
+ * @param[in] maximum the maximum amount of time spent in the tick call.
+ * @return true if additional callbacks pending, false otherwise
+ * @warning This is a non-standard extension of the HLA 1.3/IEEE-1516 API.
+ */
+Boolean __tick_kernel(Boolean multiple, TickTime minimum, TickTime maximum)
     throw (SpecifiedSaveLabelDoesNotExist, ConcurrentAccessAttempted, 
RTIinternalError);
 
-Boolean tick(TickTime, TickTime)
+/**
+ * Evoke multiple callbacks (HLA1.3).
+ * Blocks up to "minimum" seconds until a callback delivery, then evokes
+ * multiple callbacks until no callback is pending, or until "maximum"
+ * duration is reached.
+ * @param[in] minimum the minimum amount of time spent in the tick call.
+ * @param[in] maximum the maximum amount of time spent in the tick call.
+ * @return true if additional callbacks pending, false otherwise
+ */
+Boolean tick(TickTime minimum, TickTime maximum)
     throw (SpecifiedSaveLabelDoesNotExist, ConcurrentAccessAttempted, 
RTIinternalError);
 
 /** @} end group HLA13_SupportService */
@@ -747,4 +784,4 @@
 
 
 
-// $Id: RTIambServices.hh,v 3.9 2010/11/11 11:05:03 erk Exp $
+// $Id: RTIambServices.hh,v 3.10 2010/11/19 20:32:26 erk Exp $

Index: libRTI/RTIambassador.cc
===================================================================
RCS file: /sources/certi/certi/libRTI/RTIambassador.cc,v
retrieving revision 3.122
retrieving revision 3.123
diff -u -b -r3.122 -r3.123
--- libRTI/RTIambassador.cc     11 Nov 2010 11:05:04 -0000      3.122
+++ libRTI/RTIambassador.cc     19 Nov 2010 20:32:26 -0000      3.123
@@ -19,7 +19,7 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 // USA
 //
-// $Id: RTIambassador.cc,v 3.122 2010/11/11 11:05:04 erk Exp $
+// $Id: RTIambassador.cc,v 3.123 2010/11/19 20:32:26 erk Exp $
 // ----------------------------------------------------------------------------
 
 #include "RTI.hh"
@@ -358,10 +358,6 @@
 }
 
 // ----------------------------------------------------------------------------
-//! Evoke callback (HLA1.3).
-/*! Non-blocking callback evocation, returns immediately with or without 1 
callback.
- *  @return Always returns false.
- */
 RTI::Boolean
 RTI::RTIambassador::tick()
 throw (RTI::SpecifiedSaveLabelDoesNotExist,
@@ -380,12 +376,6 @@
                }
 
 // ----------------------------------------------------------------------------
-//! Evoke callback (CERTI extension).
-/*! Blocks until a callback delivery and then evokes a single callback.
- *  Waits until a callback delivery, be careful.
- *  @return true if additional callbacks pending, false otherwise
- *  @warning This is a non-standard extension of the HLA 1.3 API.
- */
 RTI::Boolean
 RTI::RTIambassador::tick2()
 throw (RTI::SpecifiedSaveLabelDoesNotExist,
@@ -397,12 +387,6 @@
                }
 
 // ----------------------------------------------------------------------------
-//! Generic callback evocation (CERTI extension).
-/*! Blocks up to "minimum" seconds until a callback delivery and then evokes a
- *  single callback.
- *  @return true if additional callbacks pending, false otherwise
- *  @warning This is a non-standard extension of the HLA 1.3 API.
- */
 RTI::Boolean
 RTI::RTIambassador::__tick_kernel(RTI::Boolean multiple, TickTime minimum, 
TickTime maximum)
 throw (RTI::SpecifiedSaveLabelDoesNotExist,
@@ -474,12 +458,6 @@
                }
 
 // ----------------------------------------------------------------------------
-//! Evoke multiple callbacks (HLA1.3).
-/*! Blocks up to "minimum" seconds until a callback delivery, then envokes
- *  multiple callbacks until no callback is pending, or until "maximum"
- *  duration is reached.
- *  @return true if additional callbacks pending, false otherwise
- */
 RTI::Boolean
 RTI::RTIambassador::tick(TickTime minimum, TickTime maximum)
 throw (RTI::SpecifiedSaveLabelDoesNotExist, RTI::ConcurrentAccessAttempted,
@@ -2888,4 +2866,4 @@
        privateRefs->executeService(&req, &rep);
                }
 
-// $Id: RTIambassador.cc,v 3.122 2010/11/11 11:05:04 erk Exp $
+// $Id: RTIambassador.cc,v 3.123 2010/11/19 20:32:26 erk Exp $

Index: RTIA/RTIA_federate.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/RTIA_federate.cc,v
retrieving revision 3.112
retrieving revision 3.113
diff -u -b -r3.112 -r3.113