MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Functions
fedAmbServ.h File Reference

Go to the source code of this file.

Functions

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

Function Documentation

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

4.8

supplied C4

Parameters
tagsupplied C4
virtual void attributeIsNotOwned ( ObjectHandle  theObject,
AttributeHandle  theAttribute 
)
throw ( ObjectNotKnown,
AttributeNotKnown,
FederateInternalError
)
pure virtual

supplied C1

Parameters
theAttributesupplied C1
virtual void attributeOwnedByRTI ( ObjectHandle  theObject,
AttributeHandle  theAttribute 
)
throw ( ObjectNotKnown,
AttributeNotKnown,
FederateInternalError
)
pure virtual

supplied C1

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

7.6

supplied C4

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

7.5

supplied C4

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

7.9

supplied C4

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

6.13

supplied C4

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

6.14

supplied C4

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

7.14

supplied C4

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

! Object Management Services //!

6.3 supplied C4

Parameters
theObjectClasssupplied C1
theObjectNamesupplied C1
virtual void federationNotRestored ( )
throw (FederateInternalError
)
pure virtual
virtual void federationNotSaved ( )
throw (FederateInternalError
)
pure virtual
virtual void federationRestoreBegun ( )
throw (FederateInternalError
)
pure virtual

4.18

virtual void federationRestored ( )
throw (FederateInternalError
)
pure virtual

4.21

virtual void federationSaved ( )
throw (FederateInternalError
)
pure virtual

4.15

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

4.10

supplied C4)

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

7.16

supplied C1

Parameters
theAttributesupplied C1
theOwnersupplied C1
virtual void initiateFederateRestore ( const char *  label,
FederateHandle  handle 
)
throw ( SpecifiedSaveLabelDoesNotExist,
CouldNotRestore,
FederateInternalError
)
pure virtual

4.19

supplied C1

Parameters
handlesupplied C4
virtual void initiateFederateSave ( const char *  label)
throw ( UnableToPerformSave,
FederateInternalError
)
pure virtual

4.12

supplied C4

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

6.16

supplied C4

Parameters
theAttributessupplied C1
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
theParameterssupplied C1
theTimesupplied C4
theTagsupplied C4
theHandlesupplied C4
virtual void receiveInteraction ( InteractionClassHandle  theInteraction,
const ParameterHandleValuePairSet &  theParameters,
const char *  theTag 
)
throw ( InteractionClassNotKnown,
InteractionParameterNotKnown,
FederateInternalError
)
pure virtual

supplied C4

Parameters
theParameterssupplied C1
theTagsupplied 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
theAttributessupplied C1
theTimesupplied C4
theTagsupplied C1
theHandlesupplied C4
virtual void reflectAttributeValues ( ObjectHandle  theObject,
const AttributeHandleValuePairSet &  theAttributes,
const char *  theTag 
)
throw ( ObjectNotKnown,
AttributeNotKnown,
FederateOwnsAttributes,
FederateInternalError
)
pure virtual

supplied C4

Parameters
theAttributessupplied C1
theTagsupplied 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
theTimesupplied C1
theTagsupplied C4
theHandlesupplied C4
virtual void removeObjectInstance ( ObjectHandle  theObject,
const char *  theTag 
)
throw ( ObjectNotKnown,
FederateInternalError
)
pure virtual

supplied C4

Parameters
theTagsupplied 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
offeredAttributessupplied C1
theTagsupplied C4
virtual void requestAttributeOwnershipRelease ( ObjectHandle  theObject,
const AttributeHandleSet &  candidateAttributes,
const char *  theTag 
)
throw ( ObjectNotKnown,
AttributeNotKnown,
AttributeNotOwned,
FederateInternalError
)
pure virtual

7.10

supplied C4

Parameters
candidateAttributessupplied C1
theTagsupplied C4
virtual void requestFederationRestoreFailed ( const char *  label,
const char *  reason 
)
throw (FederateInternalError
)
pure virtual

supplied C4

Parameters
reasonsupplied C4
virtual void requestFederationRestoreSucceeded ( const char *  label)
throw (FederateInternalError
)
pure virtual

4.17

supplied C4

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

8.22

supplied C1

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

! Declaration Management Services //!

5.10 supplied C1

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

5.11

supplied C1

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

supplied C4)

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)

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

8.13

supplied C4

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

8.6

supplied C4

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

! Time Management Services //!

8.3 supplied C4

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

5.13

supplied C1

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

5.12

supplied C1

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

6.18

supplied C4

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

6.17

supplied C4

Parameters
theAttributessupplied C1
virtual ~FederateAmbassador ( )
throw (FederateInternalError
)
virtual
Document ID: Generated on Thu May 11 15:55:32 EDT 2023 from SVN revision 254743
Copyright © 2005-2020 MAK Technologies Inc. All Rights Reserved (www.mak.com)