certi-cvs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: certi-cvs
Subject: [certi-cvs] certi include/RTIambServices.hh libRTI/RTIambas...
Date: Thu, 11 Nov 2010 11:05:04 +0000

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Eric NOULARD <erk>      10/11/11 11:05:04

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

Log message:
        Begin Standard API doc improvement

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/include/RTIambServices.hh?cvsroot=certi&r1=3.8&r2=3.9
http://cvs.savannah.gnu.org/viewcvs/certi/libRTI/RTIambassador.cc?cvsroot=certi&r1=3.121&r2=3.122

Patches:
Index: include/RTIambServices.hh
===================================================================
RCS file: /sources/certi/certi/include/RTIambServices.hh,v
retrieving revision 3.8
retrieving revision 3.9
diff -u -b -r3.8 -r3.9
--- include/RTIambServices.hh   10 Nov 2010 11:41:11 -0000      3.8
+++ include/RTIambServices.hh   11 Nov 2010 11:05:03 -0000      3.9
@@ -1,9 +1,14 @@
 // HLA 1.3 Header "RTIambServices.hh"
-// $Id: RTIambServices.hh,v 3.8 2010/11/10 11:41:11 erk Exp $
+// $Id: RTIambServices.hh,v 3.9 2010/11/11 11:05:03 erk Exp $
 
 typedef FederateAmbassador *FederateAmbassadorPtr ;
 
-// Federation Management -------------------
+
+/**
+ * @defgroup HLA13_FederationManagement Federation Management
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
 
 void createFederationExecution(const char *executionName, const char *FEDid)
     throw (FederationExecutionAlreadyExists, CouldNotOpenFED, ErrorReadingFED,
@@ -81,7 +86,13 @@
     throw (RestoreNotRequested, FederateNotExecutionMember, 
ConcurrentAccessAttempted,
           SaveInProgress, RTIinternalError);
 
-// Declaration Management -------------------
+/** @} end group HLA13_FederationManagement */
+
+/**
+ * @defgroup HLA13_DeclarationManagement Declaration Management
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
 
 void publishObjectClass(ObjectClassHandle, const AttributeHandleSet &)
     throw (ObjectClassNotDefined, AttributeNotDefined, 
OwnershipAcquisitionPending,
@@ -117,7 +128,14 @@
     throw (InteractionClassNotDefined, InteractionClassNotSubscribed, 
FederateNotExecutionMember,
           ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress, 
RTIinternalError);
 
-// Object Management -------------------
+/** @} end group HLA13_DeclarationManagement */
+
+/**
+ * @defgroup HLA13_ObjectManagement Object Management
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
+
 
 ObjectHandle registerObjectInstance(ObjectClassHandle, const char *)
     throw (ObjectClassNotDefined, ObjectClassNotPublished, 
ObjectAlreadyRegistered,
@@ -196,7 +214,13 @@
     throw (ObjectClassNotDefined, AttributeNotDefined, 
FederateNotExecutionMember,
           ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress, 
RTIinternalError);
 
-// Ownership Management -------------------
+/** @} end group HLA13_ObjectManagement */
+
+/**
+ * @defgroup HLA13_OwnershipManagement Ownership Management
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
 
 void unconditionalAttributeOwnershipDivestiture(ObjectHandle, const 
AttributeHandleSet &)
     throw (ObjectNotKnown, AttributeNotDefined, AttributeNotOwned, 
FederateNotExecutionMember,
@@ -240,7 +264,14 @@
     throw (ObjectNotKnown, AttributeNotDefined, FederateNotExecutionMember, 
ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
-// Time Management -------------------
+/** @} end group HLA13_OwnershipManagement */
+
+/**
+ * @defgroup HLA13_TimeManagement Time Management
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
+
 
 void enableTimeRegulation(const FedTime &, const FedTime &)
     throw (TimeRegulationAlreadyEnabled, EnableTimeRegulationPending, 
TimeAdvanceAlreadyInProgress,
@@ -327,7 +358,14 @@
           FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
-// Data Distribution Management -------------------
+/** @} end group HLA13_TimeManagement */
+
+/**
+ * @defgroup HLA13_DataDistributionManagement Data Distribution Management
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
+
 
 Region *createRegion(SpaceHandle, ULong)
     throw (SpaceNotDefined, InvalidExtents, FederateNotExecutionMember, 
ConcurrentAccessAttempted,
@@ -397,7 +435,13 @@
     throw (ObjectClassNotDefined, AttributeNotDefined, RegionNotKnown, 
FederateNotExecutionMember,
           ConcurrentAccessAttempted, SaveInProgress, RestoreInProgress, 
RTIinternalError);
 
-// Support Services -------------------
+/** @} end group HLA13_DataDistributionManagement */
+
+/**
+ * @defgroup HLA13_SupportService Support Service
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
 
 ObjectClassHandle getObjectClassHandle(const char *)
     throw (NameNotFound, FederateNotExecutionMember, 
ConcurrentAccessAttempted, RTIinternalError);
@@ -469,34 +513,180 @@
 char *getOrderingName(OrderingHandle)
     throw (InvalidOrderingHandle, FederateNotExecutionMember, 
ConcurrentAccessAttempted, RTIinternalError);
 
+/**
+ * Sets the ClassRelevanceAdvisory (CRA) switch to true. The switch
+ * state is hold on the RTIG side. That's why the message
+ * ENABLE_CLASS_RELEVANCE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the CRA switch is true. This causes a delivery of the
+ * federate service startRegistrationForObjectClass to a publisher
+ * if there are any new subscribers for the federates published object
+ * classes. If there are no more subscribers a publisher gets the
+ * federate service stopRegistrationForObjectClass.
+ *
+ * By disabling the CRA switch the federate is no longer informed by
+ * subscriptions to its published object classes, i.e. the federate
+ * services startRegistrationForObjectClass and
+ * stopRegistrationForObjectClass respectively are not invoked.
+ * @see disableClassRelevanceAdvisorySwitch()
+ */
 void enableClassRelevanceAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Sets the ClassRelevanceAdvisory (CRA) switch to false. The switch
+ * state is hold on the RTIG side. That's why the message
+ * DISABLE_CLASS_RELEVANCE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the CRA switch is true. This causes a delivery of the
+ * federate service startRegistrationForObjectClass to a publisher
+ * if there are any new subscribers for the federates published object
+ * classes. If there are no more subscribers a publisher gets the
+ * federate service stopRegistrationForObjectClass.
+ * @see enableClassRelevanceAdvisorySwitch()
+ *
+ * By disabling the CRA switch the federate is no longer informed by
+ * subscriptions to its published object classes, i.e. the federate
+ * services startRegistrationForObjectClass and
+ * stopRegistrationForObjectClass respectively are not invoked.
+ */
 void disableClassRelevanceAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Sets the AttributeRelevanceAdvisory (ARA) switch to true. The switch
+ * state is hold on the RTIG side. That's why the message
+ * ENABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the ARA switch is false. When enabling the ARA switch
+ * the federate is informed by the federate service
+ * turnUpdatesOnForObjectInstance of new object instances within remote
+ * federates actively subscribed to its published attributes. If there
+ * are no active subscribers for a set of instance-attributes the federate
+ * receives the federate service turnUpdatesOffForObjectInstance.
+ *
+ * By disabling the ARA switch the federate is no longer informed by
+ * subscriptions to its published attributes, i.e. the federate
+ * services turnUpdatesOnForObjectInstance and
+ * turnUpdatesOffForObjectInstance respectively are not invoked.
+ * @see disableAttributeRelevanceAdvisorySwitch()
+ */
 void enableAttributeRelevanceAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Sets the AttributeRelevanceAdvisory (ARA) switch to false. The switch
+ * state is hold on the RTIG side. That's why the message
+ * DISABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the ARA switch is false. When enabling the ARA switch
+ * the federate is informed by the federate service
+ * turnUpdatesOnForObjectInstance of new object instances within remote
+ * federates actively subscribed to its published attributes. If there
+ * are no active subscribers for a set of instance-attributes the federate
+ * receives the federate service turnUpdatesOffForObjectInstance.
+ * @see enableAttributeRelevanceAdvisorySwitch()
+ *
+ * By disabling the ARA switch the federate is no longer informed by
+ * subscriptions to its published attributes, i.e. the federate
+ * services turnUpdatesOnForObjectInstance and
+ * turnUpdatesOffForObjectInstance respectively are not invoked.
+ */
 void disableAttributeRelevanceAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Sets the AttributeScopeAdvisory (ASA) switch to true. The switch state
+ * is hold on the RTIG side. That's why the message
+ * ENABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the ASA switch is false. When enabling the ASA switch
+ * the federate is informed by the federate services
+ * attributesInScope and attributesOutScope respectively of discovered
+ * or registrated but not owned attribute-instances intersecting or
+ * leaving its subscription regions.
+ *
+ * By disabling the ASA switch the federate is no longer informed of
+ * changes in attribute-instance scope, i.e. the federate
+ * services attributesInScope and attributesOutScope respectively are
+ * not invoked.
+ * @see disableAttributeScopeAdvisorySwitch()
+ */
 void enableAttributeScopeAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Sets the AttributeScopeAdvisory (ASA) switch to false. The switch state
+ * is hold on the RTIG side. That's why the message
+ * DISABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the ASA switch is false. When enabling the ASA switch
+ * the federate is informed by the federate services
+ * attributesInScope and attributesOutScope respectively of discovered
+ * or registrated but not owned attribute-instances intersecting or
+ * leaving its subscription regions.
+ * @see enableAttributeScopeAdvisorySwitch()
+ *
+ * By disabling the ASA switch the federate is no longer informed of
+ * changes in attribute-instance scope, i.e. the federate
+ * services attributesInScope and attributesOutScope respectively are
+ * not invoked.
+ */
 void disableAttributeScopeAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Sets the InteractionRelevanceAdvisory (IRA) switch to true. The switch
+ * state is hold on the RTIG side. That's why the message
+ * ENABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the IRA switch is true. This causes a delivery of the
+ * federate service turnInteractionsOn to a publisher if there are
+ * any new subscribers for the federates published interaction
+ * classes. If there are no more subscribers a publisher gets the
+ * federate service turnInteractionsOff().
+ *
+ * By disabling the IRA switch the federate is no longer informed by
+ * subscriptions to its published interaction classes, i.e. the federate
+ * services turnInteractionsOn and turnInteractionsOff respectively are
+ * not invoked.
+ * @see disableInteractionRelevanceAdvisorySwitch()
+ */
 void enableInteractionRelevanceAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
 
+/**
+ * Sets the InteractionRelevanceAdvisory (IRA) switch to false. The switch
+ * state is hold on the RTIG side. That's why the message
+ * DISABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH
+ * is transmitted to RTIA. RTIA transmits the message towards RTIG.
+ *
+ * By default, the IRA switch is true. This causes a delivery of the
+ * federate service turnInteractionsOn to a publisher if there are
+ * any new subscribers for the federates published interaction
+ * classes. If there are no more subscribers a publisher gets the
+ * federate service turnInteractionsOff().
+ * @see enableInteractionRelevanceAdvisorySwitch()
+ *
+ * By disabling the IRA switch the federate is no longer informed by
+ * subscriptions to its published interaction classes, i.e. the federate
+ * services turnInteractionsOn and turnInteractionsOff respectively are
+ * not invoked.
+ */
 void disableInteractionRelevanceAdvisorySwitch()
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted,
           SaveInProgress, RestoreInProgress, RTIinternalError);
@@ -513,8 +703,16 @@
 Boolean tick(TickTime, TickTime)
     throw (SpecifiedSaveLabelDoesNotExist, ConcurrentAccessAttempted, 
RTIinternalError);
 
+/** @} end group HLA13_SupportService */
+
 #ifdef CERTI_REALTIME_EXTENSIONS
 /** 
+ * @defgroup CERTI_RealtimeManagement Real-time Management
+ * @ingroup  HLA13_RTI_Ambassador
+ * @{
+ */
+
+/** 
  * Set Priority for RTIA Process (CERTI Real-time extension).
  * @param priority the priority needed for RTIA process (from 0 to 99 on linux 
system)
  * @param schedPolicy the scheduling policy needed for RTIA process
@@ -531,6 +729,8 @@
  */
 void setAffinityforRTIAProcess(cpu_set_t mask)
     throw(RTIinternalError) ;
+
+/** @} end group CERTI_RealtimeManagement */
 #endif
 
 RTIambassador()
@@ -545,4 +745,6 @@
 Region *getRegion(RegionToken)
     throw (FederateNotExecutionMember, ConcurrentAccessAttempted, 
RegionNotKnown, RTIinternalError);
 
-// $Id: RTIambServices.hh,v 3.8 2010/11/10 11:41:11 erk Exp $
+
+
+// $Id: RTIambServices.hh,v 3.9 2010/11/11 11:05:03 erk Exp $

Index: libRTI/RTIambassador.cc
===================================================================
RCS file: /sources/certi/certi/libRTI/RTIambassador.cc,v
retrieving revision 3.121
retrieving revision 3.122
diff -u -b -r3.121 -r3.122
--- libRTI/RTIambassador.cc     10 Nov 2010 11:51:53 -0000      3.121
+++ libRTI/RTIambassador.cc     11 Nov 2010 11:05:04 -0000      3.122
@@ -19,7 +19,7 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 // USA
 //
-// $Id: RTIambassador.cc,v 3.121 2010/11/10 11:51:53 erk Exp $
+// $Id: RTIambassador.cc,v 3.122 2010/11/11 11:05:04 erk Exp $
 // ----------------------------------------------------------------------------
 
 #include "RTI.hh"
@@ -2810,24 +2810,6 @@
        return hla_strdup(rep.getOrderingName());
                }
 
-/**
- * Sets the ClassRelevanceAdvisory (CRA) switch to true. The switch 
- * state is hold on the RTIG side. That's why the message
- * ENABLE_CLASS_RELEVANCE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the CRA switch is true. This causes a delivery of the
- * federate service startRegistrationForObjectClass to a publisher 
- * if there are any new subscribers for the federates published object 
- * classes. If there are no more subscribers a publisher gets the 
- * federate service stopRegistrationForObjectClass.
- *
- * By disabling the CRA switch the federate is no longer informed by 
- * subscriptions to its published object classes, i.e. the federate 
- * services startRegistrationForObjectClass and 
- * stopRegistrationForObjectClass respectively are not invoked.
- * @see disableClassRelevanceAdvisorySwitch()
- */
 void
 RTI::RTIambassador::enableClassRelevanceAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
@@ -2837,25 +2819,6 @@
 
        privateRefs->executeService(&req, &rep);
                }
-
-/**
- * Sets the ClassRelevanceAdvisory (CRA) switch to false. The switch
- * state is hold on the RTIG side. That's why the message
- * DISABLE_CLASS_RELEVANCE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the CRA switch is true. This causes a delivery of the
- * federate service startRegistrationForObjectClass to a publisher 
- * if there are any new subscribers for the federates published object 
- * classes. If there are no more subscribers a publisher gets the 
- * federate service stopRegistrationForObjectClass.
- * @see enableClassRelevanceAdvisorySwitch()
- *
- * By disabling the CRA switch the federate is no longer informed by 
- * subscriptions to its published object classes, i.e. the federate 
- * services startRegistrationForObjectClass and 
- * stopRegistrationForObjectClass respectively are not invoked.
- */
 void
 RTI::RTIambassador::disableClassRelevanceAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
@@ -2866,25 +2829,6 @@
        privateRefs->executeService(&req, &rep);
                }
 
-/**
- * Sets the AttributeRelevanceAdvisory (ARA) switch to true. The switch 
- * state is hold on the RTIG side. That's why the message
- * ENABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the ARA switch is false. When enabling the ARA switch
- * the federate is informed by the federate service 
- * turnUpdatesOnForObjectInstance of new object instances within remote 
- * federates actively subscribed to its published attributes. If there
- * are no active subscribers for a set of instance-attributes the federate
- * receives the federate service turnUpdatesOffForObjectInstance. 
- *
- * By disabling the ARA switch the federate is no longer informed by 
- * subscriptions to its published attributes, i.e. the federate 
- * services turnUpdatesOnForObjectInstance and 
- * turnUpdatesOffForObjectInstance respectively are not invoked.
- * @see disableAttributeRelevanceAdvisorySwitch()
- */
 void
 RTI::RTIambassador::enableAttributeRelevanceAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
@@ -2895,25 +2839,6 @@
        privateRefs->executeService(&req, &rep);
                }
 
-/**
- * Sets the AttributeRelevanceAdvisory (ARA) switch to false. The switch 
- * state is hold on the RTIG side. That's why the message
- * DISABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the ARA switch is false. When enabling the ARA switch
- * the federate is informed by the federate service 
- * turnUpdatesOnForObjectInstance of new object instances within remote 
- * federates actively subscribed to its published attributes. If there
- * are no active subscribers for a set of instance-attributes the federate
- * receives the federate service turnUpdatesOffForObjectInstance. 
- * @see enableAttributeRelevanceAdvisorySwitch()
- *
- * By disabling the ARA switch the federate is no longer informed by 
- * subscriptions to its published attributes, i.e. the federate 
- * services turnUpdatesOnForObjectInstance and 
- * turnUpdatesOffForObjectInstance respectively are not invoked.
- */
 void
 RTI::RTIambassador::disableAttributeRelevanceAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
@@ -2924,24 +2849,6 @@
        privateRefs->executeService(&req, &rep);
                }
 
-/**
- * Sets the AttributeScopeAdvisory (ASA) switch to true. The switch state 
- * is hold on the RTIG side. That's why the message
- * ENABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the ASA switch is false. When enabling the ASA switch
- * the federate is informed by the federate services
- * attributesInScope and attributesOutScope respectively of discovered
- * or registrated but not owned attribute-instances intersecting or
- * leaving its subscription regions.
- *
- * By disabling the ASA switch the federate is no longer informed of
- * changes in attribute-instance scope, i.e. the federate 
- * services attributesInScope and attributesOutScope respectively are 
- * not invoked.
- * @see disableAttributeScopeAdvisorySwitch()
- */
 void RTI::RTIambassador::enableAttributeScopeAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
                RTI::ConcurrentAccessAttempted, RTI::FederateNotExecutionMember)
@@ -2951,24 +2858,6 @@
        privateRefs->executeService(&req, &rep);
                }
 
-/**
- * Sets the AttributeScopeAdvisory (ASA) switch to false. The switch state 
- * is hold on the RTIG side. That's why the message
- * DISABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the ASA switch is false. When enabling the ASA switch
- * the federate is informed by the federate services
- * attributesInScope and attributesOutScope respectively of discovered
- * or registrated but not owned attribute-instances intersecting or
- * leaving its subscription regions.
- * @see enableAttributeScopeAdvisorySwitch()
- *
- * By disabling the ASA switch the federate is no longer informed of
- * changes in attribute-instance scope, i.e. the federate 
- * services attributesInScope and attributesOutScope respectively are 
- * not invoked.
- */
 void
 RTI::RTIambassador::disableAttributeScopeAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
@@ -2979,24 +2868,6 @@
        privateRefs->executeService(&req, &rep);
                }
 
-/**
- * Sets the InteractionRelevanceAdvisory (IRA) switch to true. The switch 
- * state is hold on the RTIG side. That's why the message
- * ENABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the IRA switch is true. This causes a delivery of the
- * federate service turnInteractionsOn to a publisher if there are 
- * any new subscribers for the federates published interaction 
- * classes. If there are no more subscribers a publisher gets the 
- * federate service turnInteractionsOff(). 
- *
- * By disabling the IRA switch the federate is no longer informed by 
- * subscriptions to its published interaction classes, i.e. the federate 
- * services turnInteractionsOn and turnInteractionsOff respectively are 
- * not invoked.
- * @see disableInteractionRelevanceAdvisorySwitch()
- */
 void
 RTI::RTIambassador::enableInteractionRelevanceAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
@@ -3007,24 +2878,6 @@
        privateRefs->executeService(&req, &rep);
                }
 
-/**
- * Sets the InteractionRelevanceAdvisory (IRA) switch to false. The switch 
- * state is hold on the RTIG side. That's why the message
- * DISABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH 
- * is transmitted to RTIA. RTIA transmits the message towards RTIG.
- *
- * By default, the IRA switch is true. This causes a delivery of the
- * federate service turnInteractionsOn to a publisher if there are 
- * any new subscribers for the federates published interaction 
- * classes. If there are no more subscribers a publisher gets the 
- * federate service turnInteractionsOff(). 
- * @see enableInteractionRelevanceAdvisorySwitch()
- *
- * By disabling the IRA switch the federate is no longer informed by 
- * subscriptions to its published interaction classes, i.e. the federate 
- * services turnInteractionsOn and turnInteractionsOff respectively are 
- * not invoked.
- */
 void
 RTI::RTIambassador::disableInteractionRelevanceAdvisorySwitch()
 throw (RTI::RTIinternalError, RTI::RestoreInProgress, RTI::SaveInProgress,
@@ -3035,4 +2888,4 @@
        privateRefs->executeService(&req, &rep);
                }
 
-// $Id: RTIambassador.cc,v 3.121 2010/11/10 11:51:53 erk Exp $
+// $Id: RTIambassador.cc,v 3.122 2010/11/11 11:05:04 erk Exp $



reply via email to

[Prev in Thread] Current Thread [Next in Thread]