exerciseConnInitializerHLA.h

Go to the documentation of this file.

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


#pragma once

#if DtHLA

#include "fomMapper.h"

#include <vlutil/vlString.h>

#include <mtl/applicationSettings.h>
#include <mtl/configVariable.h>
#include <mtl/multiConfigVariable.h>

#include <vlpi/exerciseConnConfig.h>

#include <cmdLine/cmdLine.h>

class DtMtlEnvironment;


#if defined (DtHLA_1516_EVOLVED)
#define DtDefaultRpr2Fom "RPR_FOM_v2.0_1516-2010.xml"
#define DtDefaultRpr1Fom "MAK-RPR1-1-10_evolved.xml"
#elif defined(DtHLA_1516)
#define DtDefaultRpr2Fom "MAK-RPR2-1-10.xml"
#define DtDefaultRpr1Fom "MAK-RPR1-1-10.xml"
#else //HLA 1.3
#define DtDefaultRpr2Fom "MAK-RPR2-1-10.fed"
#define DtDefaultRpr1Fom "MAK-RPR1-1-10.fed"
#endif

class DT_DLL_VL DtExerciseConnInitializer
{
public:

   enum DtGetValueMethod
   {
      DtForceGetValue,
      DtForceGetValuePointer,
      DtGetValuePointerWhereAvailable
   };

public:
   DtExerciseConnInitializer();

   virtual ~DtExerciseConnInitializer();

   DtExerciseConnInitializer(const DtExerciseConnInitializer& orig);

   DtExerciseConnInitializer& operator=(const DtExerciseConnInitializer& orig);

   virtual DtString execName() const;

   virtual void setExecName(const DtString& name);

   virtual DtString federateName() const;

   virtual void setFederateName(const DtString& name);

   virtual DtString federateType() const;

   virtual void setFederateType(const DtString& type);

   virtual DtString fedFileName() const;

   virtual void setFedFileName(const DtString& name);

   virtual DtFomMapper* fomMapper() const;

   virtual void setFomMapper(DtFomMapper* mapper);

   virtual DtString fomMapperLibName() const;

   virtual void setFomMapperLibName(const DtString& name);

   virtual void* fomMapperInitData() const;

   virtual void setFomMapperInitData(void* data);


   //{@
   virtual void setApplicationNumber(int id);
   virtual int applicationNumber() const;

   //{@
   virtual void setSiteId(int id);
   virtual int siteId() const;
 
   virtual void setRprFomVersion(double version);

   virtual double rprFomVersion() const;

   virtual void setNetnFomVersion(double version);

   virtual double netnFomVersion() const;

   virtual void setReflecting(bool onOff);

   virtual bool reflecting() const;

   virtual void setPassiveMode(bool onOff);

   virtual bool passiveMode() const;

   virtual void setReflectRemoteUpdatesIntoPub(bool onOff);

   virtual bool reflectRemoteUpdatesIntoPub() const;

   virtual void setReflectThroughRti(bool onOff);

   virtual bool reflectThroughRti() const;

   virtual void setUseAdvisories(bool onOff);

   virtual bool useAdvisories() const;

   virtual void setReplyToSynchPoints(bool onOff);

   virtual bool replyToSynchPoints() const;

   virtual void setAutoSubscribe(bool onOff);

   virtual bool autoSubscribe() const;

   virtual void setRequestClassUpdate(bool onOff);

   virtual bool requestClassUpdate() const;

   virtual void setRequestObjectUpdate(bool onOff);

   virtual bool requestObjectUpdate() const;

   virtual void setRequestWhenInitialized(bool onOff);

   virtual bool requestWhenInitialized() const;

   virtual void setDefaultRefreshWaitList(bool onOff);

   virtual bool defaultRefreshWaitList() const;

   virtual void setDefaultWaitListRefreshPeriod(double period);

   virtual double defaultWaitListRefreshPeriod() const;

   virtual void setTimeStampType(DtTimeStampType relOrAbs);

   virtual DtTimeStampType timeStampType() const;

   virtual bool dis5Timestamps() const;

   virtual void setDis5Timestamps(bool onOff);

   virtual void setDestroyFedExec(bool onOff);

   virtual bool destroyFedExec() const;

   virtual void setSendFedTime(bool onOff);

   virtual bool sendFedTime() const;

   virtual void setNotifyLevel(int level);

   virtual void setUseGeographicDdm(bool yesNo);

   virtual bool useGeographicDdm() const;

   virtual void setRprFomRevision(int val);
   virtual int rprFomRevision() const;

   virtual void setNetnFomRevision(int val);
   virtual int netnFomRevision() const;

   virtual void setExceptionOnRtiCompilerMismatch( bool useException );

   virtual bool exceptionOnRtiCompilerMismatch() const;


   virtual void setGetValueMethod( DtGetValueMethod getValueMethodChoice );
   virtual DtGetValueMethod getValueMethod( ) const;


   virtual void setGenericAttributes(bool yesNo);
   virtual bool enabledGenericAttributes() const;



   virtual bool pauseOnSaveRestore() const;
   virtual void setPauseOnSaveRestore(bool yesNo);

#if DtHLA_1516_EVOLVED

   virtual void setMimModule(const DtString& mimFomModule);
   virtual DtString mimModule() const;

   virtual void addFomModule(const DtString& module);
   virtual void setFomModules(const std::vector<DtString>& fomModules);

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

   virtual void clearFomModules();

   virtual void setLocalSettingsDesignator( const std::wstring & localSettingsDesignator );
   virtual void setLocalSettingsDesignator( const DtString & localSettingsDesignator );
   virtual std::wstring localSettingsDesignator() const;


#elif DtHLA_1516

   virtual void setRtiArguments(const std::vector<std::wstring>& args);

   virtual void setRtiArguments(const std::vector<DtString>& args);

   virtual void rtiArguments(std::vector<std::wstring>& args) const;

#endif

public:

   static DtString vrlinkVersion();

private:
   DtString myExecName;
   DtString myFederateType;
   DtString myFederateName;
   DtFomMapper* myFomMapper;
   DtString myFomMapperLibName;
   void* myFomMapperInitData;
   double myRprFomVersion;
   double myNetnFomVersion;
   bool myReflecting;
   bool myPassiveMode;
   bool myUseAdvisories;
   bool myReplyToSynchPoints;
   bool myAutoSubscribe;
   bool myRequestClassUpdate;
   bool myRequestObjectUpdate;
   bool myRequestWhenInitialized;
   bool myDefaultRefreshWaitList;
   double myDefaultWaitListRefreshPeriod;
   bool myReflectRemoteUpdatesIntoPub;
   bool myReflectThroughRti;
   DtTimeStampType myTimeStampType;
   bool myDestroyFedExec;
   bool mySendFedTime;
   bool myPauseOnSaveRestore;
   bool myGenericAttributes;
   bool myUseGeographicDdm;
   int  myRprFomRevision;
   int  myNetnFomRevision;
   int mySiteId;
   int myApplicationNumber;
   bool myExceptionOnRtiCompilerMismatch;
   DtGetValueMethod myGetValueMethod;
   bool myDis5TimeStamps;


#if DtHLA_1516_EVOLVED
   std::wstring myLocalSettingsDesignator;
#elif DtHLA_1516
   std::vector<std::wstring> myRtiArguments;
#endif

   DtString myFedFileName;

   std::vector<DtString> myFomModules;

   DtString myMimModule;

};

class DT_DLL_VL DtVrlApplicationInitializer : public DtExerciseConnInitializer
{
public:
   DtVrlApplicationInitializer(int argc, char* argv[], const DtString& appName,
      const DtString& defaultConfigFilePath = DtDefaultConfigFile,
      const DtString& version = DtExerciseConnInitializer::vrlinkVersion(),
#ifdef _WIN32
      bool pressAnyKey = true);
#else
      bool pressAnyKey = false);
#endif

   virtual ~DtVrlApplicationInitializer();

   DtVrlApplicationInitializer(const DtVrlApplicationInitializer& orig);

   DtVrlApplicationInitializer& operator=(const DtVrlApplicationInitializer& orig);

   virtual int argc() const;

   virtual char** argv() const;

   virtual DtExerciseConnConfig* exerciseConnectionConfig();

   virtual const DtExerciseConnConfig& exConnConfig() const;

   virtual DtApplicationSettings& settings();

   virtual const int disVersion() const;

   virtual void parseCmdLine();

   virtual void loadFile(const DtString& fileName);


   virtual void saveFile(const DtString& filename);

   //{@
   virtual void setExecName(const DtString& name);
   virtual DtString execName() const;

   //{@
   virtual void setFederateName(const DtString& name);
   virtual DtString federateName() const;

#if DtHLA_1516_EVOLVED
   //{@
   virtual void setLocalSettingsDesignator(const DtString& name);
   virtual std::wstring localSettingsDesignator() const;

   virtual void setMimModule(const DtString& mimFomModule);
   virtual DtString mimModule() const;

#endif

   //{@
   virtual void setNotifyFileLevel(int level);
   virtual int notifyFileLevel() const;

   //{@
   virtual void setNotifyFilename(const DtString& file);
   virtual DtString notifyFilename() const;

   //{@
   virtual void setFederateType(const DtString& type);
   virtual DtString federateType() const;

   //{@
   void setFedFileName(const DtString& name);
   virtual DtString fedFileName() const;

   //{@
   virtual void setSiteId(int id);
   virtual int siteId() const;

   //{@
   virtual void setApplicationNumber(int num);
   virtual int applicationNumber() const;

   //{@
   virtual void setFomMapperLibName(const DtString& name);
   virtual DtString fomMapperLibName() const;

   //{@
   virtual void setRprFomVersion(double version);
   virtual double rprFomVersion() const;

   //{@
   virtual void setNetnFomVersion(double version);
   virtual double netnFomVersion() const;

   //{@
   virtual void* fomMapperInitData() const;
   virtual void setFomMapperInitData(void* data);

   //{@
   virtual void setUseAdvisories(bool onOff);
   virtual bool useAdvisories() const;

   //{@
   virtual void setUseDis5Timestamps(bool onOff);
   virtual bool useDis5TimeStamps() const;

   //{@
   virtual void setRequestClassUpdate(bool onOff);
   virtual bool requestClassUpdate() const;


   //{@
   virtual void setRequestObjectUpdate(bool onOff);
   virtual bool requestObjectUpdate() const;

   //{@
   virtual void setRequestWhenInitialized(bool onOff);
   virtual bool requestWhenInitialized() const;

   //{@
   virtual void setDefaultRefreshWaitList(bool onOff);
   virtual bool defaultRefreshWaitList() const;

   //{@
   virtual void setDefaultWaitListRefreshPeriod(double period);
   virtual double defaultWaitListRefreshPeriod() const;

   virtual void setTimeStampType(DtTimeStampType relOrAbs);

   virtual DtTimeStampType timeStampType() const;

   virtual void setDestroyFedExec(bool onOff);

   virtual bool destroyFedExec() const;

   virtual void setSendFedTime(bool onOff);

   virtual bool sendFedTime() const;

   virtual void setUseGeographicDdm(bool yesNo);

   virtual bool useGeographicDdm() const;

   virtual void setRprFomRevision(int val);

   virtual int rprFomRevision() const;

   virtual void setNetnFomRevision(int val);

   virtual int netnFomRevision() const;

   virtual void setGenericAttributes(bool yesNo);
   virtual bool enabledGenericAttributes() const;


   virtual bool pauseOnSaveRestore() const;
   virtual void setPauseOnSaveRestore(bool yesNo);

   virtual void setExceptionOnRtiCompilerMismatch(bool yesNo);
   virtual bool exceptionOnRtiCompilerMismatch() const;

   virtual void setOutputInterval(double period);

   virtual double outputInterval() const;

protected:
   virtual void initializeFileLogging();

   virtual void initializeConnectionConfigVariables();

   virtual void initializeMtlParams();

   virtual void loadMtlFile(const DtString& fileName);

protected:
   int myArgc;
   char** myArgv;
   DtMtlEnvironment* myMtlEnv;

   DtExerciseConnConfig myExConnConfig;

   // used from command line to load in multiple config files
   // merging and replacing properties as needed
   DtMultiConfigVariable<DtString> myMultipleConfigFiles;
   DtConfigVariable<bool>     myConfigVarIgnoreAdvisories;
   DtConfigVariable<DtString> myConfigVarFomModuleList; //--setFomModuleList

   // MTL doesn't support boolean
   int                        myMtlUseAdvisories;
   int                        myMtlUseGeographicDdm;
   int                        myMtlUseAbsoluteTimeStamps;
   int                        myMtlDestroyFedExec;
   int                        myMtlSendFedTime;
   int                        myMtlPauseOnSaveRestore;
   int                        myMtlRequestClassUpdate;
   int                        myMtlRequestObjectUpdate;
   int                        myMtlRequestWhenInitialized;
   int                        myMtlDefaultRefreshWaitList;

};

#endif // DtHLA