MAK RTIspy API Documentation for HLA 1516
Public Member Functions
rtiSimple1516.SimpleFederateAmbassador Class Reference

A basic Federate Ambassador implementation. More...

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

List of all members.

Public Member Functions

void printAttributeHandleValueMap (AttributeHandleValueMap theAttributes)
void printParameterHandleValueMap (ParameterHandleValueMap theParameters)
void discoverObjectInstance (ObjectInstanceHandle theObject, ObjectClassHandle theObjectClass, String objectName) throws CouldNotDiscover, ObjectClassNotRecognized, FederateInternalError
void objectInstanceNameReservationSucceeded (String objectName) throws UnknownName, FederateInternalError
void objectInstanceNameReservationFailed (String objectName) throws UnknownName, FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, RegionHandleSet sentRegions) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering, RegionHandleSet sentRegions) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, InvalidLogicalTime, FederateInternalError
void reflectAttributeValues (ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle, RegionHandleSet sentRegions) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, InvalidLogicalTime, FederateInternalError
void removeObjectInstance (ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering) throws ObjectInstanceNotKnown, FederateInternalError
void removeObjectInstance (ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime, OrderType receivedOrdering) throws ObjectInstanceNotKnown, FederateInternalError
void removeObjectInstance (ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle) throws ObjectInstanceNotKnown, InvalidLogicalTime, FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, RegionHandleSet sentRegions) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering, RegionHandleSet regions) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle messageRetractionHandle) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, InvalidLogicalTime, FederateInternalError
void receiveInteraction (InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationType theTransport, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle messageRetractionHandle, RegionHandleSet sentRegions) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, InvalidLogicalTime, FederateInternalError
void initiateFederateSave (String label) throws UnableToPerformSave, 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, FederateHandle federateHandle) throws SpecifiedSaveLabelDoesNotExist, CouldNotInitiateRestore, FederateInternalError
void federationRestored () throws FederateInternalError
void federationNotRestored (RestoreFailureReason theRestoreFailureReason) throws FederateInternalError
void federationRestoreStatusResponse (FederateHandleRestoreStatusPair[] theFederateRestoreStatusVector) throws FederateInternalError

Detailed Description

A basic Federate Ambassador implementation.

Member Function Documentation

void rtiSimple1516.SimpleFederateAmbassador.discoverObjectInstance ( ObjectInstanceHandle  theObject,
ObjectClassHandle  theObjectClass,
String  objectName 
) throws CouldNotDiscover, ObjectClassNotRecognized, FederateInternalError [inline]
void rtiSimple1516.SimpleFederateAmbassador.federationNotRestored ( RestoreFailureReason  theRestoreFailureReason) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedFederationNotRestored, and rtiSimple1516.TalkAmbData.myRestoreFailureReason.

void rtiSimple1516.SimpleFederateAmbassador.federationNotSaved ( SaveFailureReason  theSaveFailureReason) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedFederationNotSaved, and rtiSimple1516.TalkAmbData.mySaveFailureReason.

void rtiSimple1516.SimpleFederateAmbassador.federationRestoreBegun ( ) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedFederationRestoreBegun.

void rtiSimple1516.SimpleFederateAmbassador.federationRestored ( ) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedFederationRestored.

void rtiSimple1516.SimpleFederateAmbassador.federationRestoreStatusResponse ( FederateHandleRestoreStatusPair[]  theFederateRestoreStatusVector) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myFederateHandleRestoreStatus, and rtiSimple1516.TalkAmbData.myReceivedFederationRestoreStatusResponse.

void rtiSimple1516.SimpleFederateAmbassador.federationSaved ( ) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedFederationSaved.

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

References rtiSimple1516.TalkAmbData.myFederateHandleSaveStatus, and rtiSimple1516.TalkAmbData.myReceivedFederationSaveStatusResponse.

void rtiSimple1516.SimpleFederateAmbassador.initiateFederateRestore ( String  label,
FederateHandle  federateHandle 
) throws SpecifiedSaveLabelDoesNotExist, CouldNotInitiateRestore, FederateInternalError [inline]

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

void rtiSimple1516.SimpleFederateAmbassador.initiateFederateSave ( String  label) throws UnableToPerformSave, FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedInitiateFederateSave, and rtiSimple1516.TalkAmbData.mySaveLabel.

void rtiSimple1516.SimpleFederateAmbassador.objectInstanceNameReservationFailed ( String  objectName) throws UnknownName, FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myNameReservationReturned, and rtiSimple1516.TalkAmbData.myNameReservationSucceeded.

void rtiSimple1516.SimpleFederateAmbassador.objectInstanceNameReservationSucceeded ( String  objectName) throws UnknownName, FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myNameReservationReturned, and rtiSimple1516.TalkAmbData.myNameReservationSucceeded.

void rtiSimple1516.SimpleFederateAmbassador.printAttributeHandleValueMap ( AttributeHandleValueMap  theAttributes) [inline]

Referenced by rtiSimple1516.SimpleFederateAmbassador.reflectAttributeValues().

void rtiSimple1516.SimpleFederateAmbassador.printParameterHandleValueMap ( ParameterHandleValueMap  theParameters) [inline]

Referenced by rtiSimple1516.SimpleFederateAmbassador.receiveInteraction().

void rtiSimple1516.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport 
) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
RegionHandleSet  sentRegions 
) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering 
) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
RegionHandleSet  regions 
) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
MessageRetractionHandle  messageRetractionHandle 
) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, InvalidLogicalTime, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.receiveInteraction ( InteractionClassHandle  interactionClass,
ParameterHandleValueMap  theParameters,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
MessageRetractionHandle  messageRetractionHandle,
RegionHandleSet  sentRegions 
) throws InteractionClassNotRecognized, InteractionParameterNotRecognized, InteractionClassNotSubscribed, InvalidLogicalTime, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printParameterHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport 
) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
RegionHandleSet  sentRegions 
) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering 
) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
RegionHandleSet  sentRegions 
) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
MessageRetractionHandle  retractionHandle 
) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, InvalidLogicalTime, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.reflectAttributeValues ( ObjectInstanceHandle  theObject,
AttributeHandleValueMap  theAttributes,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
TransportationType  theTransport,
LogicalTime  theTime,
OrderType  receivedOrdering,
MessageRetractionHandle  retractionHandle,
RegionHandleSet  sentRegions 
) throws ObjectInstanceNotKnown, AttributeNotRecognized, AttributeNotSubscribed, InvalidLogicalTime, FederateInternalError [inline]

References rtiSimple1516.SimpleFederateAmbassador.printAttributeHandleValueMap().

void rtiSimple1516.SimpleFederateAmbassador.removeObjectInstance ( ObjectInstanceHandle  theObject,
byte[]  userSuppliedTag,
OrderType  sentOrdering 
) throws ObjectInstanceNotKnown, FederateInternalError [inline]
void rtiSimple1516.SimpleFederateAmbassador.removeObjectInstance ( ObjectInstanceHandle  theObject,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
LogicalTime  theTime,
OrderType  receivedOrdering 
) throws ObjectInstanceNotKnown, FederateInternalError [inline]
void rtiSimple1516.SimpleFederateAmbassador.removeObjectInstance ( ObjectInstanceHandle  theObject,
byte[]  userSuppliedTag,
OrderType  sentOrdering,
LogicalTime  theTime,
OrderType  receivedOrdering,
MessageRetractionHandle  retractionHandle 
) throws ObjectInstanceNotKnown, InvalidLogicalTime, FederateInternalError [inline]
void rtiSimple1516.SimpleFederateAmbassador.requestFederationRestoreFailed ( String  label) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedRequestFederationRestoreFailed, and rtiSimple1516.TalkAmbData.myRestoreLabel.

void rtiSimple1516.SimpleFederateAmbassador.requestFederationRestoreSucceeded ( String  label) throws FederateInternalError [inline]

References rtiSimple1516.TalkAmbData.myReceivedRequestFederationRestoreSucceeded, and rtiSimple1516.TalkAmbData.myRestoreLabel.

The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)