Module hla.rti1516e

Package hla.rti1516e

Interface FederateAmbassador

All Known Implementing Classes:

NullFederateAmbassador

public interface FederateAmbassador

Federate must implement this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FederateAmbassador.SupplementalReceiveInfo
static interface	FederateAmbassador.SupplementalReflectInfo
static interface	FederateAmbassador.SupplementalRemoveInfo

Method Summary

Modifier and Type	Method	Description
void	announceSynchronizationPoint(String synchronizationPointLabel, byte[] userSuppliedTag)
void	attributeIsNotOwned(ObjectInstanceHandle theObject, AttributeHandle theAttribute)
void	attributeIsOwnedByRTI(ObjectInstanceHandle theObject, AttributeHandle theAttribute)
void	attributeOwnershipAcquisitionNotification(ObjectInstanceHandle theObject, AttributeHandleSet securedAttributes, byte[] userSuppliedTag)
void	attributeOwnershipUnavailable(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)
void	attributesInScope(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)
void	attributesOutOfScope(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)
void	confirmAttributeOwnershipAcquisitionCancellation(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)
void	confirmAttributeTransportationTypeChange(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, TransportationTypeHandle theTransportation)
void	confirmInteractionTransportationTypeChange(InteractionClassHandle theInteraction, TransportationTypeHandle theTransportation)
void	connectionLost(String faultDescription)
void	discoverObjectInstance(ObjectInstanceHandle theObject, ObjectClassHandle theObjectClass, String objectName)
void	discoverObjectInstance(ObjectInstanceHandle theObject, ObjectClassHandle theObjectClass, String objectName, FederateHandle producingFederate)
void	federationNotRestored(RestoreFailureReason reason)
void	federationNotSaved(SaveFailureReason reason)
void	federationRestoreBegun()
void	federationRestored()
void	federationRestoreStatusResponse(FederateRestoreStatus[] response)
void	federationSaved()
void	federationSaveStatusResponse(FederateHandleSaveStatusPair[] response)
void	federationSynchronized(String synchronizationPointLabel, FederateHandleSet failedToSyncSet)
void	informAttributeOwnership(ObjectInstanceHandle theObject, AttributeHandle theAttribute, FederateHandle theOwner)
void	initiateFederateRestore(String label, String federateName, FederateHandle federateHandle)
void	initiateFederateSave(String label)
void	initiateFederateSave(String label, LogicalTime time)
void	multipleObjectInstanceNameReservationFailed(Set<String> objectNames)
void	multipleObjectInstanceNameReservationSucceeded(Set<String> objectNames)
void	objectInstanceNameReservationFailed(String objectName)
void	objectInstanceNameReservationSucceeded(String objectName)
void	provideAttributeValueUpdate(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, byte[] userSuppliedTag)
void	receiveInteraction(InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, FederateAmbassador.SupplementalReceiveInfo receiveInfo)
void	receiveInteraction(InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, LogicalTime theTime, OrderType receivedOrdering, FederateAmbassador.SupplementalReceiveInfo receiveInfo)
void	receiveInteraction(InteractionClassHandle interactionClass, ParameterHandleValueMap theParameters, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle, FederateAmbassador.SupplementalReceiveInfo receiveInfo)
void	reflectAttributeValues(ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, FederateAmbassador.SupplementalReflectInfo reflectInfo)
void	reflectAttributeValues(ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, LogicalTime theTime, OrderType receivedOrdering, FederateAmbassador.SupplementalReflectInfo reflectInfo)
void	reflectAttributeValues(ObjectInstanceHandle theObject, AttributeHandleValueMap theAttributes, byte[] userSuppliedTag, OrderType sentOrdering, TransportationTypeHandle theTransport, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle, FederateAmbassador.SupplementalReflectInfo reflectInfo)
void	removeObjectInstance(ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, FederateAmbassador.SupplementalRemoveInfo removeInfo)
void	removeObjectInstance(ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime, OrderType receivedOrdering, FederateAmbassador.SupplementalRemoveInfo removeInfo)
void	removeObjectInstance(ObjectInstanceHandle theObject, byte[] userSuppliedTag, OrderType sentOrdering, LogicalTime theTime, OrderType receivedOrdering, MessageRetractionHandle retractionHandle, FederateAmbassador.SupplementalRemoveInfo removeInfo)
void	reportAttributeTransportationType(ObjectInstanceHandle theObject, AttributeHandle theAttribute, TransportationTypeHandle theTransportation)
void	reportFederationExecutions(FederationExecutionInformationSet theFederationExecutionInformationSet)
void	reportInteractionTransportationType(FederateHandle theFederate, InteractionClassHandle theInteraction, TransportationTypeHandle theTransportation)
void	requestAttributeOwnershipAssumption(ObjectInstanceHandle theObject, AttributeHandleSet offeredAttributes, byte[] userSuppliedTag)
void	requestAttributeOwnershipRelease(ObjectInstanceHandle theObject, AttributeHandleSet candidateAttributes, byte[] userSuppliedTag)
void	requestDivestitureConfirmation(ObjectInstanceHandle theObject, AttributeHandleSet offeredAttributes)
void	requestFederationRestoreFailed(String label)
void	requestFederationRestoreSucceeded(String label)
void	requestRetraction(MessageRetractionHandle theHandle)
void	startRegistrationForObjectClass(ObjectClassHandle theClass)
void	stopRegistrationForObjectClass(ObjectClassHandle theClass)
void	synchronizationPointRegistrationFailed(String synchronizationPointLabel, SynchronizationPointFailureReason reason)
void	synchronizationPointRegistrationSucceeded(String synchronizationPointLabel)
void	timeAdvanceGrant(LogicalTime theTime)
void	timeConstrainedEnabled(LogicalTime time)
void	timeRegulationEnabled(LogicalTime time)
void	turnInteractionsOff(InteractionClassHandle theHandle)
void	turnInteractionsOn(InteractionClassHandle theHandle)
void	turnUpdatesOffForObjectInstance(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)
void	turnUpdatesOnForObjectInstance(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes)
void	turnUpdatesOnForObjectInstance(ObjectInstanceHandle theObject, AttributeHandleSet theAttributes, String updateRateDesignator)

Method Details

connectionLost

void connectionLost(String faultDescription)
             throws FederateInternalError

Throws:

FederateInternalError

reportFederationExecutions

void reportFederationExecutions(FederationExecutionInformationSet theFederationExecutionInformationSet)
                         throws FederateInternalError

Throws:

FederateInternalError

synchronizationPointRegistrationSucceeded

void synchronizationPointRegistrationSucceeded(String synchronizationPointLabel)
                                        throws FederateInternalError

Throws:

FederateInternalError

synchronizationPointRegistrationFailed

void synchronizationPointRegistrationFailed(String synchronizationPointLabel,
 SynchronizationPointFailureReason reason)
                                     throws FederateInternalError

Throws:

FederateInternalError

announceSynchronizationPoint

void announceSynchronizationPoint(String synchronizationPointLabel,
 byte[] userSuppliedTag)
                           throws FederateInternalError

Throws:

FederateInternalError

federationSynchronized

void federationSynchronized(String synchronizationPointLabel,
 FederateHandleSet failedToSyncSet)
                     throws FederateInternalError

Throws:

FederateInternalError

initiateFederateSave

void initiateFederateSave(String label)
                   throws FederateInternalError

Throws:

FederateInternalError

initiateFederateSave

void initiateFederateSave(String label,
 LogicalTime time)
                   throws FederateInternalError

Throws:

FederateInternalError

federationSaved

void federationSaved()
              throws FederateInternalError

Throws:

FederateInternalError

federationNotSaved

void federationNotSaved(SaveFailureReason reason)
                 throws FederateInternalError

Throws:

FederateInternalError

federationSaveStatusResponse

void federationSaveStatusResponse(FederateHandleSaveStatusPair[] response)
                           throws FederateInternalError

Throws:

FederateInternalError

requestFederationRestoreSucceeded

void requestFederationRestoreSucceeded(String label)
                                throws FederateInternalError

Throws:

FederateInternalError

requestFederationRestoreFailed

void requestFederationRestoreFailed(String label)
                             throws FederateInternalError

Throws:

FederateInternalError

federationRestoreBegun

void federationRestoreBegun()
                     throws FederateInternalError

Throws:

FederateInternalError

initiateFederateRestore

void initiateFederateRestore(String label,
 String federateName,
 FederateHandle federateHandle)
                      throws FederateInternalError

Throws:

FederateInternalError

federationRestored

void federationRestored()
                 throws FederateInternalError

Throws:

FederateInternalError

federationNotRestored

void federationNotRestored(RestoreFailureReason reason)
                    throws FederateInternalError

Throws:

FederateInternalError

federationRestoreStatusResponse

void federationRestoreStatusResponse(FederateRestoreStatus[] response)
                              throws FederateInternalError

Throws:

FederateInternalError

startRegistrationForObjectClass

void startRegistrationForObjectClass(ObjectClassHandle theClass)
                              throws FederateInternalError

Throws:

FederateInternalError

stopRegistrationForObjectClass

void stopRegistrationForObjectClass(ObjectClassHandle theClass)
                             throws FederateInternalError

Throws:

FederateInternalError

turnInteractionsOn

void turnInteractionsOn(InteractionClassHandle theHandle)
                 throws FederateInternalError

Throws:

FederateInternalError

turnInteractionsOff

void turnInteractionsOff(InteractionClassHandle theHandle)
                  throws FederateInternalError

Throws:

FederateInternalError

objectInstanceNameReservationSucceeded

void objectInstanceNameReservationSucceeded(String objectName)
                                     throws FederateInternalError

Throws:

FederateInternalError

objectInstanceNameReservationFailed

void objectInstanceNameReservationFailed(String objectName)
                                  throws FederateInternalError

Throws:

FederateInternalError

multipleObjectInstanceNameReservationSucceeded

void multipleObjectInstanceNameReservationSucceeded(Set<String> objectNames)
                                             throws FederateInternalError

Throws:

FederateInternalError

multipleObjectInstanceNameReservationFailed

void multipleObjectInstanceNameReservationFailed(Set<String> objectNames)
                                          throws FederateInternalError

Throws:

FederateInternalError

discoverObjectInstance

void discoverObjectInstance(ObjectInstanceHandle theObject,
 ObjectClassHandle theObjectClass,
 String objectName)
                     throws FederateInternalError

Throws:

FederateInternalError

discoverObjectInstance

void discoverObjectInstance(ObjectInstanceHandle theObject,
 ObjectClassHandle theObjectClass,
 String objectName,
 FederateHandle producingFederate)
                     throws FederateInternalError

Throws:

FederateInternalError

reflectAttributeValues

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

Throws:

FederateInternalError

reflectAttributeValues

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

Throws:

FederateInternalError

reflectAttributeValues

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

Throws:

FederateInternalError

receiveInteraction

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

Throws:

FederateInternalError

receiveInteraction

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

Throws:

FederateInternalError

receiveInteraction

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

Throws:

FederateInternalError

removeObjectInstance

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

Throws:

FederateInternalError

removeObjectInstance

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

Throws:

FederateInternalError

removeObjectInstance

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

Throws:

FederateInternalError

attributesInScope

void attributesInScope(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes)
                throws FederateInternalError

Throws:

FederateInternalError

attributesOutOfScope

void attributesOutOfScope(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes)
                   throws FederateInternalError

Throws:

FederateInternalError

provideAttributeValueUpdate

void provideAttributeValueUpdate(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes,
 byte[] userSuppliedTag)
                          throws FederateInternalError

Throws:

FederateInternalError

turnUpdatesOnForObjectInstance

void turnUpdatesOnForObjectInstance(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes)
                             throws FederateInternalError

Throws:

FederateInternalError

turnUpdatesOnForObjectInstance

void turnUpdatesOnForObjectInstance(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes,
 String updateRateDesignator)
                             throws FederateInternalError

Throws:

FederateInternalError

turnUpdatesOffForObjectInstance

void turnUpdatesOffForObjectInstance(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes)
                              throws FederateInternalError

Throws:

FederateInternalError

confirmAttributeTransportationTypeChange

void confirmAttributeTransportationTypeChange(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes,
 TransportationTypeHandle theTransportation)
                                       throws FederateInternalError

Throws:

FederateInternalError

reportAttributeTransportationType

void reportAttributeTransportationType(ObjectInstanceHandle theObject,
 AttributeHandle theAttribute,
 TransportationTypeHandle theTransportation)
                                throws FederateInternalError

Throws:

FederateInternalError

confirmInteractionTransportationTypeChange

void confirmInteractionTransportationTypeChange(InteractionClassHandle theInteraction,
 TransportationTypeHandle theTransportation)
                                         throws FederateInternalError

Throws:

FederateInternalError

reportInteractionTransportationType

void reportInteractionTransportationType(FederateHandle theFederate,
 InteractionClassHandle theInteraction,
 TransportationTypeHandle theTransportation)
                                  throws FederateInternalError

Throws:

FederateInternalError

requestAttributeOwnershipAssumption

void requestAttributeOwnershipAssumption(ObjectInstanceHandle theObject,
 AttributeHandleSet offeredAttributes,
 byte[] userSuppliedTag)
                                  throws FederateInternalError

Throws:

FederateInternalError

requestDivestitureConfirmation

void requestDivestitureConfirmation(ObjectInstanceHandle theObject,
 AttributeHandleSet offeredAttributes)
                             throws FederateInternalError

Throws:

FederateInternalError

attributeOwnershipAcquisitionNotification

void attributeOwnershipAcquisitionNotification(ObjectInstanceHandle theObject,
 AttributeHandleSet securedAttributes,
 byte[] userSuppliedTag)
                                        throws FederateInternalError

Throws:

FederateInternalError

attributeOwnershipUnavailable

void attributeOwnershipUnavailable(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes)
                            throws FederateInternalError

Throws:

FederateInternalError

requestAttributeOwnershipRelease

void requestAttributeOwnershipRelease(ObjectInstanceHandle theObject,
 AttributeHandleSet candidateAttributes,
 byte[] userSuppliedTag)
                               throws FederateInternalError

Throws:

FederateInternalError

confirmAttributeOwnershipAcquisitionCancellation

void confirmAttributeOwnershipAcquisitionCancellation(ObjectInstanceHandle theObject,
 AttributeHandleSet theAttributes)
                                               throws FederateInternalError

Throws:

FederateInternalError

informAttributeOwnership

void informAttributeOwnership(ObjectInstanceHandle theObject,
 AttributeHandle theAttribute,
 FederateHandle theOwner)
                       throws FederateInternalError

Throws:

FederateInternalError

attributeIsNotOwned

void attributeIsNotOwned(ObjectInstanceHandle theObject,
 AttributeHandle theAttribute)
                  throws FederateInternalError

Throws:

FederateInternalError

attributeIsOwnedByRTI

void attributeIsOwnedByRTI(ObjectInstanceHandle theObject,
 AttributeHandle theAttribute)
                    throws FederateInternalError

Throws:

FederateInternalError

timeRegulationEnabled

void timeRegulationEnabled(LogicalTime time)
                    throws FederateInternalError

Throws:

FederateInternalError

timeConstrainedEnabled

void timeConstrainedEnabled(LogicalTime time)
                     throws FederateInternalError

Throws:

FederateInternalError

timeAdvanceGrant

void timeAdvanceGrant(LogicalTime theTime)
               throws FederateInternalError

Throws:

FederateInternalError

requestRetraction

void requestRetraction(MessageRetractionHandle theHandle)
                throws FederateInternalError

Throws:

FederateInternalError