lgrHlaSimInterface.h

Go to the documentation of this file.

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


#ifndef lgrHlaSimInterface_H_
#define lgrHlaSimInterface_H_

#if DtHLA

#include <lgrSim/lgrSim.h>
#include <lgrCore/lgrSimInterface.h>
#include <lgrUtil/virtualConstructor.h>
#include <lgrSim/lgrHlaConfigData.h>

#include <vector>
#include <vlutil/vlString.h>

class DtHlaTAFilter;

namespace MAKLogger
{
   class DtBaseFomDesc;
   class DtLogger;
   class DtLgrHlaSimDriver;
   class DtLgrHlaCommandFactory;
   class DtLgrDisEntityTypeManager;
   class DtLgrHlaConfigData;


   class DT_DLL_LGRSIM DtLgrHlaSimInterface : public DtLgrSimInterface
   {
   public:

      typedef DtLgrHlaCommandFactory Factory;

      static DtLgrHlaSimInterface* create(DtLogger&);

      static DtLgrSimInterface* createBase(DtLogger&);

      static DtLgrHlaSimInterface* createNonThreadsafe(DtLogger& logger,
         const DtLgrHlaSimDriver& driver);

   public:

      virtual ~DtLgrHlaSimInterface();

      virtual void setConnectionParametersHLA(
         const DtString& federateType,
         const DtString& federationName,
         const DtString& fedFile,
         bool ignoreAdvisories, double fomVersion, int fomRevision,
         bool useMatrexFom, const DtString& matrexFomMapperData,
         const DtString& fomMapper, const DtString& fomMapperData, bool useEmptyFomMapper, bool noRtiCompilerCheck) const;

      virtual void setConnectionParametersHLAe(
         const DtString& federateName,
         const DtString& federateType,
         const DtString& federationName,
         const DtString& fedFile,
         const std::vector<DtString>& fomModules,
         const DtString& mim,
         bool ignoreAdvisories, double fomVersion, int fomRevision,
         bool useMatrexFom, const DtString& matrexFomMapperData,
         const DtString& fomMapper, const DtString& fomMapperData, bool useEmptyFomMapper, bool noRtiCompilerCheck) const;

      virtual void setSiteApp(int siteId, int appNumber) const;

      virtual void setSubscriptionLists(const std::vector<DtString>& objectClasses,
         const std::vector<DtString>& interactionClasses) const;

      virtual void addTrafficAnalyzerFilter(DtHlaTAFilter* filter) const;

      virtual void removeTrafficAnalyzerFilter(DtHlaTAFilter* filter) const;

      virtual DtLgrProtocolId protocolId() const;

      virtual void getLoggerName(DtString& name) const;

      virtual const DtString& federateType() const;

      virtual const DtString& federationName() const;

      virtual const DtString& fedFile() const;

      virtual bool ignoreAdvisories() const;

      virtual bool saveTrafficAnalyzerConfigurationEnabled() const;

      virtual void enableSaveTrafficAnalyzerConfiguration(bool enable) const;

      virtual bool trafficAnalyzerEnabled() const;

      virtual void enableTrafficAnalyzer(bool enable) const;

      virtual bool requestUpdatesEnabled() const;

      virtual void enableRequestUpdates(bool enable) const;

      virtual bool sendOnlyUpdatedValuesEnabled() const;

      virtual void enableSendOnlyUpdatedValues(bool enable) const;

      virtual bool passiveSubscriptionEnabled() const;

      virtual void enablePassiveSubscription(bool enable) const;

      virtual double fomVersion() const;

      virtual int fomRevision() const;

      virtual bool useMatrexFomMapper() const;

      virtual const DtString& matrexFomMapperData() const;

      virtual const DtString& fomMapper() const;

      virtual const DtString& fomMapperData() const;

      virtual bool useEmptyFomMapper() const;

      virtual const DtString& federateName() const;

      virtual const std::vector<DtString>& fomModules() const;

      virtual const DtString& mim() const;

      virtual const DtBaseFomDesc* fomDescription() const;

      virtual const std::vector<DtString>& objectSubscriptionList() const;

      virtual const std::vector<DtString>& interactionSubscriptionList() const;

      virtual const bool isTimeConstrained() const;

      virtual const bool isTimeRegulating() const;

      virtual const double lookAhead() const;

      virtual bool timeManagementEnabled() const;

      virtual double drainInputMaxTime() const;

      virtual double drainInputMinTime() const;

      virtual void setDrainInputSettings(double maxTime, double minTime) const;

      virtual void setTimeManagementSettings(bool constrainedRecording,
         bool constrainedPlayback,bool regulatingRecording, bool regulatingPlayback,
         double lookahead) const;

      virtual bool timeConstrainedRecording() const;

      virtual bool timeConstrainedPlayback() const;

      virtual bool timeRegulatingRecording() const;

      virtual bool timeRegulatingPlayback() const;

      virtual void setEntityTypeManager(const DtLgrDisEntityTypeManager& mgr) const;

      virtual const DtLgrDisEntityTypeManager* entityTypeManager() const;

      virtual bool connectionSettingsMatchInputFile( DtString& filename );
      
      virtual void useRecommendedSettings();

      virtual void stripPathFromFomModules();

      virtual bool rtiCompilerCheck() const;

   protected:

      DtLgrHlaSimInterface(DtLogger& logger, const DtLgrHlaSimDriver& driver);

      void connectResponseHandler(DtLgrCommandId id,
         void (DtLgrHlaSimInterface::* function)(DtResponse));



      void connectionParametersHLAChanged(DtResponse);
      void connectionParametersHLAeChanged(DtResponse);
      void siteAppNumberChanged(DtResponse);
      void fomChanged(DtResponse);
      void subscriptionListsChanged(DtResponse);
      void timeManagementSettingsChanged(DtResponse);
      void timeManagementEnabledChanged(DtResponse);
      void drainInputSettingsChanged(DtResponse);
      void ignoreAdvisoriesChanged(DtResponse response);
      void trafficAnalyzerChanged(DtResponse response);
      void saveTrafficAnalyzerConfigurationChanged(DtResponse response);
      void entityTypeManagerChanged(DtResponse response);
      void requestUpdatesChanged(DtResponse response);
      void sendOnlyUpdatedValuesChanged(DtResponse response);
      void passiveSubscriptionChanged(DtResponse response);


   protected:
      double myFomVersion;
      int myFomRevision;
      DtString myFomMapper;
      DtString myMatrexFomMapperData;
      DtString myFomMapperData;
      DtString myFederateType;
      DtString myFederationName;
      DtString myFedFile;
      DtString myFederateName;
      std::vector<DtString> myFomModules;
      DtString myMim;
      DtBaseFomDesc* myFomDescription;
      int mySiteId;
      int myAppNumber;
      std::vector<DtString> myObjectSubscriptionList;
      std::vector<DtString> myInteractionSubscriptionList;
      bool myIsTimeConstrainedFlag;
      bool myIsTimeRegulatingFlag;
      double myLookAhead;
      bool myTimeManagedEnabledFlag;
      double myDrainInputMaxTime;
      double myDrainInputMinTime;
      bool myIgnoreAdvisories;
      bool myTrafficAnalyzerEnabled;
      bool mySaveTrafficAnalyzerConfigurationEnabled;
      bool myUseEmptyFomMapper;
      bool myUseMatrexFomMapper;
      bool myRequestUpdates;
      bool mySendOnlyUpdatedValues;
      bool myPassiveSubscription;
      bool myNoRtiCompilerCheck;

      bool myTimeConstrainedRecording;
      bool myTimeRegulatingRecording;
      bool myTimeConstrainedPlayback;
      bool myTimeRegulatingPlayback;

      DtLgrDisEntityTypeManager* myEntityTypeManager;

      DtLgrHlaConfigData myHlaConfigData;

   };

}

#endif

#endif