[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[certi-cvs] certi RTIA/DeclarationManagement.cc RTIA/Object...
|
From: |
certi-cvs |
|
Subject: |
[certi-cvs] certi RTIA/DeclarationManagement.cc RTIA/Object... |
|
Date: |
Fri, 21 Nov 2008 12:45:26 +0000 |
CVSROOT: /sources/certi
Module name: certi
Changes by: Christian Stenzel <approx> 08/11/21 12:45:25
Modified files:
RTIA : DeclarationManagement.cc ObjectManagement.cc
RTIA_federate.cc
RTIG : Federate.hh
libCERTI : Message_R.cc Message_W.cc
libRTI : RTIambassador.cc
Log message:
some doxygen comments added
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/DeclarationManagement.cc?cvsroot=certi&r1=3.23&r2=3.24
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/ObjectManagement.cc?cvsroot=certi&r1=3.57&r2=3.58
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/RTIA_federate.cc?cvsroot=certi&r1=3.94&r2=3.95
http://cvs.savannah.gnu.org/viewcvs/certi/RTIG/Federate.hh?cvsroot=certi&r1=3.12&r2=3.13
http://cvs.savannah.gnu.org/viewcvs/certi/libCERTI/Message_R.cc?cvsroot=certi&r1=3.33&r2=3.34
http://cvs.savannah.gnu.org/viewcvs/certi/libCERTI/Message_W.cc?cvsroot=certi&r1=3.38&r2=3.39
http://cvs.savannah.gnu.org/viewcvs/certi/libRTI/RTIambassador.cc?cvsroot=certi&r1=3.98&r2=3.99
Patches:
Index: RTIA/DeclarationManagement.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/DeclarationManagement.cc,v
retrieving revision 3.23
retrieving revision 3.24
diff -u -b -r3.23 -r3.24
--- RTIA/DeclarationManagement.cc 20 Nov 2008 18:21:55 -0000 3.23
+++ RTIA/DeclarationManagement.cc 21 Nov 2008 12:45:24 -0000 3.24
@@ -18,7 +18,7 @@
// along with this program ; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
-// $Id: DeclarationManagement.cc,v 3.23 2008/11/20 18:21:55 approx Exp $
+// $Id: DeclarationManagement.cc,v 3.24 2008/11/21 12:45:24 approx Exp $
// ----------------------------------------------------------------------------
#include <config.h>
@@ -356,8 +356,15 @@
e = rep->exception ;
} /* end of unsubscribeInteractionClass */
-// ----------------------------------------------------------------------------
-// setClassRelevanceAdvisorySwitch
+/**
+ * This methods transmits the Networkmessage
+ * NM_Set_Class_Relevance_Advisory_Switch to RTIG. The transmission sets the
+ * ClassRelevanceAdvisory switch at RTIG side to the value of the input
+ * parameter state. The invocation is caused by a successfull transmission of
+ * the message ENABLE_CLASS_RELEVANCE_ADVISORY_SWITCH from the federate to
RTIA.
+ * @param state is a boolean [true, false]
+ * @param e is a reference to a possible exception
+ */
void
DeclarationManagement::
setClassRelevanceAdvisorySwitch(bool state, TypeException &e) {
@@ -440,8 +447,16 @@
e = rep.getExceptionType();
}
-// ----------------------------------------------------------------------------
-// setInteractionRelevanceAdvisorySwitch
+/**
+ * This methods transmits the Networkmessage
+ * NM_Set_Interaction_Relevance_Advisory_Switch to RTIG. The transmission sets
the
+ * InteractionRelevanceAdvisory switch at RTIG side to the value of the input
+ * parameter state. The invocation is caused by a successfull transmission of
+ * the message ENABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH from the federate
to
+ * RTIA.
+ * @param state is a boolean [true, false]
+ * @param e is a reference to a possible exception
+ */
void
DeclarationManagement::
setInteractionRelevanceAdvisorySwitch(bool state, TypeException &e) {
@@ -513,4 +528,4 @@
}} // namespace certi/rtia
-// $Id: DeclarationManagement.cc,v 3.23 2008/11/20 18:21:55 approx Exp $
+// $Id: DeclarationManagement.cc,v 3.24 2008/11/21 12:45:24 approx Exp $
Index: RTIA/ObjectManagement.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/ObjectManagement.cc,v
retrieving revision 3.57
retrieving revision 3.58
diff -u -b -r3.57 -r3.58
--- RTIA/ObjectManagement.cc 20 Nov 2008 18:21:55 -0000 3.57
+++ RTIA/ObjectManagement.cc 21 Nov 2008 12:45:24 -0000 3.58
@@ -897,9 +897,15 @@
throw InvalidOrderingHandle("");
}
-// --------------------------------------
-// setAttributeScopeAdvisorySwitch
-// --------------------------------------
+/**
+ * This methods transmits the Networkmessage
+ * NM_Set_Attribute_Scope_Advisory_Switch to RTIG. The transmission sets the
+ * AttributeScopeAdvisory switch at RTIG side to the value of the input
+ * parameter state. The invocation is caused by a successfull transmission of
+ * the message ENABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH from the federate to
RTIA.
+ * @param state is a boolean [true, false]
+ * @param e is a reference to a possible exception
+ */
void
ObjectManagement::
setAttributeScopeAdvisorySwitch(bool state, TypeException &e) {
@@ -977,9 +983,16 @@
G.Out(pdGendoc,"exit ObjectManagement::attributesOutScope");
}
-// --------------------------------------
-// setAttributeRelevanceAdvisorySwitch
-// --------------------------------------
+/**
+ * This methods transmits the Networkmessage
+ * NM_Set_Attribute_Relevance_Advisory_Switch to RTIG. The transmission sets
the
+ * AttributeRelevanceAdvisory switch at RTIG side to the value of the input
+ * parameter state. The invocation is caused by a successfull transmission of
+ * the message ENABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH from the federate to
+ * RTIA.
+ * @param state is a boolean [true, false]
+ * @param e is a reference to a possible exception
+ */
void
ObjectManagement::
setAttributeRelevanceAdvisorySwitch(bool state, TypeException &e) {
Index: RTIA/RTIA_federate.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/RTIA_federate.cc,v
retrieving revision 3.94
retrieving revision 3.95
diff -u -b -r3.94 -r3.95
--- RTIA/RTIA_federate.cc 6 Nov 2008 14:28:58 -0000 3.94
+++ RTIA/RTIA_federate.cc 21 Nov 2008 12:45:24 -0000 3.95
@@ -1040,49 +1040,49 @@
case Message::ENABLE_CLASS_RELEVANCE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
EnableClassRelevanceAdvisorySwitch.");
- dm->setClassRelevanceAdvisorySwitch(req->getBoolean(), e);
+ dm->setClassRelevanceAdvisorySwitch(true, e);
break;
case Message::DISABLE_CLASS_RELEVANCE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
DisableClassRelevanceAdvisorySwitch.");
- dm->setClassRelevanceAdvisorySwitch(req->getBoolean(), e);
+ dm->setClassRelevanceAdvisorySwitch(false, e);
break;
case Message::ENABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
SetInteractionRelevanceAdvisorySwitch.");
- dm->setInteractionRelevanceAdvisorySwitch(req->getBoolean(), e);
+ dm->setInteractionRelevanceAdvisorySwitch(true, e);
break;
case Message::DISABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
SetInteractionRelevanceAdvisorySwitch.");
- dm->setInteractionRelevanceAdvisorySwitch(req->getBoolean(), e);
+ dm->setInteractionRelevanceAdvisorySwitch(false, e);
break;
case Message::ENABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
SetAttributeRelevanceAdvisorySwitch.");
- om->setAttributeRelevanceAdvisorySwitch(req->getBoolean(), e);
+ om->setAttributeRelevanceAdvisorySwitch(true, e);
break;
case Message::DISABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
SetAttributeRelevanceAdvisorySwitch.");
- om->setAttributeRelevanceAdvisorySwitch(req->getBoolean(), e);
+ om->setAttributeRelevanceAdvisorySwitch(false, e);
break;
case Message::ENABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
SetAttributeScopeAdvisorySwitch.");
- om->setAttributeScopeAdvisorySwitch(req->getBoolean(), e);
+ om->setAttributeScopeAdvisorySwitch(true, e);
break;
case Message::DISABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH:
D.Out(pdTrace,
"Receiving Message from Federate, type
SetAttributeScopeAdvisorySwitch.");
- om->setAttributeScopeAdvisorySwitch(req->getBoolean(), e);
+ om->setAttributeScopeAdvisorySwitch(false, e);
break;
default:
Index: RTIG/Federate.hh
===================================================================
RCS file: /sources/certi/certi/RTIG/Federate.hh,v
retrieving revision 3.12
retrieving revision 3.13
diff -u -b -r3.12 -r3.13
--- RTIG/Federate.hh 20 Nov 2008 18:21:55 -0000 3.12
+++ RTIG/Federate.hh 21 Nov 2008 12:45:25 -0000 3.13
@@ -16,7 +16,7 @@
// along with this program ; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
-// $Id: Federate.hh,v 3.12 2008/11/20 18:21:55 approx Exp $
+// $Id: Federate.hh,v 3.13 2008/11/21 12:45:25 approx Exp $
// ----------------------------------------------------------------------------
#ifndef CERTI_RTIG_FEDERATE_HH
@@ -46,14 +46,68 @@
void setConstrained(bool c) { constrained = c ; };
void setRegulator(bool r) { regulator = r ; };
+ /**
+ * This method sets the ClassRelevanceAdvisorySwitch of the federate
+ * to the value of the input parameter val. The CRA switch is enabled
+ * by default.
+ * @param val is a boolean [true, false]
+ * @return void
+ */
void setClassRelevanceAdvisorySwitch(bool val) { cras = val ; };
+
+ /**
+ * This method sets the InteractionRelevanceAdvisorySwitch of the federate
+ * to the value of the input parameter val. The IRA switch is enabled
+ * by default.
+ * @param val is a boolean [true, false]
+ * @return void
+ */
void setInteractionRelevanceAdvisorySwitch(bool val) { iras = val ; };
+
+ /**
+ * This method sets the AttributeRelevanceAdvisorySwitch of the federate
+ * to the value of the input parameter val. The ARA switch is disabled
+ * by default.
+ * @param val is a boolean [true, false]
+ * @return void
+ */
void setAttributeRelevanceAdvisorySwitch(bool val) { aras = val ; };
+
+ /**
+ * This method sets the AttributeScopeAdvisorySwitch of the federate
+ * to the value of the input parameter val. The ASA switch is disabled
+ * by default.
+ * @param val is a boolean [true, false]
+ * @return void
+ */
void setAttributeScopeAdvisorySwitch(bool val) { asas = val ; };
+ /**
+ * This method returns the current state of the
+ * ClassRelevanceAdvisory switch.
+ * @return a boolean indicating the current state of the switch
+ */
bool isClassRelevanceAdvisorySwitch() const { return cras ; };
+
+ /**
+ * This method returns the current state of the
+ * InteractionRelevanceAdvisory switch.
+ * @return a boolean indicating the current state of the switch
+ */
bool isInteractionRelevanceAdvisorySwitch() const { return iras ; };
+
+ /**
+ * This method returns the current state of the
+ * AttributeRelevanceAdvisory switch.
+ * @return a boolean indicating the current state of the switch
+ */
bool isAttributeRelevanceAdvisorySwitch() const { return aras ; };
+
+ /**
+ * This method returns the current state of the
+ * AttributeScopeAdvisory switch.
+ * @return a boolean indicating the current state of the switch
+ */
bool isAttributeScopeAdvisorySwitch() const { return asas ; };
bool isSaving() const { return saving ; };
@@ -90,4 +144,4 @@
#endif // CERTI_RTIG_FEDERATE_HH
-// $Id: Federate.hh,v 3.12 2008/11/20 18:21:55 approx Exp $
+// $Id: Federate.hh,v 3.13 2008/11/21 12:45:25 approx Exp $
Index: libCERTI/Message_R.cc
===================================================================
RCS file: /sources/certi/certi/libCERTI/Message_R.cc,v
retrieving revision 3.33
retrieving revision 3.34
diff -u -b -r3.33 -r3.34
--- libCERTI/Message_R.cc 10 Oct 2008 15:18:22 -0000 3.33
+++ libCERTI/Message_R.cc 21 Nov 2008 12:45:25 -0000 3.34
@@ -17,7 +17,7 @@
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
//
-// $Id: Message_R.cc,v 3.33 2008/10/10 15:18:22 gotthardp Exp $
+// $Id: Message_R.cc,v 3.34 2008/11/21 12:45:25 approx Exp $
// ----------------------------------------------------------------------------
@@ -490,7 +490,6 @@
case DISABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH:
case ENABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH:
case DISABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH:
- boolean = msgBuffer.read_bool();
break;
// Body contains boolean, TickTime, TickTime
@@ -650,4 +649,4 @@
} // namespace certi
-// $Id: Message_R.cc,v 3.33 2008/10/10 15:18:22 gotthardp Exp $
+// $Id: Message_R.cc,v 3.34 2008/11/21 12:45:25 approx Exp $
Index: libCERTI/Message_W.cc
===================================================================
RCS file: /sources/certi/certi/libCERTI/Message_W.cc,v
retrieving revision 3.38
retrieving revision 3.39
diff -u -b -r3.38 -r3.39
--- libCERTI/Message_W.cc 10 Oct 2008 15:18:22 -0000 3.38
+++ libCERTI/Message_W.cc 21 Nov 2008 12:45:25 -0000 3.39
@@ -17,7 +17,7 @@
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
//
-// $Id: Message_W.cc,v 3.38 2008/10/10 15:18:22 gotthardp Exp $
+// $Id: Message_W.cc,v 3.39 2008/11/21 12:45:25 approx Exp $
// ----------------------------------------------------------------------------
@@ -506,7 +506,6 @@
case DISABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH:
case ENABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH:
case DISABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH:
- msgBuffer.write_bool(boolean);
break;
// Body contains boolean, TickTime, TickTime
@@ -610,4 +609,4 @@
} // namespace certi
-// $Id: Message_W.cc,v 3.38 2008/10/10 15:18:22 gotthardp Exp $
+// $Id: Message_W.cc,v 3.39 2008/11/21 12:45:25 approx Exp $
Index: libRTI/RTIambassador.cc
===================================================================
RCS file: /sources/certi/certi/libRTI/RTIambassador.cc,v
retrieving revision 3.98
retrieving revision 3.99
diff -u -b -r3.98 -r3.99
--- libRTI/RTIambassador.cc 20 Nov 2008 18:21:57 -0000 3.98
+++ libRTI/RTIambassador.cc 21 Nov 2008 12:45:25 -0000 3.99
@@ -19,7 +19,7 @@
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
//
-// $Id: RTIambassador.cc,v 3.98 2008/11/20 18:21:57 approx Exp $
+// $Id: RTIambassador.cc,v 3.99 2008/11/21 12:45:25 approx Exp $
// ----------------------------------------------------------------------------
@@ -2723,8 +2723,24 @@
return hla_strdup(rep.getName());
}
-// ----------------------------------------------------------------------------
-// Enable Class Relevance Advisory Switch
+/**
+ * This service 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,
@@ -2733,12 +2749,27 @@
Message req, rep ;
req.type = Message::ENABLE_CLASS_RELEVANCE_ADVISORY_SWITCH ;
- req.setBoolean(true);
privateRefs->executeService(&req, &rep);
}
-// ----------------------------------------------------------------------------
-// Disable Class Relevance Advisory Switch
+/**
+ * This service 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,
@@ -2747,12 +2778,28 @@
Message req, rep ;
req.type = Message::DISABLE_CLASS_RELEVANCE_ADVISORY_SWITCH ;
- req.setBoolean(false);
privateRefs->executeService(&req, &rep);
}
-// ----------------------------------------------------------------------------
-// Enable Attribute Relevance Advisory Switch
+/**
+ * This service 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,
@@ -2761,12 +2808,28 @@
Message req, rep ;
req.type = Message::ENABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH ;
- req.setBoolean(true);
privateRefs->executeService(&req, &rep);
}
-// ----------------------------------------------------------------------------
-// Disable Attribute Relevance Advisory Switch
+/**
+ * This service 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,
@@ -2775,12 +2838,27 @@
Message req, rep ;
req.type = Message::DISABLE_ATTRIBUTE_RELEVANCE_ADVISORY_SWITCH ;
- req.setBoolean(false);
privateRefs->executeService(&req, &rep);
}
-// ----------------------------------------------------------------------------
-// Enable Attribute Scope Advisory Switch
+/**
+ * This service 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)
@@ -2788,12 +2866,27 @@
Message req, rep ;
req.type = Message::ENABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH ;
- req.setBoolean(true);
privateRefs->executeService(&req, &rep);
}
-// ----------------------------------------------------------------------------
-// Disable Attribute Scope Advisory Switch
+/**
+ * This service 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,
@@ -2802,12 +2895,27 @@
Message req, rep ;
req.type = Message::DISABLE_ATTRIBUTE_SCOPE_ADVISORY_SWITCH ;
- req.setBoolean(false);
privateRefs->executeService(&req, &rep);
}
-// ----------------------------------------------------------------------------
-// Enable Interaction Relevance Advisory Switch
+/**
+ * This service 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,
@@ -2816,12 +2924,27 @@
Message req, rep ;
req.type = Message::ENABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH ;
- req.setBoolean(true);
privateRefs->executeService(&req, &rep);
}
-// ----------------------------------------------------------------------------
-// Disable Interaction Relevance Advisory Switch
+/**
+ * This service 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,
@@ -2830,8 +2953,7 @@
Message req, rep ;
req.type = Message::DISABLE_INTERACTION_RELEVANCE_ADVISORY_SWITCH ;
- req.setBoolean(false);
privateRefs->executeService(&req, &rep);
}
-// $Id: RTIambassador.cc,v 3.98 2008/11/20 18:21:57 approx Exp $
+// $Id: RTIambassador.cc,v 3.99 2008/11/21 12:45:25 approx Exp $