Functions
virtual void	synchronizationPointRegistrationSucceeded (const char *label)=0 throw ( FederateInternalError)
	RTI Parameter Passing Memory Conventions.
virtual void	synchronizationPointRegistrationFailed (const char *label)=0 throw ( FederateInternalError)
	supplied C4)
virtual void	announceSynchronizationPoint (const char label, const char tag)=0 throw ( FederateInternalError)
	4.8
virtual void	federationSynchronized (const char *label)=0 throw ( FederateInternalError)
	4.10
virtual void	initiateFederateSave (const char *label)=0 throw ( UnableToPerformSave, FederateInternalError)
	4.12
virtual void	federationSaved ()=0 throw ( FederateInternalError)
	4.15
virtual void	federationNotSaved ()=0 throw ( FederateInternalError)
virtual void	requestFederationRestoreSucceeded (const char *label)=0 throw ( FederateInternalError)
	4.17
virtual void	requestFederationRestoreFailed (const char label, const char reason)=0 throw ( FederateInternalError)
	supplied C4
virtual void	federationRestoreBegun ()=0 throw ( FederateInternalError)
	4.18
virtual void	initiateFederateRestore (const char *label, FederateHandle handle)=0 throw ( SpecifiedSaveLabelDoesNotExist, CouldNotRestore, FederateInternalError)
	4.19
virtual void	federationRestored ()=0 throw ( FederateInternalError)
	4.21
virtual void	federationNotRestored ()=0 throw ( FederateInternalError)
virtual void	startRegistrationForObjectClass (ObjectClassHandle theClass)=0 throw ( ObjectClassNotPublished, FederateInternalError)
	! Declaration Management Services //!
virtual void	stopRegistrationForObjectClass (ObjectClassHandle theClass)=0 throw ( ObjectClassNotPublished, FederateInternalError)
	5.11
virtual void	turnInteractionsOn (InteractionClassHandle theHandle)=0 throw ( InteractionClassNotPublished, FederateInternalError)
	5.12
virtual void	turnInteractionsOff (InteractionClassHandle theHandle)=0 throw ( InteractionClassNotPublished, FederateInternalError)
	5.13
virtual void	discoverObjectInstance (ObjectHandle theObject, ObjectClassHandle theObjectClass, const char *theObjectName)=0 throw ( CouldNotDiscover, ObjectClassNotKnown, FederateInternalError)
	! Object Management Services //!
virtual void	reflectAttributeValues (ObjectHandle theObject, const AttributeHandleValuePairSet &theAttributes, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0 throw ( ObjectNotKnown, AttributeNotKnown, FederateOwnsAttributes, InvalidFederationTime, FederateInternalError)
	6.5
virtual void	reflectAttributeValues (ObjectHandle theObject, const AttributeHandleValuePairSet &theAttributes, const char *theTag)=0 throw ( ObjectNotKnown, AttributeNotKnown, FederateOwnsAttributes, FederateInternalError)
	supplied C4
virtual void	receiveInteraction (InteractionClassHandle theInteraction, const ParameterHandleValuePairSet &theParameters, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0 throw ( InteractionClassNotKnown, InteractionParameterNotKnown, InvalidFederationTime, FederateInternalError)
	6.7
virtual void	receiveInteraction (InteractionClassHandle theInteraction, const ParameterHandleValuePairSet &theParameters, const char *theTag)=0 throw ( InteractionClassNotKnown, InteractionParameterNotKnown, FederateInternalError)
	supplied C4
virtual void	removeObjectInstance (ObjectHandle theObject, const FedTime &theTime, const char *theTag, EventRetractionHandle theHandle)=0 throw ( ObjectNotKnown, InvalidFederationTime, FederateInternalError)
	6.9
virtual void	removeObjectInstance (ObjectHandle theObject, const char *theTag)=0 throw ( ObjectNotKnown, FederateInternalError)
	supplied C4
virtual void	attributesInScope (ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0 throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)
	6.13
virtual void	attributesOutOfScope (ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0 throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)
	6.14
virtual void	provideAttributeValueUpdate (ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0 throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotOwned, FederateInternalError)
	6.16
virtual void	turnUpdatesOnForObjectInstance (ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0 throw ( ObjectNotKnown, AttributeNotOwned, FederateInternalError)
	6.17
virtual void	turnUpdatesOffForObjectInstance (ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0 throw ( ObjectNotKnown, AttributeNotOwned, FederateInternalError)
	6.18
virtual void	requestAttributeOwnershipAssumption (ObjectHandle theObject, const AttributeHandleSet &offeredAttributes, const char *theTag)=0 throw ( ObjectNotKnown, AttributeNotKnown, AttributeAlreadyOwned, AttributeNotPublished, FederateInternalError)
	! Ownership Management Services //!
virtual void	attributeOwnershipDivestitureNotification (ObjectHandle theObject, const AttributeHandleSet &releasedAttributes)=0 throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotOwned, AttributeDivestitureWasNotRequested, FederateInternalError)
	7.5
virtual void	attributeOwnershipAcquisitionNotification (ObjectHandle theObject, const AttributeHandleSet &securedAttributes)=0 throw ( ObjectNotKnown, AttributeNotKnown, AttributeAcquisitionWasNotRequested, AttributeAlreadyOwned, AttributeNotPublished, FederateInternalError)
	7.6
virtual void	attributeOwnershipUnavailable (ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0 throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotDefined, AttributeAlreadyOwned, AttributeAcquisitionWasNotRequested, FederateInternalError)
	7.9
virtual void	requestAttributeOwnershipRelease (ObjectHandle theObject, const AttributeHandleSet &candidateAttributes, const char *theTag)=0 throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotOwned, FederateInternalError)
	7.10
virtual void	confirmAttributeOwnershipAcquisitionCancellation (ObjectHandle theObject, const AttributeHandleSet &theAttributes)=0 throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotDefined, AttributeAlreadyOwned, AttributeAcquisitionWasNotCanceled, FederateInternalError)
	7.14
virtual void	informAttributeOwnership (ObjectHandle theObject, AttributeHandle theAttribute, FederateHandle theOwner)=0 throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)
	7.16
virtual void	attributeIsNotOwned (ObjectHandle theObject, AttributeHandle theAttribute)=0 throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)
	supplied C1
virtual void	attributeOwnedByRTI (ObjectHandle theObject, AttributeHandle theAttribute)=0 throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)
	supplied C1
virtual void	timeRegulationEnabled (const FedTime &theFederateTime)=0 throw ( InvalidFederationTime, EnableTimeRegulationWasNotPending, FederateInternalError)
	! Time Management Services //!
virtual void	timeConstrainedEnabled (const FedTime &theFederateTime)=0 throw ( InvalidFederationTime, EnableTimeConstrainedWasNotPending, FederateInternalError)
	8.6
virtual void	timeAdvanceGrant (const FedTime &theTime)=0 throw ( InvalidFederationTime, TimeAdvanceWasNotInProgress, FederationTimeAlreadyPassed, FederateInternalError)
	8.13
virtual void	requestRetraction (EventRetractionHandle theHandle)=0 throw ( EventNotKnown, FederateInternalError)
	8.22
virtual	~FederateAmbassador () throw (FederateInternalError)

Function Documentation

virtual void announceSynchronizationPoint	(	const char *	label,
		const char *	tag
	)		throw ( FederateInternalError)

pure virtual

4.8

supplied C4

Parameters

tag	supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void attributeIsNotOwned	(	ObjectHandle	theObject,
		AttributeHandle	theAttribute
	)		throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)

pure virtual

supplied C1

Parameters

theAttribute supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void attributeOwnedByRTI	(	ObjectHandle	theObject,
		AttributeHandle	theAttribute
	)		throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)

pure virtual

supplied C1

Parameters

theAttribute supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void attributeOwnershipAcquisitionNotification	(	ObjectHandle	theObject,
		const AttributeHandleSet &	securedAttributes
	)		throw ( ObjectNotKnown, AttributeNotKnown, AttributeAcquisitionWasNotRequested, AttributeAlreadyOwned, AttributeNotPublished, FederateInternalError)

pure virtual

7.6

supplied C4

Parameters

securedAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void attributeOwnershipDivestitureNotification	(	ObjectHandle	theObject,
		const AttributeHandleSet &	releasedAttributes
	)		throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotOwned, AttributeDivestitureWasNotRequested, FederateInternalError)

pure virtual

7.5

supplied C4

Parameters

releasedAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void attributeOwnershipUnavailable	(	ObjectHandle	theObject,
		const AttributeHandleSet &	theAttributes
	)		throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotDefined, AttributeAlreadyOwned, AttributeAcquisitionWasNotRequested, FederateInternalError)

pure virtual

7.9

supplied C4

Parameters

theAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void attributesInScope	(	ObjectHandle	theObject,
		const AttributeHandleSet &	theAttributes
	)		throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)

pure virtual

6.13

supplied C4

Parameters

theAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void attributesOutOfScope	(	ObjectHandle	theObject,
		const AttributeHandleSet &	theAttributes
	)		throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)

pure virtual

6.14

supplied C4

Parameters

theAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void confirmAttributeOwnershipAcquisitionCancellation	(	ObjectHandle	theObject,
		const AttributeHandleSet &	theAttributes
	)		throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotDefined, AttributeAlreadyOwned, AttributeAcquisitionWasNotCanceled, FederateInternalError)

pure virtual

7.14

supplied C4

Parameters

theAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

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

pure virtual

! Object Management Services //!

6.3 supplied C4

Parameters

theObjectClass	supplied C1
theObjectName	supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void federationNotRestored ( ) throw ( FederateInternalError)

pure virtual

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void federationNotSaved ( ) throw ( FederateInternalError)

pure virtual

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void federationRestoreBegun ( ) throw ( FederateInternalError)

pure virtual

4.18

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void federationRestored ( ) throw ( FederateInternalError)

pure virtual

4.21

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void federationSaved ( ) throw ( FederateInternalError)

pure virtual

4.15

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void federationSynchronized ( const char * label ) throw ( FederateInternalError)

pure virtual

4.10

supplied C4)

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void informAttributeOwnership	(	ObjectHandle	theObject,
		AttributeHandle	theAttribute,
		FederateHandle	theOwner
	)		throw ( ObjectNotKnown, AttributeNotKnown, FederateInternalError)

pure virtual

7.16

supplied C1

Parameters

theAttribute	supplied C1
theOwner	supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void initiateFederateRestore	(	const char *	label,
		FederateHandle	handle
	)		throw ( SpecifiedSaveLabelDoesNotExist, CouldNotRestore, FederateInternalError)

pure virtual

4.19

supplied C1

Parameters

handle supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void initiateFederateSave ( const char * label ) throw ( UnableToPerformSave, FederateInternalError)

pure virtual

4.12

supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void provideAttributeValueUpdate	(	ObjectHandle	theObject,
		const AttributeHandleSet &	theAttributes
	)		throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotOwned, FederateInternalError)

pure virtual

6.16

supplied C4

Parameters

theAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void receiveInteraction	(	InteractionClassHandle	theInteraction,
		const ParameterHandleValuePairSet &	theParameters,
		const FedTime &	theTime,
		const char *	theTag,
		EventRetractionHandle	theHandle
	)		throw ( InteractionClassNotKnown, InteractionParameterNotKnown, InvalidFederationTime, FederateInternalError)

pure virtual

6.7

supplied C1

Parameters

theParameters	supplied C1
theTime	supplied C4
theTag	supplied C4
theHandle	supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

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

pure virtual

supplied C4

Parameters

theParameters	supplied C1
theTag	supplied C4

virtual void reflectAttributeValues	(	ObjectHandle	theObject,
		const AttributeHandleValuePairSet &	theAttributes,
		const FedTime &	theTime,
		const char *	theTag,
		EventRetractionHandle	theHandle
	)		throw ( ObjectNotKnown, AttributeNotKnown, FederateOwnsAttributes, InvalidFederationTime, FederateInternalError)

pure virtual

6.5

supplied C1

Parameters

theAttributes	supplied C1
theTime	supplied C4
theTag	supplied C1
theHandle	supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

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

pure virtual

supplied C4

Parameters

theAttributes	supplied C1
theTag	supplied C4

virtual void removeObjectInstance	(	ObjectHandle	theObject,
		const FedTime &	theTime,
		const char *	theTag,
		EventRetractionHandle	theHandle
	)		throw ( ObjectNotKnown, InvalidFederationTime, FederateInternalError)

pure virtual

6.9

supplied C1

Parameters

theTime	supplied C1
theTag	supplied C4
theHandle	supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

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

pure virtual

supplied C4

Parameters

theTag supplied C1

virtual void requestAttributeOwnershipAssumption	(	ObjectHandle	theObject,
		const AttributeHandleSet &	offeredAttributes,
		const char *	theTag
	)		throw ( ObjectNotKnown, AttributeNotKnown, AttributeAlreadyOwned, AttributeNotPublished, FederateInternalError)

pure virtual

! Ownership Management Services //!

7.4 supplied C4

Parameters

offeredAttributes	supplied C1
theTag	supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void requestAttributeOwnershipRelease	(	ObjectHandle	theObject,
		const AttributeHandleSet &	candidateAttributes,
		const char *	theTag
	)		throw ( ObjectNotKnown, AttributeNotKnown, AttributeNotOwned, FederateInternalError)

pure virtual

7.10

supplied C4

Parameters

candidateAttributes	supplied C1
theTag	supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void requestFederationRestoreFailed	(	const char *	label,
		const char *	reason
	)		throw ( FederateInternalError)

pure virtual

supplied C4

Parameters

reason supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void requestFederationRestoreSucceeded ( const char * label ) throw ( FederateInternalError)

pure virtual

4.17

supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void requestRetraction ( EventRetractionHandle theHandle ) throw ( EventNotKnown, FederateInternalError)

pure virtual

8.22

supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void startRegistrationForObjectClass ( ObjectClassHandle theClass ) throw ( ObjectClassNotPublished, FederateInternalError)

pure virtual

! Declaration Management Services //!

5.10 supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void stopRegistrationForObjectClass ( ObjectClassHandle theClass ) throw ( ObjectClassNotPublished, FederateInternalError)

pure virtual

5.11

supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void synchronizationPointRegistrationFailed ( const char * label ) throw ( FederateInternalError)

pure virtual

supplied C4)

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void synchronizationPointRegistrationSucceeded ( const char * label ) throw ( FederateInternalError)

pure virtual

RTI Parameter Passing Memory Conventions.

C1 In parameter by value. C2 Out parameter by pointer value. C3 Function return by value. C4 In parameter by const pointer value. Caller provides memory. Caller may free memory or overwrite it upon completion of the call. Callee must copy during the call anything it wishes to save beyond completion of the call. Parameter type must define const accessor methods. C5 Out parameter by pointer value. Caller provides reference to object. Callee constructs an instance on the heap (new) and returns. The caller destroys the instance (delete) at its leisure. C6 Function return by pointer value. Callee constructs an instance on the heap (new) and returns a reference. The caller destroys the instance (delete) at its leisure.! Federation Management Services //! 4.7 supplied C4)

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void timeAdvanceGrant ( const FedTime & theTime ) throw ( InvalidFederationTime, TimeAdvanceWasNotInProgress, FederationTimeAlreadyPassed, FederateInternalError)

pure virtual

8.13

supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void timeConstrainedEnabled ( const FedTime & theFederateTime ) throw ( InvalidFederationTime, EnableTimeConstrainedWasNotPending, FederateInternalError)

pure virtual

8.6

supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void timeRegulationEnabled ( const FedTime & theFederateTime ) throw ( InvalidFederationTime, EnableTimeRegulationWasNotPending, FederateInternalError)

pure virtual

! Time Management Services //!

8.3 supplied C4

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void turnInteractionsOff ( InteractionClassHandle theHandle ) throw ( InteractionClassNotPublished, FederateInternalError)

pure virtual

5.13

supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void turnInteractionsOn ( InteractionClassHandle theHandle ) throw ( InteractionClassNotPublished, FederateInternalError)

pure virtual

5.12

supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void turnUpdatesOffForObjectInstance	(	ObjectHandle	theObject,
		const AttributeHandleSet &	theAttributes
	)		throw ( ObjectNotKnown, AttributeNotOwned, FederateInternalError)

pure virtual

6.18

supplied C4

Parameters

theAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual void turnUpdatesOnForObjectInstance	(	ObjectHandle	theObject,
		const AttributeHandleSet &	theAttributes
	)		throw ( ObjectNotKnown, AttributeNotOwned, FederateInternalError)

pure virtual

6.17

supplied C4

Parameters

theAttributes supplied C1

Referenced by DtEnumToStringHelpers::fedAmbTypeToDisplayStr().

virtual ~FederateAmbassador ( ) throw (FederateInternalError)

virtual

Functions

Function Documentation