DtDdmFederateAmbassador Class Reference

Inheritance diagram for DtDdmFederateAmbassador:

Collaboration diagram for DtDdmFederateAmbassador:

Classes
struct	DtRegionInfo

Public Member Functions
	DtDdmFederateAmbassador ()
virtual	~DtDdmFederateAmbassador () throw ()
virtual void	discoverObjectInstance (RTI::ObjectHandle theObject, RTI::ObjectClassHandle theObjectClass, const char *theObjectName) throw ( RTI::CouldNotDiscover, RTI::ObjectClassNotKnown, RTI::FederateInternalError )
	! Object Management Services //!
virtual void	reflectAttributeValues (RTI::ObjectHandle theObject, const RTI::AttributeHandleValuePairSet &theAttributes, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateOwnsAttributes, RTI::FederateInternalError)
	supplied C4
virtual void	removeObjectInstance (RTI::ObjectHandle theObject, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::FederateInternalError )
	supplied C4
virtual void	receiveInteraction (RTI::InteractionClassHandle theInteraction, const RTI::ParameterHandleValuePairSet &theParameters, const char *theTag) throw ( RTI::InteractionClassNotKnown, RTI::InteractionParameterNotKnown, RTI::FederateInternalError )
	supplied C4
virtual void	setXHandle (RTI::DimensionHandle handle)
virtual void	setYHandle (RTI::DimensionHandle handle)
virtual DtRegionInfo	regionInfoForObject (RTI::ObjectHandle handle) const
virtual DtRegionInfo	lastInteractionRegion () const
virtual void	clearLastInteractionRegion ()
Public Member Functions inherited from DtVrlFederateAmbassador
	DtVrlFederateAmbassador ()
	default constructor
virtual	~DtVrlFederateAmbassador () throw ( RTI::FederateInternalError )
	destructor
virtual void	init (DtExerciseConn *exConn, DtHlaObjectManager *hlaObjMgr, DtInteractionManager *interMgr)
	Initialize the ambassador.
virtual void	addReflectAttributeValuesCb (RTI::ObjectHandle id, DtReflectAttributeValuesCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's reflectAttributeValues service is invoked.
virtual void	removeReflectAttributeValuesCb (RTI::ObjectHandle id, DtReflectAttributeValuesCb cb, void *usr)
virtual void	addDiscoverObjectCb (RTI::ObjectClassHandle hand, DtDiscoverObjectCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's discoverObject service is invoked.
virtual void	removeDiscoverObjectCb (RTI::ObjectClassHandle hand, DtDiscoverObjectCb cb, void *usr)
virtual void	addRemoveObjectCb (RTI::ObjectHandle id, DtRemoveObjectCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's removeObject service is invoked.
virtual void	removeRemoveObjectCb (RTI::ObjectHandle id, DtRemoveObjectCb cb, void *usr)
virtual void	addStartRegCb (RTI::ObjectClassHandle hand, DtStartRegCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's startRegistration service is invoked.
virtual void	removeStartRegCb (RTI::ObjectClassHandle hand, DtStartRegCb cb, void *usr)
virtual void	addStopRegCb (RTI::ObjectClassHandle hand, DtStopRegCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's stopReg service is invoked.
virtual void	removeStopRegCb (RTI::ObjectClassHandle hand, DtStopRegCb cb, void *usr)
virtual void	addUpdatesOnCb (RTI::ObjectHandle hand, DtUpdatesOnCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's turnUpdatesOn service is invoked.
virtual void	removeUpdatesOnCb (RTI::ObjectHandle hand, DtUpdatesOnCb cb, void *usr)
virtual void	addUpdatesOffCb (RTI::ObjectHandle hand, DtUpdatesOffCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's turnUpdatesOff service is invoked.
virtual void	removeUpdatesOffCb (RTI::ObjectHandle hand, DtUpdatesOffCb cb, void *usr)
virtual void	addStartInteractionsCb (RTI::InteractionClassHandle hand, DtStartStopInterCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's startInteractionGeneration service is invoked.
virtual void	removeStartInteractionsCb (RTI::InteractionClassHandle hand, DtStartStopInterCb cb, void *usr)
virtual void	addStopInteractionsCb (RTI::InteractionClassHandle hand, DtStartStopInterCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's stopInteractionGeneration service is invoked.
virtual void	removeStopInteractionsCb (RTI::InteractionClassHandle hand, DtStartStopInterCb cb, void *usr)
virtual void	addReceiveInteractionCb (RTI::InteractionClassHandle hand, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add/Remove (register/deregister) function to be called when the RTI's receiveInteraction service is invoked.
virtual void	removeReceiveInteractionCb (RTI::InteractionClassHandle hand, DtReceiveInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
virtual void	addTimeAdvanceGrantCb (DtFedTimeCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's TimeAdvanceGrant service is invoked.
virtual void	removeTimeAdvanceGrantCb (DtFedTimeCb cb, void *usr)
virtual void	addTimeRegulationEnabledCb (DtFedTimeCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's TimeRegulationEnabled service is invoked.
virtual void	removeTimeRegulationEnabledCb (DtFedTimeCb cb, void *usr)
virtual void	addTimeConstrainedEnabledCb (DtFedTimeCb cb, void *usr)
	Add/Remove (register/deregister) function to be called when the RTI's TimeConstrainedEnabled service is invoked.
virtual void	removeTimeConstrainedEnabledCb (DtFedTimeCb cb, void *usr)
virtual void	setRemoveObjectOnAttOutOfScope (bool remove)
virtual bool	removeObjectOnAttOutOfScope () const
virtual bool	waitingForSaveOrRestore () const
virtual void	timeAdvanceGrant (const RTI::FedTime &theTime) throw ( RTI::InvalidFederationTime, RTI::TimeAdvanceWasNotInProgress, RTI::FederateInternalError )
	The functions below should probably be protected, but they need to be called by various VR-Link classes to implement the setReflecting() idea, when reflectingThroughRti is true.
virtual void	timeRegulationEnabled (const RTI::FedTime &theTime) throw ( RTI::InvalidFederationTime, RTI::EnableTimeRegulationWasNotPending, RTI::FederateInternalError )
	! Time Management Services //!
virtual void	timeConstrainedEnabled (const RTI::FedTime &theTime) throw ( RTI::InvalidFederationTime, RTI::EnableTimeConstrainedWasNotPending, RTI::FederateInternalError )
	supplied C4
virtual void	startRegistrationForObjectClass (RTI::ObjectClassHandle theClass) throw ( RTI::ObjectClassNotPublished, RTI::FederateInternalError )
	! Declaration Management Services //!
virtual void	stopRegistrationForObjectClass (RTI::ObjectClassHandle theClass) throw ( RTI::ObjectClassNotPublished, RTI::FederateInternalError )
virtual void	turnInteractionsOn (RTI::InteractionClassHandle theHandle) throw ( RTI::InteractionClassNotPublished, RTI::FederateInternalError )
virtual void	turnInteractionsOff (RTI::InteractionClassHandle theHandle) throw ( RTI::InteractionClassNotPublished, RTI::FederateInternalError )
virtual void	reflectAttributeValues (RTI::ObjectHandle theObject, const RTI::AttributeHandleValuePairSet &theAttributes, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateOwnsAttributes, RTI::InvalidFederationTime, RTI::FederateInternalError )
	supplied C1
virtual void	receiveInteraction (RTI::InteractionClassHandle theInteraction, const RTI::ParameterHandleValuePairSet &theParameters, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle) throw ( RTI::InteractionClassNotKnown, RTI::InteractionParameterNotKnown, RTI::InvalidFederationTime, RTI::FederateInternalError )
	4.6
virtual void	removeObjectInstance (RTI::ObjectHandle theObject, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle) throw ( RTI::ObjectNotKnown, RTI::InvalidFederationTime, RTI::FederateInternalError )
	supplied C1
virtual void	attributesInScope (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
	supplied C4
virtual void	attributesOutOfScope (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
	supplied C4
virtual void	provideAttributeValueUpdate (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError )
	supplied C4
virtual void	turnUpdatesOnForObjectInstance (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError )
	supplied C4
virtual void	turnUpdatesOffForObjectInstance (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError )
	supplied C4
virtual void	requestAttributeOwnershipAssumption (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &offeredAttributes, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAlreadyOwned, RTI::AttributeNotPublished, RTI::FederateInternalError )
	Ownership Management Services.
virtual void	attributeOwnershipDivestitureNotification (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &releasedAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeNotOwned, RTI::AttributeDivestitureWasNotRequested, RTI::FederateInternalError )
	supplied C4
virtual void	attributeOwnershipAcquisitionNotification (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &securedAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAcquisitionWasNotRequested, RTI::AttributeAlreadyOwned, RTI::AttributeNotPublished, RTI::FederateInternalError )
	supplied C4
virtual void	attributeOwnershipUnavailable (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAlreadyOwned, RTI::AttributeAcquisitionWasNotRequested, RTI::FederateInternalError )
	supplied C4
virtual void	requestAttributeOwnershipRelease (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &candidateAttributes, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError )
	supplied C4
virtual void	confirmAttributeOwnershipAcquisitionCancellation (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAlreadyOwned, RTI::AttributeAcquisitionWasNotCanceled, RTI::FederateInternalError )
	supplied C4
virtual void	informAttributeOwnership (RTI::ObjectHandle theObject, RTI::AttributeHandle theAttribute, RTI::FederateHandle theOwner) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError )
	supplied C1
virtual void	attributeIsNotOwned (RTI::ObjectHandle theObject, RTI::AttributeHandle theAttribute) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError )
	supplied C1
virtual void	attributeOwnedByRTI (RTI::ObjectHandle theObject, RTI::AttributeHandle theAttribute) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
	supplied C1
virtual void	synchronizationPointRegistrationSucceeded (const char *label) throw ( RTI::FederateInternalError )
	sync points
virtual void	synchronizationPointRegistrationFailed (const char *label) throw ( RTI::FederateInternalError )
virtual void	federationSynchronized (const char *label) throw ( RTI::FederateInternalError )
virtual void	announceSynchronizationPoint (const char *label, const char *tag) throw ( RTI::FederateInternalError )
virtual void	addSynchPointRegSucceededCb (const DtString &label, DtSynchPointCb func, void *usr)
	Methods to add/remove user callbacks for sync point callbacks.
virtual void	addSynchPointRegSucceededCb (DtSynchPointCb func, void *usr)
virtual void	removeSynchPointRegSucceededCb (const DtString &label, DtSynchPointCb func, void *usr)
virtual void	removeSynchPointRegSucceededCb (DtSynchPointCb func, void *usr)
virtual void	addSynchPointRegFailedCb (const DtString &label, DtSynchPointCb func, void *usr)
virtual void	addSynchPointRegFailedCb (DtSynchPointCb func, void *usr)
virtual void	removeSynchPointRegFailedCb (const DtString &label, DtSynchPointCb func, void *usr)
virtual void	removeSynchPointRegFailedCb (DtSynchPointCb func, void *usr)
virtual void	addFederationSynchedCb (const DtString &label, DtSynchPointCb func, void *usr)
virtual void	addFederationSynchedCb (DtSynchPointCb func, void *usr)
virtual void	removeFederationSynchedCb (const DtString &label, DtSynchPointCb func, void *usr)
virtual void	removeFederationSynchedCb (DtSynchPointCb func, void *usr)
virtual void	addAnnounceSynchPointCb (const DtString &label, DtAnnounceSynchPointCb func, void *usr)
virtual void	addAnnounceSynchPointCb (DtAnnounceSynchPointCb func, void *usr)
virtual void	removeAnnounceSynchPointCb (const DtString &label, DtAnnounceSynchPointCb func, void *usr)
virtual void	removeAnnounceSynchPointCb (DtAnnounceSynchPointCb func, void *usr)
virtual void	addFederateSaveCb (const DtString &label, DtFederateSaveCb func, void *usr)
	Methods to add/remove user callbacks for federation save callbacks.
virtual void	addFederateSaveCb (DtFederateSaveCb func, void *usr)
	Methods to add/remove user callbacks for federation save callbacks.
virtual void	removeFederateSaveCb (const DtString &label, DtFederateSaveCb func, void *usr)
	Methods to add/remove user callbacks for federation save callbacks.
virtual void	removeFederateSaveCb (DtFederateSaveCb func, void *usr)
	Methods to add/remove user callbacks for federation save callbacks.
virtual void	addFederateRestoreCb (const DtString &label, DtFederateRestoreCb func, void *usr)
	Methods to add/remove user callbacks for federation restore callbacks.
virtual void	addFederateRestoreCb (DtFederateRestoreCb func, void *usr)
	Methods to add/remove user callbacks for federation restore callbacks.
virtual void	removeFederateRestoreCb (const DtString &label, DtFederateRestoreCb func, void *usr)
	Methods to add/remove user callbacks for federation restore callbacks.
virtual void	removeFederateRestoreCb (DtFederateRestoreCb func, void *usr)
	Methods to add/remove user callbacks for federation restore callbacks.
virtual void	initiateFederateSave (const char *label) throw ( RTI::UnableToPerformSave, RTI::FederateInternalError )
virtual void	federationSaved () throw ( RTI::FederateInternalError)
virtual void	federationNotSaved () throw ( RTI::FederateInternalError )
virtual void	initiateFederateRestore (const char *label, RTI::FederateHandle handle) throw ( RTI::SpecifiedSaveLabelDoesNotExist, RTI::CouldNotRestore, RTI::FederateInternalError)
virtual void	federationRestored () throw ( RTI::FederateInternalError)
Public Member Functions inherited from DtNullFederateAmbassador
	DtNullFederateAmbassador ()
	Default constructor.
virtual	~DtNullFederateAmbassador () throw ( RTI::FederateInternalError )
	Destructor.
virtual void	requestFederationRestoreSucceeded (const char *label) throw ( RTI::FederateInternalError )
virtual void	requestFederationRestoreFailed (const char *label, const char *reason) throw ( RTI::FederateInternalError)
virtual void	federationRestoreBegun () throw ( RTI::FederateInternalError )
virtual void	federationNotRestored () throw ( RTI::FederateInternalError )
virtual void	requestRetraction (RTI::EventRetractionHandle theHandle) throw ( RTI::EventNotKnown, RTI::FederateInternalError )

Static Public Member Functions
static DtVrlFederateAmbassador *	create ()
	returns a new DtVrlFedAmbassador

Protected Attributes
std::map< RTI::ObjectHandle, DtRegionInfo >	myHandleToRegionMap
DtRegionInfo	myLastInteractionRegion
RTI::DimensionHandle	myXHandle
RTI::DimensionHandle	myYHandle
DtRegionInfo	myEmptyRegionInfo
Protected Attributes inherited from DtVrlFederateAmbassador
DtExerciseConn *	myExConn
DtInteractionManager *	myInteractionManager
DtHlaObjectManager *	myHlaObjectManager
DtReflectAttributeValuesCbList	myRavCbList
DtUpdatesOnCbList	myUpdatesOnCbList
DtUpdatesOffCbList	myUpdatesOffCbList
DtStartRegCbList	myStartRegCbList
DtStopRegCbList	myStopRegCbList
DtStartStopInterCbList	myStartIntCbList
DtStartStopInterCbList	myStopIntCbList
DtFedTimeCbList	myTimeAdvanceGrantCbList
DtFedTimeCbList	myRegulationEnabledCbList
DtFedTimeCbList	myConstrainedEnabledCbList
std::list< DtFederateSaveCbInfo >	myFederateSaveCbList
	Lists for specific callbacks registered with VR-Link.
std::list < DtLabelledFederateSaveCbInfo >	myLabFederateSaveCbList
std::list < DtFederateRestoreCbInfo >	myFederateRestoreCbList
std::list < DtLabelledFederateRestoreCbInfo >	myLabFederateRestoreCbList
std::list < DtLabelledSynchPointCbInfo >	myLabSynchPtRegSucceededCbList
std::list < DtLabelledSynchPointCbInfo >	myLabSynchPtRegFailedCbList
std::list < DtLabelledSynchPointCbInfo >	myLabFederationSynchedCbList
std::list < DtLabelledAnnounceCbInfo >	myLabAnnounceSynchPointCbList
std::list < DtGeneralSynchPointCbInfo >	mySynchPtRegSucceededCbList
std::list < DtGeneralSynchPointCbInfo >	mySynchPtRegFailedCbList
std::list < DtGeneralSynchPointCbInfo >	myFederationSynchedCbList
std::list < DtGeneralAnnounceCbInfo >	myAnnounceSynchPointCbList
bool	myRemoveObjectOnAttOutOfScope
bool	myWaitingForSave
bool	myWaitingForRestore

Additional Inherited Members
Protected Member Functions inherited from DtVrlFederateAmbassador
	DtVrlFederateAmbassador (const DtVrlFederateAmbassador &src)
	copy constructor - not implemented.
DtVrlFederateAmbassador &	operator= (const DtVrlFederateAmbassador &src)
	assignment operator - not implemented.
virtual const RTI::Region *	getRegionFromAttributes (const RTI::AttributeHandleValuePairSet &theAttributes) const
virtual const RTI::Region *	getRegionFromParameters (const RTI::ParameterHandleValuePairSet &theAttributes) const
virtual void	processAttributesOutOfScope (RTI::ObjectHandle handle)
virtual void	applyFedsSynchedCallbacks (const char *label)
	Utility functions.
virtual void	applyRegistrationSucceededCallbacks (const char *label)
virtual void	applyRegistrationFailedCallbacks (const char *label)
virtual bool	applyAnnounceCallbacks (const char *label, const char *tag)
	Return true if any are applied (i.e., don't auto-reply)
Static Protected Member Functions inherited from DtVrlFederateAmbassador
static void	attributesOutOfScopeCb (void *usr)

Constructor & Destructor Documentation

DtDdmFederateAmbassador::DtDdmFederateAmbassador

(

)

virtual DtDdmFederateAmbassador::~DtDdmFederateAmbassador ( ) throw ()

virtual

Member Function Documentation

virtual void DtDdmFederateAmbassador::clearLastInteractionRegion ( )

virtual

static DtVrlFederateAmbassador* DtDdmFederateAmbassador::create ( )

static

returns a new DtVrlFedAmbassador

Reimplemented from DtVrlFederateAmbassador.

virtual void DtDdmFederateAmbassador::discoverObjectInstance ( RTI::ObjectHandle  theObject, RTI::ObjectClassHandle  theObjectClass, const char *  theObjectName  ) throw ( RTI::CouldNotDiscover, RTI::ObjectClassNotKnown, RTI::FederateInternalError )

virtual

! Object Management Services //!

supplied C4

Reimplemented from DtVrlFederateAmbassador.

virtual DtRegionInfo DtDdmFederateAmbassador::lastInteractionRegion ( ) const

virtual

virtual void DtDdmFederateAmbassador::receiveInteraction ( RTI::InteractionClassHandle  theInteraction, const RTI::ParameterHandleValuePairSet &  theParameters, const char *  theTag  ) throw ( RTI::InteractionClassNotKnown, RTI::InteractionParameterNotKnown, RTI::FederateInternalError )

virtual

supplied C4

Reimplemented from DtVrlFederateAmbassador.

virtual void DtDdmFederateAmbassador::reflectAttributeValues ( RTI::ObjectHandle  theObject, const RTI::AttributeHandleValuePairSet &  theAttributes, const char *  theTag  ) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateOwnsAttributes, RTI::FederateInternalError)

virtual

supplied C4

Reimplemented from DtVrlFederateAmbassador.

virtual DtRegionInfo DtDdmFederateAmbassador::regionInfoForObject ( RTI::ObjectHandle  handle ) const

virtual

virtual void DtDdmFederateAmbassador::removeObjectInstance ( RTI::ObjectHandle  theObject, const char *  theTag  ) throw ( RTI::ObjectNotKnown, RTI::FederateInternalError )

virtual

supplied C4

Reimplemented from DtVrlFederateAmbassador.

virtual void DtDdmFederateAmbassador::setXHandle ( RTI::DimensionHandle  handle )

virtual

virtual void DtDdmFederateAmbassador::setYHandle ( RTI::DimensionHandle  handle )

virtual

Member Data Documentation

DtRegionInfo DtDdmFederateAmbassador::myEmptyRegionInfo

protected

std::map<RTI::ObjectHandle, DtRegionInfo> DtDdmFederateAmbassador::myHandleToRegionMap

protected

DtRegionInfo DtDdmFederateAmbassador::myLastInteractionRegion

protected

RTI::DimensionHandle DtDdmFederateAmbassador::myXHandle

protected

RTI::DimensionHandle DtDdmFederateAmbassador::myYHandle

protected

---

The documentation for this class was generated from the following file:

• ddmFedAmb13.h