MAK RTIspy API Documentation for HLA 1516
List of all members | Public Member Functions
rtiSimple1516e.SimpleFederateAmbassador Class Reference

A basic Federate Ambassador implementation. More...

+ Inheritance diagram for rtiSimple1516e.SimpleFederateAmbassador:
+ Collaboration diagram for rtiSimple1516e.SimpleFederateAmbassador:

Public Member Functions

void printAttributeHandleValueMap (AttributeHandleValueMap theAttributes)
void printParameterHandleValueMap (ParameterHandleValueMap theParameters)
void discoverObjectInstance (ObjectInstanceHandle theObject, ObjectClassHandle theObjectClass, String objectName) throws FederateInternalError
void discoverObjectInstance (ObjectInstanceHandle theObject, ObjectClassHandle theObjectClass, String objectName, FederateHandle producingFederate) throws FederateInternalError
void objectInstanceNameReservationSucceeded (String objectName) throws FederateInternalError
void objectInstanceNameReservationFailed (String objectName) throws FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, SupplementalReflectInfo reflectInfo) throws FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, LogicalTime theTime, OrderType receivedOrdering, SupplementalReflectInfo reflectInfo) throws FederateInternalError
void removeObjectInstance (ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, SupplementalRemoveInfo removeInfo) throws FederateInternalError
void removeObjectInstance (ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime, OrderType receivedOrdering, SupplementalRemoveInfo removeInfo) throws FederateInternalError
void removeObjectInstance (ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle, SupplementalRemoveInfo removeInfo) throws FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, SupplementalReceiveInfo receiveInfo) throws FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, LogicalTime theTime, OrderType receivedOrdering, SupplementalReceiveInfo receiveInfo) throws FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle, SupplementalReceiveInfo receiveInfo) throws FederateInternalError
void initiateFederateSave (String label) throws FederateInternalError
void federationSaved () throws FederateInternalError
void federationNotSaved (SaveFailureReason theSaveFailureReason) throws FederateInternalError
void federationSaveStatusResponse (FederateHandleSaveStatusPair[] theFederateStatusVector) throws FederateInternalError
void requestFederationRestoreSucceeded (String label) throws FederateInternalError
void requestFederationRestoreFailed (String label) throws FederateInternalError
void federationRestoreBegun () throws FederateInternalError
void initiateFederateRestore (String label, String federateName, FederateHandle federateHandle) throws FederateInternalError
void federationRestored () throws FederateInternalError
void federationNotRestored (RestoreFailureReason theRestoreFailureReason) throws FederateInternalError
void federationRestoreStatusResponse (FederateRestoreStatus[] theFederateRestoreStatusVector) throws FederateInternalError
- Public Member Functions inherited from NullFederateAmbassador
 NullFederateAmbassador ()
virtual ~NullFederateAmbassador () throw (RTI::FederateInternalError)
virtual void synchronizationPointRegistrationSucceeded (const char *label) throw ( RTI::FederateInternalError)
virtual void synchronizationPointRegistrationFailed (const char *label) throw ( RTI::FederateInternalError)
virtual void announceSynchronizationPoint (const char *label, const char *tag) throw ( RTI::FederateInternalError)
virtual void federationSynchronized (const char *label) throw ( RTI::FederateInternalError)
virtual void initiateFederateSave (const char *label) throw ( RTI::UnableToPerformSave, RTI::FederateInternalError)
virtual void federationNotSaved () throw ( RTI::FederateInternalError)
virtual void requestFederationRestoreSucceeded (const char *label) throw ( RTI::FederateInternalError)
virtual void requestFederationRestoreFailed (const char *label, const char *reason) throw ( RTI::FederateInternalError)
virtual void initiateFederateRestore (const char *label, RTI::FederateHandle handle) throw ( RTI::SpecifiedSaveLabelDoesNotExist, RTI::CouldNotRestore, RTI::FederateInternalError)
virtual void federationNotRestored () throw ( RTI::FederateInternalError)
virtual void startRegistrationForObjectClass (RTI::ObjectClassHandle theClass) throw ( RTI::ObjectClassNotPublished, RTI::FederateInternalError)
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 discoverObjectInstance (RTI::ObjectHandle theObject, RTI::ObjectClassHandle theObjectClass, const char *theObjectName) throw ( RTI::CouldNotDiscover, RTI::ObjectClassNotKnown, 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)
virtual void reflectAttributeValues (RTI::ObjectHandle theObject, const RTI::AttributeHandleValuePairSet &theAttributes, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateOwnsAttributes, RTI::FederateInternalError)
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)
virtual void receiveInteraction (RTI::InteractionClassHandle theInteraction, const RTI::ParameterHandleValuePairSet &theParameters, const char *theTag) throw ( RTI::InteractionClassNotKnown, RTI::InteractionParameterNotKnown, RTI::FederateInternalError)
virtual void removeObjectInstance (RTI::ObjectHandle theObject, const RTI::FedTime &theTime, const char *theTag, RTI::EventRetractionHandle theHandle) throw ( RTI::ObjectNotKnown, RTI::InvalidFederationTime, RTI::FederateInternalError)
virtual void removeObjectInstance (RTI::ObjectHandle theObject, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::FederateInternalError)
virtual void attributesInScope (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
virtual void attributesOutOfScope (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
virtual void provideAttributeValueUpdate (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError)
virtual void turnUpdatesOnForObjectInstance (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError)
virtual void turnUpdatesOffForObjectInstance (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError)
virtual void requestAttributeOwnershipAssumption (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &offeredAttributes, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAlreadyOwned, RTI::AttributeNotPublished, RTI::FederateInternalError)
virtual void attributeOwnershipDivestitureNotification (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &releasedAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeNotOwned, RTI::AttributeDivestitureWasNotRequested, RTI::FederateInternalError)
virtual void attributeOwnershipAcquisitionNotification (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &securedAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAcquisitionWasNotRequested, RTI::AttributeAlreadyOwned, RTI::AttributeNotPublished, RTI::FederateInternalError)
virtual void attributeOwnershipUnavailable (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAlreadyOwned, RTI::AttributeAcquisitionWasNotRequested, RTI::FederateInternalError)
virtual void requestAttributeOwnershipRelease (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &candidateAttributes, const char *theTag) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeNotOwned, RTI::FederateInternalError)
virtual void confirmAttributeOwnershipAcquisitionCancellation (RTI::ObjectHandle theObject, const RTI::AttributeHandleSet &theAttributes) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::AttributeAlreadyOwned, RTI::AttributeAcquisitionWasNotCanceled, RTI::FederateInternalError)
virtual void informAttributeOwnership (RTI::ObjectHandle theObject, RTI::AttributeHandle theAttribute, RTI::FederateHandle theOwner) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
virtual void attributeIsNotOwned (RTI::ObjectHandle theObject, RTI::AttributeHandle theAttribute) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
virtual void attributeOwnedByRTI (RTI::ObjectHandle theObject, RTI::AttributeHandle theAttribute) throw ( RTI::ObjectNotKnown, RTI::AttributeNotKnown, RTI::FederateInternalError)
virtual void timeRegulationEnabled (const RTI::FedTime &theFederateTime) throw ( RTI::InvalidFederationTime, RTI::EnableTimeRegulationWasNotPending, RTI::FederateInternalError)
virtual void timeConstrainedEnabled (const RTI::FedTime &theFederateTime) throw ( RTI::InvalidFederationTime, RTI::EnableTimeConstrainedWasNotPending, RTI::FederateInternalError)
virtual void timeAdvanceGrant (const RTI::FedTime &theTime) throw ( RTI::InvalidFederationTime, RTI::TimeAdvanceWasNotInProgress, RTI::FederateInternalError)
virtual void requestRetraction (RTI::EventRetractionHandle theHandle) throw ( RTI::EventNotKnown, RTI::FederateInternalError)
- Public Member Functions inherited from RTI::FederateAmbassador
virtual ~FederateAmbassador () throw (FederateInternalError)

Detailed Description

A basic Federate Ambassador implementation.

Member Function Documentation

void rtiSimple1516e.SimpleFederateAmbassador.discoverObjectInstance ( ObjectInstanceHandle  theObject,
ObjectClassHandle  theObjectClass,
String  objectName 
) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myObjectInstanceNameToHandleMap.

void rtiSimple1516e.SimpleFederateAmbassador.discoverObjectInstance ( ObjectInstanceHandle  theObject,
ObjectClassHandle  theObjectClass,
String  objectName,
FederateHandle  producingFederate 
) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myObjectInstanceNameToHandleMap.

void rtiSimple1516e.SimpleFederateAmbassador.federationNotRestored ( RestoreFailureReason  theRestoreFailureReason) throws FederateInternalError
inline

References rti1516.FEDERATE_REPORTED_FAILURE_DURING_RESTORE, rti1516.FEDERATE_RESIGNED_DURING_RESTORE, rtiSimple1516e.TalkAmbData.myReceivedFederationNotRestored, rtiSimple1516e.TalkAmbData.myRestoreFailureReason, rti1516e.RESTORE_ABORTED, rti1516.RTI_DETECTED_FAILURE_DURING_RESTORE, and rti1516.RTI_UNABLE_TO_RESTORE.

void rtiSimple1516e.SimpleFederateAmbassador.federationNotSaved ( SaveFailureReason  theSaveFailureReason) throws FederateInternalError
inline

References rti1516.FEDERATE_REPORTED_FAILURE_DURING_SAVE, rti1516.FEDERATE_RESIGNED_DURING_SAVE, rtiSimple1516e.TalkAmbData.myReceivedFederationNotSaved, rtiSimple1516e.TalkAmbData.mySaveFailureReason, rti1516.RTI_DETECTED_FAILURE_DURING_SAVE, rti1516.RTI_UNABLE_TO_SAVE, rti1516e.SAVE_ABORTED, and rti1516.SAVE_TIME_CANNOT_BE_HONORED.

void rtiSimple1516e.SimpleFederateAmbassador.federationRestoreBegun ( ) throws FederateInternalError
inlinevirtual

Reimplemented from NullFederateAmbassador.

References rtiSimple1516e.TalkAmbData.myReceivedFederationRestoreBegun.

void rtiSimple1516e.SimpleFederateAmbassador.federationRestored ( ) throws FederateInternalError
inlinevirtual

Reimplemented from NullFederateAmbassador.

References rtiSimple1516e.TalkAmbData.myReceivedFederationRestored.

void rtiSimple1516e.SimpleFederateAmbassador.federationRestoreStatusResponse ( FederateRestoreStatus[]  theFederateRestoreStatusVector) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myFederateHandleRestoreStatus, and rtiSimple1516e.TalkAmbData.myReceivedFederationRestoreStatusResponse.

void rtiSimple1516e.SimpleFederateAmbassador.federationSaved ( ) throws FederateInternalError
inlinevirtual

Reimplemented from NullFederateAmbassador.

References rtiSimple1516e.TalkAmbData.myReceivedFederationSaved.

void rtiSimple1516e.SimpleFederateAmbassador.federationSaveStatusResponse ( FederateHandleSaveStatusPair[]  theFederateStatusVector) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myFederateHandleSaveStatus, and rtiSimple1516e.TalkAmbData.myReceivedFederationSaveStatusResponse.

void rtiSimple1516e.SimpleFederateAmbassador.initiateFederateRestore ( String  label,
String  federateName,
FederateHandle  federateHandle 
) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myReceivedInitiateFederateRestore, rtiSimple1516e.TalkAmbData.myRestoreFederateHandle, and rtiSimple1516e.TalkAmbData.myRestoreLabel.

void rtiSimple1516e.SimpleFederateAmbassador.initiateFederateSave ( String  label) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myReceivedInitiateFederateSave, and rtiSimple1516e.TalkAmbData.mySaveLabel.

void rtiSimple1516e.SimpleFederateAmbassador.objectInstanceNameReservationFailed ( String  objectName) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myNameReservationReturned, and rtiSimple1516e.TalkAmbData.myNameReservationSucceeded.

void rtiSimple1516e.SimpleFederateAmbassador.objectInstanceNameReservationSucceeded ( String  objectName) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myNameReservationReturned, and rtiSimple1516e.TalkAmbData.myNameReservationSucceeded.

void rtiSimple1516e.SimpleFederateAmbassador.printAttributeHandleValueMap ( AttributeHandleValueMap  theAttributes)
inline

Referenced by rtiSimple1516e.SimpleFederateAmbassador.reflectAttributeValues().

void rtiSimple1516e.SimpleFederateAmbassador.printParameterHandleValueMap ( ParameterHandleValueMap  theParameters)
inline

Referenced by rtiSimple1516e.SimpleFederateAmbassador.receiveInteraction().

void rtiSimple1516e.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationTypeHandle  theTransport,
SupplementalReceiveInfo  receiveInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516e.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationTypeHandle  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
SupplementalReceiveInfo  receiveInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516e.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationTypeHandle  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
MessageRetractionHandle  retractionHandle,
SupplementalReceiveInfo  receiveInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516e.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationTypeHandle  theTransport,
SupplementalReflectInfo  reflectInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516e.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationTypeHandle  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
SupplementalReflectInfo  reflectInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516e.SimpleFederateAmbassador.removeObjectInstance ( ObjectInstanceHandle  theObject,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
SupplementalRemoveInfo  removeInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myObjectInstanceNameToHandleMap.

void rtiSimple1516e.SimpleFederateAmbassador.removeObjectInstance ( ObjectInstanceHandle  theObject,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
LogicalTime  theTime,
OrderType  receivedOrdering,
SupplementalRemoveInfo  removeInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myObjectInstanceNameToHandleMap.

void rtiSimple1516e.SimpleFederateAmbassador.removeObjectInstance ( ObjectInstanceHandle  theObject,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
LogicalTime  theTime,
OrderType  receivedOrdering,
MessageRetractionHandle  retractionHandle,
SupplementalRemoveInfo  removeInfo 
) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myObjectInstanceNameToHandleMap.

void rtiSimple1516e.SimpleFederateAmbassador.requestFederationRestoreFailed ( String  label) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myReceivedRequestFederationRestoreFailed, and rtiSimple1516e.TalkAmbData.myRestoreLabel.

void rtiSimple1516e.SimpleFederateAmbassador.requestFederationRestoreSucceeded ( String  label) throws FederateInternalError
inline

References rtiSimple1516e.TalkAmbData.myReceivedRequestFederationRestoreSucceeded, and rtiSimple1516e.TalkAmbData.myRestoreLabel.

The documentation for this class was generated from the following file:
Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)