vrfSimOptions.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2020 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "legionNetworkInterface/legionNetworkInterfaceDefines.h"
#include "legionNetworkInterface/legionApplicationInitializer.h"
#include "vrfutil/vrfPluginRecordManager.h"
#include "vrfutil/vrfSimOptionsInterface.h"

namespace makVrf
{
   class DT_DLL_legionNetworkInterface DtVrfSimOptions : public DtLegionApplicationInitializer , public DtVrfSimOptionsInterface
   {
   public:
      DtVrfSimOptions(int argc, char** argv, const char* appName, const char* appVersion);

      virtual ~DtVrfSimOptions();

      virtual bool readConfigurationFile(const DtFilename& mtlFile);

   public:

      virtual int statusUpdateHeartbeat() const;

      virtual bool connectionless() const;
      virtual bool disableRemoteDiscovery() const;

      virtual DtFilename simulationModelSetFilename() const;
   
      virtual bool forceParameterDbReload() const;

      virtual void setTargetFrameRate(int rate);
      virtual int targetFrameRate() const;

      virtual int clockMode() const;

      virtual void setDefaultParameterDatabasePath(const DtFilename& path);
      virtual const DtFilename& defaultParameterDatabasePath() const;

      virtual void setDefaultTerrainDatabasePath(const DtFilename& path);
      virtual const DtFilename& defaultTerrainDatabasePath() const;

      virtual DtFilename diGuyCharacterDataFile() const;

      virtual DtFilename diGuyAnimationsFile() const;

      virtual bool logFrameRateStats() const;
      virtual void setLogFrameRateStats(bool yesOrNo);

      virtual void setRejectMismatchedScenarioMessages(bool);
      virtual bool rejectMismatchedScenarioMessages() const;

      virtual bool enableNavigationLabDebugging() const;
      virtual void setEnableNavigationLabDebugging(bool enable);

      virtual int sessionId() const;
      virtual int appIdRangeMax() const;
      virtual void setAppIdRangeMax(int);
      virtual DtFilename batchFile() const;
      virtual DtFilename scenarioFile() const;
      virtual DtFilename terrainFile() const;

      virtual int frontEndProcessId() const;

      virtual void setStartInRunMode(bool);
      virtual bool startInRunMode() const;

   #ifdef WIN32
      virtual void setDoNotUseConsole(bool);
      virtual bool usingConsole() const;

      virtual void setStartMinimized(bool);
      virtual bool startMinimized() const;
   #endif
   
      virtual void setDaemonMode(bool);
      virtual bool daemonMode() const;

      virtual void setReuseEntityIdentifiersOnScenarioLoad(bool);
      virtual bool reuseEntityIdentifiersOnScenarioLoad() const;

      virtual void parseCmdLine();

      virtual short simMgmtPduProcessLevel() const;

      virtual int cgfDispatcherReceivePort() const;
      virtual void setCgfDispatcherReceivePort(int port);

      virtual int tracyPort() const;
      virtual bool tracyPortSet() const;
      virtual void setTracyPort(int port);

      const std::vector<std::string>& pluginsToLoad() const;

      virtual void setLoadPluginIfVersionMismatch(bool);
      virtual bool loadPluginIfVersionMismatch() const;

      virtual void setPluginsDirectory(const DtFilename&);
      virtual const DtFilename& pluginsDirectory() const;

      virtual DtString additionalSystemScriptsDirectory() const;
      virtual void setAdditionalSystemScriptsDirectory(const DtString&);

      virtual void setDoNotUsePluginsDirectory(bool b);
      virtual bool doNotUsePluginsDirectory() const;

      virtual DtFilename outputFile() const;
      virtual void setOutputFile(const DtFilename& s);

      virtual void setNotifyLevel(DtNotifyLevelType level);
      virtual DtNotifyLevelType notifyLevel() const;


      virtual void setSendBackendLogToNetwork(bool v);
      virtual bool sendBackendLogToNetwork() const;


      virtual void setFullyLoadTerrain(bool v);
      virtual bool fullyLoadTerrain() const;


      virtual void setAssertOnBlockingTerrainCalls(bool b);
      virtual bool assertOnBlockingTerrainCalls() const;


      virtual void setHostAddress(const DtString& address);
      virtual DtString hostAddress() const;


      virtual void setReportedHostAddress(const DtString& address);
      virtual DtString reportedHostAddress() const;

      virtual void setAppDataDir(const DtString&);
      virtual DtString appDataDir() const;

      virtual void setupSettingsDirectory(const DtFilename& f, bool useSharedSettingsDirectory);

      virtual void setSharedDataDir(const DtFilename&);
      virtual DtFilename sharedDataDir() const;

      virtual bool isSharedDataDirSet() const;

      virtual void setSharedDataRoot(const DtFilename&);
      virtual DtFilename sharedDataRoot() const;

      virtual bool isSharedDataRootSet() const;

      virtual void setSharedDataStem(const DtString&);
      virtual DtString sharedDataStem() const;

      virtual bool isSharedDataStemSet() const;

      virtual void setDataDir(const DtString&);
      virtual DtString dataDir() const;

      virtual bool isDataDirSet() const;

      virtual void setUserDataDir(const DtString&);
      virtual DtString userDataDir() const;

      virtual bool isUserDataDirSet() const;


      virtual void setMsdlSidcMappingFile(const DtString& address);
      virtual DtFilename msdlSidcMappingFile() const;


      virtual void setCountryCodesMappingFile(const DtString& address);
      virtual DtFilename countryCodesMappingFile() const;

      virtual void outputMtl();
   #if USE_VLD_MEMORY_TRACKING && _DEBUG
      virtual bool useVld() const;
   #endif

      virtual void setMainThreadWaitForQueue(bool enable);
      virtual void setNumCallbackThreads(unsigned n);

      virtual void setDisableParallelTick(bool use);
      virtual void setIssueSimExitOnFinishTestCommand(bool shouldExit);
   
      virtual void setEnableMetoc(bool enable);

      virtual bool mainThreadWaitForQueue() const;
      virtual unsigned numCallbackThreads() const;
      virtual bool disableParallelTick() const;
      virtual bool enableMetoc() const;
      virtual bool issueSimExitOnFinishTestCommand() const;

      virtual void setDisableParallelPublisherTick(bool);
      virtual bool disableParallelPublisherTick() const;

      virtual void setTickPublishersDuringEntityTick(bool);
      virtual bool tickPublishersDuringEntityTick() const;

      virtual DtFilename testLogFile() const;

      virtual void setGamewareMemorySize(int sizeInMb);
      virtual int gamewareMemorySize() const;

      virtual void setGamewareQueryTimeBudget(double ms);
      virtual double gamewareQueryTimeBudget() const;

      virtual void setRegenerateNavigationDataAtRuntime(bool v);
      virtual bool regenerateNavigationDataAtRuntime() const;

      virtual void setMaxNavigationRegenerationThreads(int threads);
      virtual int maxNavigationRegenerationThreads() const;

      virtual void setNumberOfNavQueueProcessingThreads(int threads);
      virtual int numberOfNavQueueProcessingThreads() const;   

      virtual void setNavigationRegenerationFileDirectory(const DtString& dir);
      virtual DtFilename navigationRegenerationFileDirectory() const;

      virtual void setNavigationRegenerationDelay(double delay);
      virtual double navigationRegenerationDelay() const;

      virtual void setEnableLogFileTimestamps(bool v);
      virtual bool enableLogFileTimestamps() const;

   #ifdef WIN32
      virtual void setMainThreadToHighPriority(bool);
   #endif

      virtual std::vector<DtString> enabledChannels() const;

      virtual bool suppressDataAvailableException() const;
      virtual void setSuppressDataAvailableException(bool);

      DtApplicationSettings& settings() { return mySettings; };

   protected:
      virtual void initializeMtlParams();

      virtual void processStringList(std::vector<DtString>& v, const std::vector<DtString>& list) const;

      virtual void initPluginVariables();

      virtual void processPluginsDirectory(const DtFilename& directory);

   private:
      DtVrfSimOptions(const DtVrfSimOptions& orig);

      DtVrfSimOptions& operator=(const DtVrfSimOptions& rhs);

   protected:
      DtConfigVariable<DtString>    mySimulationModelSetFile;
   
      DtConfigVariable<DtString>    myBatchFile;

      DtConfigVariable<int>         myTargetFrameRate;

      DtConfigVariable<int>         myClockMode;

      DtConfigVariable<int>         mySessionId;

      DtConfigVariable<int>         myAppIdRangeMax;

      DtConfigVariable<DtString>    myScenarioFile;

      DtConfigVariable<DtString>   mySharedSettingsDirectory;

      DtConfigVariable<bool>       myUseUserSettingsDirectory;

      DtConfigVariable<DtString>    myTerrainFile;

      short                         myUseDIGuy;

      DtConfigVariable<DtString>    mySharedDataDir;

      DtConfigVariable<DtString>    mySharedDataRoot;

      DtConfigVariable<DtString>    mySharedDataStem;

      DtConfigVariable<DtString>    myDIGuyCharacterDataFile;
      DtConfigVariable<DtString>    myDIGuyAnimationsFile;

      DtConfigVariable<DtString>    mySettingsFile;

      DtConfigVariable<DtString>    myAppDataDir;

      DtConfigVariable<DtString>    myDataDir;

      DtConfigVariable<DtString>    myUserDataDir;

      DtConfigVariable<DtString>    myAdditionalSystemScriptsDirectory;

      DtConfigVariable<int>         myFrontEndPID;

      DtConfigVariable<bool> myCmdConnectionless;
      DtConfigVariable<bool> myCmdDisableRemoteDiscovery;

   #ifndef WIN32
      DtConfigVariable<bool>        myCmdDaemonMode;
      short myDaemonMode;
   #endif

      short          myReuseEntityIdentifiersOnScenarioLoad;

      int myCgfDispatcherReceivePort;

      DtString myReportedHostAddress;
   
      int         myStatusUpdateHeartbeat;
      short       myForceParameterDbReload;

      short       myLogFrameRateStatistics;

      short       myEnableNavigationLabDebugging;

      DtFilename  myDefaultParameterDatabasePath;
      DtFilename  myDefaultTerrainDatabasePath;
   
      short myStartInRunMode;

   #ifdef WIN32
      short myDoNotUseConsole;
      short myStartMinimized;
   #endif
   
      DtFilename myPluginsDirectory;

   #ifdef WIN32
      DtConfigVariable<bool>             myCmdNotUsingConsole;
      DtConfigVariable<bool>             myCmdStartMinimized;
   #endif
      DtConfigVariable<bool>             myCmdStartInRunMode;
      DtConfigVariable<bool>             myCmdDoNotUsePluginsDirectory;

      DtConfigVariable<bool>             myCmdLogFrameRateStatistics;

      DtMultiConfigVariable<std::string>    myPluginFiles;
   
      DtMultiConfigVariable<DtString>    myEnabledChannels;

      std::vector<std::string> myPluginsToLoad;
      bool  myDoNotUsePluginsDirectory;
      DtConfigVariable<DtString> myOutputFile;

      short       mySimMgmtPduProcessLevel;

      short       myLoadPluginIfVersionMismatch;

      int myObjectConsoleNotifyLevel;
      short mySendBackendLogToNetwork;

      DtConfigVariable<bool>             myCmdFullyLoadTerrain;
      short                              myFullyLoadTerrain;

      short                              myAssertOnBlockingTerrainCalls;
      short                              myPublishZeroVelocityWhenPaused;
      short                              mySetDeadReckoningAlgorithmToStaticOnPause;
      short                              mySendMessagesInNetworkProcess;

      DtVrfPluginRecordManager            myPluginRecordManager;

      DtConfigVariable<DtString> myHostAddress;

      DtConfigVariable<DtString> myMsdlSidcMappingFile;
      DtConfigVariable<DtString> myCountryCodesMappingFile;

      DtConfigVariable<int>  myTracyPort;
      DtConfigVariable<int>  myCmdNumCallbackThreads;
      DtConfigVariable<bool> myCmdMainThreadWaitForQueue;
      DtConfigVariable<bool> myCmdDisableParallelTick;
      DtConfigVariable<bool> myCmdDisableParallelPublisherTick;
      short myDisableParallelPublisherTick;
      DtConfigVariable<bool> myCmdTickPublishersDuringEntityTick;
      short myTickPublishersDuringEntityTick;

      DtConfigVariable<bool> myCmdIssueSimExitOnFinishTestCommand;
      DtConfigVariable<DtString> myCmdLogTestFilename;

      DtConfigVariable<bool> myCmdEnableMetoc;

      short myMainThreadWaitForQueue;
      short myDisableParallelTick;
      short mySelfReflect;
      short myLegion;
      short myIssueSimExitOnFinishTestCommand;
      short myEnableMetoc;
   #ifdef WIN32
      DtConfigVariable<bool> myCmdSetMainThreadToHighPriority;
      short mySetMainThreadToHighPriority;
   #endif
   #if USE_VLD_MEMORY_TRACKING && _DEBUG
      DtConfigVariable<bool> myUseVld;
   #endif

      int myGamewareMemorySize;
      double myGamewareQueryTimeBudget;
      short myRegenerateNavigationDataAtRuntime;
      int myMaxNavigationRegenerationThreads;
      int myNumberOfNavQueueProcessingThreads;
      double myNavigationRegenerationDelay;
      DtFilename myNavigationRegenerationFileDirectory;

      short myEnableLogFileTimestamps;

      short myRejectMismatchedScenarioMessages;

      DtConfigVariable<bool> myCmdSuppressDataAvailableException;
      int mySuppressDataAvailableException;
   };

   inline const std::vector<std::string>& DtVrfSimOptions::pluginsToLoad() const
   {
      return myPluginsToLoad;
   }
}