MAK RTIspy API Documentation for HLA 4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
FederateAmbassadorProxy Class Reference
+ Inheritance diagram for FederateAmbassadorProxy:
+ Collaboration diagram for FederateAmbassadorProxy:

Public Member Functions

 FederateAmbassadorProxy (FederateProxy *federateProxy)
 
virtual ~FederateAmbassadorProxy ()
 
virtual void connectionLost (std::wstring const &faultDescription) override
 4.4 More...
 
virtual void reportFederationExecutions (rti1516_2025::FederationExecutionInformationVector const &theFederationExecutionInformationList) override
 4.8 More...
 
virtual void reportFederationExecutionMembers (std::wstring const &federationName, rti1516_2025::FederationExecutionMemberInformationVector const &report) override
 4.10 More...
 
virtual void reportFederationExecutionDoesNotExist (std::wstring const &federationName) override
 4.11 More...
 
virtual void federateResigned (std::wstring const &reasonForResignDescription) override
 4.13 More...
 
virtual void objectInstanceNameReservationSucceeded (std::wstring const &theObjectInstanceName) override
 6.3 More...
 
virtual void objectInstanceNameReservationFailed (std::wstring const &theObjectInstanceName) override
 6.3 More...
 
virtual void multipleObjectInstanceNameReservationSucceeded (std::set< std::wstring > const &theObjectInstanceNames) override
 6.6 More...
 
virtual void multipleObjectInstanceNameReservationFailed (std::set< std::wstring > const &theObjectInstanceNames) override
 6.6 More...
 
virtual void discoverObjectInstance (rti1516_2025::ObjectInstanceHandle const &theObject, rti1516_2025::ObjectClassHandle const &theObjectClass, std::wstring const &theObjectInstanceName, rti1516_2025::FederateHandle const &producingFederate) override
 
virtual void reflectAttributeValues (rti1516_2025::ObjectInstanceHandle const &objectInstance, rti1516_2025::AttributeHandleValueMap const &attributeValues, rti1516_2025::VariableLengthData const &userSuppliedTag, rti1516_2025::TransportationTypeHandle const &transportationType, rti1516_2025::FederateHandle const &producingFederate, rti1516_2025::RegionHandleSet const *optionalSentRegions) override
 
virtual void reflectAttributeValues (rti1516_2025::ObjectInstanceHandle const &objectInstance, rti1516_2025::AttributeHandleValueMap const &attributeValues, rti1516_2025::VariableLengthData const &userSuppliedTag, rti1516_2025::TransportationTypeHandle const &transportationType, rti1516_2025::FederateHandle const &producingFederate, rti1516_2025::RegionHandleSet const *optionalSentRegions, rti1516_2025::LogicalTime const &time, rti1516_2025::OrderType sentOrderType, rti1516_2025::OrderType receivedOrderType, rti1516_2025::MessageRetractionHandle const *optionalRetraction) override
 
virtual void receiveInteraction (rti1516_2025::InteractionClassHandle const &interactionClass, rti1516_2025::ParameterHandleValueMap const &parameterValues, rti1516_2025::VariableLengthData const &userSuppliedTag, rti1516_2025::TransportationTypeHandle const &transportationType, rti1516_2025::FederateHandle const &producingFederate, rti1516_2025::RegionHandleSet const *optionalSentRegions) override
 
virtual void receiveInteraction (rti1516_2025::InteractionClassHandle const &interactionClass, rti1516_2025::ParameterHandleValueMap const &parameterValues, rti1516_2025::VariableLengthData const &userSuppliedTag, rti1516_2025::TransportationTypeHandle const &transportationType, rti1516_2025::FederateHandle const &producingFederate, rti1516_2025::RegionHandleSet const *optionalSentRegions, rti1516_2025::LogicalTime const &time, rti1516_2025::OrderType sentOrderType, rti1516_2025::OrderType receivedOrderType, rti1516_2025::MessageRetractionHandle const *optionalRetraction) override
 
virtual void removeObjectInstance (rti1516_2025::ObjectInstanceHandle const &objectInstance, rti1516_2025::VariableLengthData const &userSuppliedTag, rti1516_2025::FederateHandle const &producingFederate) override
 
virtual void removeObjectInstance (rti1516_2025::ObjectInstanceHandle const &objectInstance, rti1516_2025::VariableLengthData const &userSuppliedTag, rti1516_2025::FederateHandle const &producingFederate, rti1516_2025::LogicalTime const &time, rti1516_2025::OrderType sentOrderType, rti1516_2025::OrderType receivedOrderType, rti1516_2025::MessageRetractionHandle const *optionalRetraction) override
 
virtual void confirmAttributeTransportationTypeChange (rti1516_2025::ObjectInstanceHandle const &theObject, rti1516_2025::AttributeHandleSet const &theAttributes, rti1516_2025::TransportationTypeHandle const &theTransportation) override
 
virtual void reportAttributeTransportationType (rti1516_2025::ObjectInstanceHandle const &theObject, rti1516_2025::AttributeHandle const &theAttribute, rti1516_2025::TransportationTypeHandle const &theTransportation) override
 
virtual void reportInteractionTransportationType (rti1516_2025::FederateHandle const &federateHandle, rti1516_2025::InteractionClassHandle const &theInteraction, rti1516_2025::TransportationTypeHandle const &theTransportation) override
 
virtual void confirmInteractionTransportationTypeChange (rti1516_2025::InteractionClassHandle const &theInteraction, rti1516_2025::TransportationTypeHandle const &theTransportation) override
 
- Public Member Functions inherited from rti1516_2025::NullFederateAmbassador
 ~NullFederateAmbassador () noexceptoverride=default
 
void connectionLost (std::wstring const &faultDescription) override
 
void reportFederationExecutions (FederationExecutionInformationVector const &report) override
 
void reportFederationExecutionMembers (std::wstring const &federationName, FederationExecutionMemberInformationVector const &report) override
 
void reportFederationExecutionDoesNotExist (std::wstring const &federationName) override
 
void federateResigned (std::wstring const &reasonForResignDescription) override
 
void synchronizationPointRegistrationSucceeded (std::wstring const &synchronizationPointLabel) override
 
void synchronizationPointRegistrationFailed (std::wstring const &synchronizationPointLabel, SynchronizationPointFailureReason reason) override
 
void announceSynchronizationPoint (std::wstring const &synchronizationPointLabel, VariableLengthData const &userSuppliedTag) override
 
void federationSynchronized (std::wstring const &synchronizationPointLabel, FederateHandleSet const &failedToSyncSet) override
 
void initiateFederateSave (std::wstring const &label) override
 
void initiateFederateSave (std::wstring const &label, LogicalTime const &time) override
 
void federationSaved () override
 
void federationNotSaved (SaveFailureReason reason) override
 
void federationSaveStatusResponse (FederateHandleSaveStatusPairVector const &response) override
 
void requestFederationRestoreSucceeded (std::wstring const &label) override
 
void requestFederationRestoreFailed (std::wstring const &label) override
 
void federationRestoreBegun () override
 
void initiateFederateRestore (std::wstring const &label, std::wstring const &federateName, FederateHandle const &postRestoreFederateHandle) override
 
void federationRestored () override
 
void federationNotRestored (RestoreFailureReason reason) override
 
void federationRestoreStatusResponse (FederateRestoreStatusVector const &response) override
 
void startRegistrationForObjectClass (ObjectClassHandle const &objectClass) override
 
void stopRegistrationForObjectClass (ObjectClassHandle const &objectClass) override
 
void turnInteractionsOn (InteractionClassHandle const &interactionClass) override
 
void turnInteractionsOff (InteractionClassHandle const &interactionClass) override
 
void objectInstanceNameReservationSucceeded (std::wstring const &objectInstanceName) override
 
void objectInstanceNameReservationFailed (std::wstring const &objectInstanceName) override
 
void multipleObjectInstanceNameReservationSucceeded (std::set< std::wstring > const &objectInstanceNames) override
 
void multipleObjectInstanceNameReservationFailed (std::set< std::wstring > const &objectInstanceNames) override
 
void discoverObjectInstance (ObjectInstanceHandle const &objectInstance, ObjectClassHandle const &objectClass, std::wstring const &objectInstanceName, FederateHandle const &producingFederate) override
 
void reflectAttributeValues (ObjectInstanceHandle const &objectInstance, AttributeHandleValueMap const &attributeValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, RegionHandleSet const *optionalSentRegions) override
 
void reflectAttributeValues (ObjectInstanceHandle const &objectInstance, AttributeHandleValueMap const &attributeValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, RegionHandleSet const *optionalSentRegions, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
 
void receiveInteraction (InteractionClassHandle const &interactionClass, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, const RegionHandleSet *optionalSentRegions) override
 
void receiveInteraction (InteractionClassHandle const &interactionClass, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, RegionHandleSet const *optionalSentRegions, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
 
void receiveDirectedInteraction (InteractionClassHandle const &interactionClass, ObjectInstanceHandle const &objectInstance, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate) override
 
void receiveDirectedInteraction (InteractionClassHandle const &interactionClass, ObjectInstanceHandle const &objectInstance, ParameterHandleValueMap const &parameterValues, VariableLengthData const &userSuppliedTag, TransportationTypeHandle const &transportationType, FederateHandle const &producingFederate, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
 
void removeObjectInstance (ObjectInstanceHandle const &objectInstance, VariableLengthData const &userSuppliedTag, FederateHandle const &producingFederate) override
 
void removeObjectInstance (ObjectInstanceHandle const &objectInstance, VariableLengthData const &userSuppliedTag, FederateHandle const &producingFederate, LogicalTime const &time, OrderType sentOrderType, OrderType receivedOrderType, MessageRetractionHandle const *optionalRetraction) override
 
void attributesInScope (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
 
void attributesOutOfScope (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
 
void provideAttributeValueUpdate (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, VariableLengthData const &userSuppliedTag) override
 
void turnUpdatesOnForObjectInstance (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
 
void turnUpdatesOnForObjectInstance (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, std::wstring const &updateRateDesignator) override
 
void turnUpdatesOffForObjectInstance (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
 
void confirmAttributeTransportationTypeChange (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, TransportationTypeHandle const &transportationType) override
 
void reportAttributeTransportationType (ObjectInstanceHandle const &objectInstance, AttributeHandle const &attribute, TransportationTypeHandle const &transportationType) override
 
void confirmInteractionTransportationTypeChange (InteractionClassHandle const &interactionClass, TransportationTypeHandle const &transportationType) override
 
void reportInteractionTransportationType (FederateHandle const &federate, InteractionClassHandle const &interactionClass, TransportationTypeHandle const &transportationType) override
 
void requestAttributeOwnershipAssumption (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &offeredAttributes, VariableLengthData const &userSuppliedTag) override
 
void requestDivestitureConfirmation (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &releasedAttributes, VariableLengthData const &userSuppliedTag) override
 
void attributeOwnershipAcquisitionNotification (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &securedAttributes, VariableLengthData const &userSuppliedTag) override
 
void attributeOwnershipUnavailable (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, VariableLengthData const &userSuppliedTag) override
 
void requestAttributeOwnershipRelease (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &candidateAttributes, VariableLengthData const &userSuppliedTag) override
 
void confirmAttributeOwnershipAcquisitionCancellation (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
 
void informAttributeOwnership (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes, FederateHandle const &owner) override
 
void attributeIsNotOwned (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
 
void attributeIsOwnedByRTI (ObjectInstanceHandle const &objectInstance, AttributeHandleSet const &attributes) override
 
void timeRegulationEnabled (LogicalTime const &time) override
 
void timeConstrainedEnabled (LogicalTime const &time) override
 
void flushQueueGrant (LogicalTime const &time, LogicalTime const &optimisticTime) override
 
void timeAdvanceGrant (LogicalTime const &time) override
 
void requestRetraction (MessageRetractionHandle const &retraction) override
 
- Public Member Functions inherited from rti1516_2025::FederateAmbassador
virtual ~FederateAmbassador () noexcept=0
 

Protected Member Functions

void rtiAttributeValuesToFedProAttributeValues (rti1516_2025::AttributeHandleValueMap const &rtiAttributeValues, rti1516_2025::fedpro::AttributeHandleValueMap *fedProAttributeValues)
 Convert the provided RTI attribute handle value map into the federate protocol map. More...
 
virtual void rtiParamValuesToFedProParamValues (rti1516_2025::ParameterHandleValueMap const &rtiParameterValues, rti1516_2025::fedpro::ParameterHandleValueMap *fedProParameterValues)
 Convert the provided RTI parameter handle value map into the federate protocol map. More...
 
virtual void rtiRegionsToFedProRegions (rti1516_2025::RegionHandleSet const *rtiRegions, rti1516_2025::fedpro::ConveyedRegionSet *fedProRegions)
 Convert the provided RTI region set into the federate protocol region set. More...
 
- Protected Member Functions inherited from rti1516_2025::FederateAmbassador
 FederateAmbassador ()
 

Protected Attributes

std::vector< char > myMessageBuffer
 
std::string myStringBuffer
 
rti1516_2025::VariableLengthData myVarDataBuffer
 
FederateProxymyFederateProxy
 

Constructor & Destructor Documentation

FederateAmbassadorProxy::FederateAmbassadorProxy ( FederateProxy federateProxy)
virtual FederateAmbassadorProxy::~FederateAmbassadorProxy ( )
virtual

Member Function Documentation

virtual void FederateAmbassadorProxy::confirmAttributeTransportationTypeChange ( rti1516_2025::ObjectInstanceHandle const &  theObject,
rti1516_2025::AttributeHandleSet const &  theAttributes,
rti1516_2025::TransportationTypeHandle const &  theTransportation 
)
overridevirtual
virtual void FederateAmbassadorProxy::confirmInteractionTransportationTypeChange ( rti1516_2025::InteractionClassHandle const &  theInteraction,
rti1516_2025::TransportationTypeHandle const &  theTransportation 
)
overridevirtual
virtual void FederateAmbassadorProxy::connectionLost ( std::wstring const &  faultDescription)
overridevirtual

4.4

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::discoverObjectInstance ( rti1516_2025::ObjectInstanceHandle const &  theObject,
rti1516_2025::ObjectClassHandle const &  theObjectClass,
std::wstring const &  theObjectInstanceName,
rti1516_2025::FederateHandle const &  producingFederate 
)
overridevirtual
virtual void FederateAmbassadorProxy::federateResigned ( std::wstring const &  reasonForResignDescription)
overridevirtual

4.13

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::multipleObjectInstanceNameReservationFailed ( std::set< std::wstring > const &  objectInstanceNames)
overridevirtual

6.6

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::multipleObjectInstanceNameReservationSucceeded ( std::set< std::wstring > const &  objectInstanceNames)
overridevirtual

6.6

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::objectInstanceNameReservationFailed ( std::wstring const &  objectInstanceName)
overridevirtual

6.3

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::objectInstanceNameReservationSucceeded ( std::wstring const &  objectInstanceName)
overridevirtual

6.3

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::receiveInteraction ( rti1516_2025::InteractionClassHandle const &  interactionClass,
rti1516_2025::ParameterHandleValueMap const &  parameterValues,
rti1516_2025::VariableLengthData const &  userSuppliedTag,
rti1516_2025::TransportationTypeHandle const &  transportationType,
rti1516_2025::FederateHandle const &  producingFederate,
rti1516_2025::RegionHandleSet const *  optionalSentRegions 
)
overridevirtual
virtual void FederateAmbassadorProxy::receiveInteraction ( rti1516_2025::InteractionClassHandle const &  interactionClass,
rti1516_2025::ParameterHandleValueMap const &  parameterValues,
rti1516_2025::VariableLengthData const &  userSuppliedTag,
rti1516_2025::TransportationTypeHandle const &  transportationType,
rti1516_2025::FederateHandle const &  producingFederate,
rti1516_2025::RegionHandleSet const *  optionalSentRegions,
rti1516_2025::LogicalTime const &  time,
rti1516_2025::OrderType  sentOrderType,
rti1516_2025::OrderType  receivedOrderType,
rti1516_2025::MessageRetractionHandle const *  optionalRetraction 
)
overridevirtual
virtual void FederateAmbassadorProxy::reflectAttributeValues ( rti1516_2025::ObjectInstanceHandle const &  objectInstance,
rti1516_2025::AttributeHandleValueMap const &  attributeValues,
rti1516_2025::VariableLengthData const &  userSuppliedTag,
rti1516_2025::TransportationTypeHandle const &  transportationType,
rti1516_2025::FederateHandle const &  producingFederate,
rti1516_2025::RegionHandleSet const *  optionalSentRegions 
)
overridevirtual
virtual void FederateAmbassadorProxy::reflectAttributeValues ( rti1516_2025::ObjectInstanceHandle const &  objectInstance,
rti1516_2025::AttributeHandleValueMap const &  attributeValues,
rti1516_2025::VariableLengthData const &  userSuppliedTag,
rti1516_2025::TransportationTypeHandle const &  transportationType,
rti1516_2025::FederateHandle const &  producingFederate,
rti1516_2025::RegionHandleSet const *  optionalSentRegions,
rti1516_2025::LogicalTime const &  time,
rti1516_2025::OrderType  sentOrderType,
rti1516_2025::OrderType  receivedOrderType,
rti1516_2025::MessageRetractionHandle const *  optionalRetraction 
)
overridevirtual
virtual void FederateAmbassadorProxy::removeObjectInstance ( rti1516_2025::ObjectInstanceHandle const &  objectInstance,
rti1516_2025::VariableLengthData const &  userSuppliedTag,
rti1516_2025::FederateHandle const &  producingFederate 
)
overridevirtual
virtual void FederateAmbassadorProxy::removeObjectInstance ( rti1516_2025::ObjectInstanceHandle const &  objectInstance,
rti1516_2025::VariableLengthData const &  userSuppliedTag,
rti1516_2025::FederateHandle const &  producingFederate,
rti1516_2025::LogicalTime const &  time,
rti1516_2025::OrderType  sentOrderType,
rti1516_2025::OrderType  receivedOrderType,
rti1516_2025::MessageRetractionHandle const *  optionalRetraction 
)
overridevirtual
virtual void FederateAmbassadorProxy::reportAttributeTransportationType ( rti1516_2025::ObjectInstanceHandle const &  theObject,
rti1516_2025::AttributeHandle const &  theAttribute,
rti1516_2025::TransportationTypeHandle const &  theTransportation 
)
overridevirtual
virtual void FederateAmbassadorProxy::reportFederationExecutionDoesNotExist ( std::wstring const &  federationName)
overridevirtual

4.11

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::reportFederationExecutionMembers ( std::wstring const &  federationName,
rti1516_2025::FederationExecutionMemberInformationVector const &  report 
)
overridevirtual

4.10

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::reportFederationExecutions ( rti1516_2025::FederationExecutionInformationVector const &  report)
overridevirtual

4.8

Exceptions
FederateInternalError

Implements rti1516_2025::FederateAmbassador.

virtual void FederateAmbassadorProxy::reportInteractionTransportationType ( rti1516_2025::FederateHandle const &  federateHandle,
rti1516_2025::InteractionClassHandle const &  theInteraction,
rti1516_2025::TransportationTypeHandle const &  theTransportation 
)
overridevirtual
void FederateAmbassadorProxy::rtiAttributeValuesToFedProAttributeValues ( rti1516_2025::AttributeHandleValueMap const &  rtiAttributeValues,
rti1516_2025::fedpro::AttributeHandleValueMap fedProAttributeValues 
)
protected

Convert the provided RTI attribute handle value map into the federate protocol map.

virtual void FederateAmbassadorProxy::rtiParamValuesToFedProParamValues ( rti1516_2025::ParameterHandleValueMap const &  rtiParameterValues,
rti1516_2025::fedpro::ParameterHandleValueMap fedProParameterValues 
)
protectedvirtual

Convert the provided RTI parameter handle value map into the federate protocol map.

virtual void FederateAmbassadorProxy::rtiRegionsToFedProRegions ( rti1516_2025::RegionHandleSet const *  rtiRegions,
rti1516_2025::fedpro::ConveyedRegionSet fedProRegions 
)
protectedvirtual

Convert the provided RTI region set into the federate protocol region set.

Member Data Documentation

FederateProxy* FederateAmbassadorProxy::myFederateProxy
protected
std::vector<char> FederateAmbassadorProxy::myMessageBuffer
protected
std::string FederateAmbassadorProxy::myStringBuffer
protected
rti1516_2025::VariableLengthData FederateAmbassadorProxy::myVarDataBuffer
protected

The documentation for this class was generated from the following file:

Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)