vrlFederateAmbassador1516_4.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1992-2010 MAK Technologies, Inc
** All rights reserved.
*******************************************************************************/


#pragma once
 

#if DtHLA_4

#include "callbacks.h"

#include "rtiNamespace.h"
#include "nullFederateAmbassador1516_4.h"
#include <list>

typedef void (*DtFederateSaveCb)(
   const char* label,
   void* usr);

typedef void (*DtFederateRestoreCb)(
   const char* label,
   void* usr);

typedef void (*DtSynchPointCb)(
   const char* label,
   void* usr);

typedef void (*DtAnnounceSynchPointCb)(
   const char* label,
   const RTI::VariableLengthData& tag,
   void* usr);

class DT_DLL_VL DtInteractionManager;
class DT_DLL_VL DtHlaObjectManager;

class DT_DLL_VL DtVrlFederateAmbassador : public DtNullFederateAmbassador
{
   struct DtScopeChangeCallbackData
   {
      DtVrlFederateAmbassador* fedAmb;
      RTI::ObjectInstanceHandle        handle;
   };

public:
   DtVrlFederateAmbassador();

   virtual ~DtVrlFederateAmbassador()
      noexcept override;

protected:
   DtVrlFederateAmbassador( const DtVrlFederateAmbassador& src );

   DtVrlFederateAmbassador& operator=(const DtVrlFederateAmbassador& src );

public:
   virtual void init( DtExerciseConn* exConn,
      DtHlaObjectManager* hlaObjMgr,
      DtInteractionManager* interMgr );

public:
   static DtVrlFederateAmbassador* create();

public:
   virtual void addReflectAttributeValuesCb( 
      RTI::ObjectInstanceHandle id, DtReflectAttributeValuesCb cb, void* usr );
   virtual void removeReflectAttributeValuesCb( 
      RTI::ObjectInstanceHandle id, DtReflectAttributeValuesCb cb, void* usr );

   virtual void addDiscoverObjectCb( RTI::ObjectClassHandle hand,
      DtDiscoverObjectCb cb, void* usr );
   virtual void removeDiscoverObjectCb( RTI::ObjectClassHandle hand,
      DtDiscoverObjectCb cb, void* usr );

   virtual void addRemoveObjectCb( RTI::ObjectInstanceHandle id,
      DtRemoveObjectCb cb, void* usr );
   virtual void removeRemoveObjectCb( RTI::ObjectInstanceHandle id,
      DtRemoveObjectCb cb, void* usr );

   virtual void addStartRegCb( RTI::ObjectClassHandle hand,
      DtStartRegCb cb, void* usr );
   virtual void removeStartRegCb( RTI::ObjectClassHandle hand,
      DtStartRegCb cb, void* usr );

   virtual void addStopRegCb( RTI::ObjectClassHandle hand,
      DtStopRegCb cb, void* usr );
   virtual void removeStopRegCb( RTI::ObjectClassHandle hand,
      DtStopRegCb cb, void* usr );

   virtual void addUpdatesOnCb( RTI::ObjectInstanceHandle hand,
      DtUpdatesOnCb cb, void* usr );
   virtual void removeUpdatesOnCb( RTI::ObjectInstanceHandle hand,
      DtUpdatesOnCb cb, void* usr );

   virtual void addUpdatesOffCb( RTI::ObjectInstanceHandle hand,
      DtUpdatesOffCb cb, void* usr );
   virtual void removeUpdatesOffCb( RTI::ObjectInstanceHandle hand,
      DtUpdatesOffCb cb, void* usr );

   virtual void addStartInteractionsCb( RTI::InteractionClassHandle hand,
      DtStartStopInterCb cb, void* usr );
   virtual void removeStartInteractionsCb( RTI::InteractionClassHandle hand,
      DtStartStopInterCb cb, void* usr );

   virtual void addStopInteractionsCb( RTI::InteractionClassHandle hand,
      DtStartStopInterCb cb, void* usr );
   virtual void removeStopInteractionsCb( RTI::InteractionClassHandle hand,
      DtStartStopInterCb cb, void* usr );

   virtual void addReceiveInteractionCb( RTI::InteractionClassHandle hand,
      DtReceiveInteractionCb cb, void* usr, DtDDMRegionSP region = DtDDMRegionSP());
   virtual void removeReceiveInteractionCb( RTI::InteractionClassHandle hand,
      DtReceiveInteractionCb cb, void* usr, DtDDMRegionSP region = DtDDMRegionSP() );
   
   virtual void addTimeAdvanceGrantCb( DtFedTimeCb cb, void* usr );
   virtual void removeTimeAdvanceGrantCb( DtFedTimeCb cb, void* usr );

   virtual void addTimeRegulationEnabledCb( DtFedTimeCb cb, void* usr );
   virtual void removeTimeRegulationEnabledCb( DtFedTimeCb cb, void* usr );

   virtual void addTimeConstrainedEnabledCb( DtFedTimeCb cb, void* usr );
   virtual void removeTimeConstrainedEnabledCb( DtFedTimeCb cb, void* usr );

   virtual void addNameReservationSucceeded( DtReserveNameCb cb, void* usr );
   virtual void removeNameReservationSucceeded( DtReserveNameCb cb, void* usr );

   virtual void addNameReservationFailed( DtReserveNameCb cb, void* usr );
   virtual void removeNameReservationFailed( DtReserveNameCb cb, void* usr );


   virtual void addMultipleNameReservationSucceeded( DtReserveMultipleNamesCb cb, void* usr );
   virtual void removeNameReservationSucceeded( DtReserveMultipleNamesCb, void* usr );

   virtual void addMultipleNameReservationFailed( DtReserveMultipleNamesCb cb, void* usr );
   virtual void removeMultipleNameReservationFailed( DtReserveMultipleNamesCb, void* usr );

   virtual void addSynchPointRegSucceededCb(const DtString& label,
      DtSynchPointCb func, void* usr);
   virtual void addSynchPointRegSucceededCb(DtSynchPointCb func, 
      void* usr);

   virtual void removeSynchPointRegSucceededCb(const DtString& label,
      DtSynchPointCb func, void* usr);
   virtual void removeSynchPointRegSucceededCb(DtSynchPointCb func, 
      void* usr);

   virtual void addSynchPointRegFailedCb(const DtString& label,
      DtSynchPointCb func, void* usr);
   virtual void addSynchPointRegFailedCb(DtSynchPointCb func, 
      void* usr);

   virtual void removeSynchPointRegFailedCb(const DtString& label,
      DtSynchPointCb func, void* usr);
   virtual void removeSynchPointRegFailedCb(DtSynchPointCb func, 
      void* usr);

   virtual void addFederationSynchedCb(const DtString& label,
      DtSynchPointCb func, void* usr);
   virtual void addFederationSynchedCb(DtSynchPointCb func, 
      void* usr);

   virtual void removeFederationSynchedCb(const DtString& label,
      DtSynchPointCb func, void* usr);
   virtual void removeFederationSynchedCb(DtSynchPointCb func, 
      void* usr);

   virtual void addAnnounceSynchPointCb(const DtString& label,
      DtAnnounceSynchPointCb func, void* usr);
   virtual void addAnnounceSynchPointCb(DtAnnounceSynchPointCb func, 
      void* usr);

   virtual void removeAnnounceSynchPointCb(const DtString& label,
      DtAnnounceSynchPointCb func, void* usr);
   virtual void removeAnnounceSynchPointCb(DtAnnounceSynchPointCb func, 
      void* usr);

   virtual void setRemoveObjectOnAttOutOfScope(bool remove);
   virtual bool removeObjectOnAttOutOfScope() const;

   virtual void addConnectionLostCb( DtConnectionLostCb func, void* usr );
   virtual void removeConnectionLostCb(DtConnectionLostCb func, void* usr );




   virtual void addFederateSaveCb(const DtString& label,
      DtFederateSaveCb func, void* usr);
   virtual void addFederateSaveCb(DtFederateSaveCb func, 
      void* usr);

   virtual void removeFederateSaveCb(const DtString& label,
      DtFederateSaveCb func, void* usr);
   virtual void removeFederateSaveCb(DtFederateSaveCb func, 
      void* usr);


   virtual void addFederateRestoreCb(const DtString& label,
      DtFederateRestoreCb func, void* usr);
   virtual void addFederateRestoreCb(DtFederateRestoreCb func, 
      void* usr);

   virtual void removeFederateRestoreCb(const DtString& label,
      DtFederateRestoreCb func, void* usr);
   virtual void removeFederateRestoreCb(DtFederateRestoreCb func, 
      void* usr);
   virtual bool waitingForSaveOrRestore() const;

   virtual DtString getFederateNameFromHandle(const RTI::FederateHandle&) const;



protected:
   struct DtFederateSaveCbInfo
   {
      DtFederateSaveCb cbFunction;
      void* userData;
   };

   struct DtFederateRestoreCbInfo
   {
      DtFederateRestoreCb cbFunction;
      void* userData;
   };

   struct DtLabelledFederateSaveCbInfo
   {
      DtString label;
      DtFederateSaveCb cbFunction;
      void* userData;
   };

   struct DtLabelledFederateRestoreCbInfo
   {
      DtString label;
      DtFederateRestoreCb cbFunction;
      void* userData;
   };

   struct DtGeneralSynchPointCbInfo
   {
      DtSynchPointCb cbFunction;
      void* userData;
   };

   struct DtLabelledSynchPointCbInfo
   {
      DtString label;
      DtSynchPointCb cbFunction;
      void* userData;
   };

   struct DtGeneralAnnounceCbInfo
   {
      DtAnnounceSynchPointCb cbFunction;
      void* userData;
   };

   struct DtLabelledAnnounceCbInfo
   {
      DtString label;
      DtAnnounceSynchPointCb cbFunction;
      void* userData;
   };

   static void attributesOutOfScopeCb(void* usr);

   virtual void processAttributesOutOfScope(RTI::ObjectInstanceHandle handle);

   DtExerciseConn*       myExConn;
   DtInteractionManager* myInteractionManager;
   DtHlaObjectManager*   myHlaObjectManager;

   DtReflectAttributeValuesCbList myRavCbList;
   DtUpdatesOnCbList              myUpdatesOnCbList;
   DtUpdatesOffCbList             myUpdatesOffCbList;
   DtStartRegCbList               myStartRegCbList;
   DtStopRegCbList                myStopRegCbList;
   DtStartStopInterCbList         myStartIntCbList;
   DtStartStopInterCbList         myStopIntCbList;
   DtFedTimeCbList                myTimeAdvanceGrantCbList;
   DtFedTimeCbList                myFlushQueueGrantCbList;
   DtFedTimeCbList                myRegulationEnabledCbList;
   DtFedTimeCbList                myConstrainedEnabledCbList;
   DtConnectionLostCbList         myConnectionLostCbList;
   DtReserveNameCbList            myNameReservationSucceededCbList;
   DtReserveNameCbList            myNameReservationFailedCbList;

   DtReserveMultipleNamesCbList   myMultipleNamesReservationSucceededCbList;
   DtReserveMultipleNamesCbList   myMultipleNamesReservationFailedCbList;

   std::list<DtFederateSaveCbInfo> myFederateSaveCbList;
   std::list<DtLabelledFederateSaveCbInfo> myLabFederateSaveCbList;
   std::list<DtFederateRestoreCbInfo> myFederateRestoreCbList;
   std::list<DtLabelledFederateRestoreCbInfo> myLabFederateRestoreCbList;

   std::list<DtLabelledSynchPointCbInfo> myLabSynchPtRegSucceededCbList;
   std::list<DtLabelledSynchPointCbInfo> myLabSynchPtRegFailedCbList;
   std::list<DtLabelledSynchPointCbInfo> myLabFederationSynchedCbList;
   std::list<DtLabelledAnnounceCbInfo>   myLabAnnounceSynchPointCbList;

   std::list<DtGeneralSynchPointCbInfo> mySynchPtRegSucceededCbList;
   std::list<DtGeneralSynchPointCbInfo> mySynchPtRegFailedCbList;
   std::list<DtGeneralSynchPointCbInfo> myFederationSynchedCbList;
   std::list<DtGeneralAnnounceCbInfo>     myAnnounceSynchPointCbList;

   bool myRemoveObjectOnAttOutOfScope;

   virtual void applyFedsSynchedCallbacks(const DtString& label);
   virtual void applyRegistrationSucceededCallbacks(const DtString& label);
   virtual void applyRegistrationFailedCallbacks(const DtString& label);

   virtual bool applyAnnounceCallbacks(const DtString& label, const RTI::VariableLengthData& tag);


public:

   // Federation Management Services //

   virtual void connectionLost(
      std::wstring const& faultDescription) override;

   virtual void reportFederationExecutions(
      FederationExecutionInformationVector const& report) override;

   virtual void reportFederationExecutionMembers(
      std::wstring const& federationName,
      FederationExecutionMemberInformationVector const& report) override;

   virtual void reportFederationExecutionDoesNotExist(
      std::wstring const& federationName) override;

   virtual void federateResigned(
      std::wstring const& reasonForResignDescription) override;

   virtual void synchronizationPointRegistrationSucceeded(
      std::wstring const& synchronizationPointLabel) override;

   virtual void synchronizationPointRegistrationFailed(
      std::wstring const& synchronizationPointLabel,
      SynchronizationPointFailureReason reason) override;

   virtual void announceSynchronizationPoint(
      std::wstring  const& synchronizationPointLabel,
      VariableLengthData const& userSuppliedTag) override;

   virtual void federationSynchronized(
      std::wstring const& synchronizationPointLabel,
      FederateHandleSet const& failedToSyncSet) override;

   virtual void initiateFederateSave(
      std::wstring const& label) override;

   virtual void initiateFederateSave(
      std::wstring const& label,
      LogicalTime const& time) override;

   virtual void federationSaved() override;

   virtual void federationNotSaved(
      SaveFailureReason reason) override;

   virtual void federationSaveStatusResponse(
      FederateHandleSaveStatusPairVector const& response) override;

   virtual void requestFederationRestoreSucceeded(
      std::wstring const& label) override;

   virtual void requestFederationRestoreFailed(
      std::wstring const& label) override;

   virtual void federationRestoreBegun() override;

   virtual void initiateFederateRestore(
      std::wstring const& label,
      std::wstring const& federateName,
      FederateHandle const& postRestoreFederateHandle) override;

   virtual void federationRestored() override;

   virtual void federationNotRestored(
      RestoreFailureReason reason) override;

   virtual void federationRestoreStatusResponse(
      FederateRestoreStatusVector const& response) override;

      // Declaration Management Services //

   virtual void startRegistrationForObjectClass(
      ObjectClassHandle const& objectClass) override;

   virtual void stopRegistrationForObjectClass(
      ObjectClassHandle const& objectClass) override;

   virtual void turnInteractionsOn(
      InteractionClassHandle const& interactionClass) override;

   virtual void turnInteractionsOff(
      InteractionClassHandle const& interactionClass) override;

      // Object Management Services //

   virtual void objectInstanceNameReservationSucceeded(
      std::wstring const& objectInstanceName) override;

   virtual void objectInstanceNameReservationFailed(
      std::wstring const& objectInstanceName) override;

   virtual void multipleObjectInstanceNameReservationSucceeded(
      std::set<std::wstring> const& objectInstanceNames) override;

   virtual void multipleObjectInstanceNameReservationFailed(
      std::set<std::wstring> const& objectInstanceNames) override;


   virtual void discoverObjectInstance(
      ObjectInstanceHandle const& objectInstance,
      ObjectClassHandle const& objectClass,
      std::wstring const& objectInstanceName,
      FederateHandle const& producingFederate) override;

   virtual void reflectAttributeValues(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleValueMap const& attributeValues,
      VariableLengthData const& userSuppliedTag,
      TransportationTypeHandle const& transportationType,
      FederateHandle const& producingFederate,
      RegionHandleSet const* optionalSentRegions) override;

   virtual 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;

   virtual void receiveInteraction(
      InteractionClassHandle const& interactionClass,
      ParameterHandleValueMap const& parameterValues,
      VariableLengthData const& userSuppliedTag,
      TransportationTypeHandle const& transportationType,
      FederateHandle const& producingFederate,
      const RegionHandleSet* optionalSentRegions) override;

   virtual 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;

   virtual void receiveDirectedInteraction(
      InteractionClassHandle const& interactionClass,
      ObjectInstanceHandle const& objectInstance,
      ParameterHandleValueMap const& parameterValues,
      VariableLengthData const& userSuppliedTag,
      TransportationTypeHandle const& transportationType,
      FederateHandle const& producingFederate) override;

   virtual 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;

   virtual void removeObjectInstance(
      ObjectInstanceHandle const& objectInstance,
      VariableLengthData const& userSuppliedTag,
      FederateHandle const& producingFederate) override;

   virtual void removeObjectInstance(
      ObjectInstanceHandle const& objectInstance,
      VariableLengthData const& userSuppliedTag,
      FederateHandle const& producingFederate,
      LogicalTime const& time,
      OrderType sentOrderType,
      OrderType receivedOrderType,
      MessageRetractionHandle const* optionalRetraction) override;

   virtual void attributesInScope(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes) override;

   virtual void attributesOutOfScope(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes) override;

   virtual void provideAttributeValueUpdate(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes,
      VariableLengthData const& userSuppliedTag) override;

   virtual void turnUpdatesOnForObjectInstance(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes) override;

   virtual void turnUpdatesOnForObjectInstance(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes,
      std::wstring const& updateRateDesignator) override;

   virtual void turnUpdatesOffForObjectInstance(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes) override;

   virtual void confirmAttributeTransportationTypeChange(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes,
      TransportationTypeHandle const& transportationType) override;

   virtual void reportAttributeTransportationType(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandle const& attribute,
      TransportationTypeHandle const& transportationType) override;

   virtual void confirmInteractionTransportationTypeChange(
      InteractionClassHandle const& interactionClass,
      TransportationTypeHandle const& transportationType) override;

   virtual void reportInteractionTransportationType(
      FederateHandle const& federate,
      InteractionClassHandle const& interactionClass,
      TransportationTypeHandle const& transportationType) override;


      // Ownership Management Services //

   virtual void requestAttributeOwnershipAssumption(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& offeredAttributes,
      VariableLengthData const& userSuppliedTag) override;

   virtual void requestDivestitureConfirmation(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& releasedAttributes,
      VariableLengthData const& userSuppliedTag) override;

   virtual void attributeOwnershipAcquisitionNotification(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& securedAttributes,
      VariableLengthData const& userSuppliedTag) override;

   virtual void attributeOwnershipUnavailable(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes,
      VariableLengthData const& userSuppliedTag) override;

   virtual void requestAttributeOwnershipRelease(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& candidateAttributes,
      VariableLengthData const& userSuppliedTag) override;

   virtual void confirmAttributeOwnershipAcquisitionCancellation(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes) override;

   virtual void informAttributeOwnership(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes,
      FederateHandle const& owner) override;

   virtual void attributeIsNotOwned(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes) override;

   virtual void attributeIsOwnedByRTI(
      ObjectInstanceHandle const& objectInstance,
      AttributeHandleSet const& attributes) override;

      // Time Management Services //

      virtual void timeRegulationEnabled(
         LogicalTime const & time) override;

      virtual void timeConstrainedEnabled(
         LogicalTime const & time) override;

      virtual void flushQueueGrant(
         LogicalTime const & time, LogicalTime const & optimisticTime) override;

      virtual void timeAdvanceGrant(
         LogicalTime const & time) override;

      virtual void requestRetraction(
         MessageRetractionHandle const & retraction) override;

protected:

   bool myWaitingForSave;
   bool myWaitingForRestore;
};
  
#endif