exerciseConnConfig.h

Go to the documentation of this file.

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


#pragma once

#include "vlutil/vlUtil.h"
#include "vlutil/vlTimeStampType.h"
#include <vlutil/vlMachineTypes.h>

#include <mtl/applicationSettings.h>
#include <mtl/configVariable.h>
#include <mtl/multiConfigVariable.h>
#include "vlutil/vlAttributePduStrategy.h"


#define DtDefaultConfigFile "MAK-ONE-2025-Config.xml"

class DT_DLL_VLPROTIND DtExerciseConnConfig
{
public:
   DtExerciseConnConfig(const DtString& appName = "VR-Link",
      const DtString& version = VR_LINK_VERSION_STRING);

   virtual ~DtExerciseConnConfig();

   // Copy constructor
   DtExerciseConnConfig(const DtExerciseConnConfig& orig);

   // Assignment operator
   DtExerciseConnConfig& operator=(const DtExerciseConnConfig& orig);

   //virtual void parseCmdLine();

   virtual void loadFile(const DtString& fileName);

   //{@
   virtual void setPort(int port);
   virtual int port() const;

   //{@
   virtual void setExerciseId(int id);
   virtual int exerciseId() const;

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

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

   //{@
   virtual void setDestinationAddress(const DtString& address);
   virtual DtString destinationAddress() const;

   virtual void setNotifyLevel(int level);

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

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

   virtual int disVersionValue() const;

   virtual void setSendBufferSize(int numBytes);
   virtual int sendBufferSize() const;

   virtual void setReceiveBufferSize(int numBytes);
   virtual int receiveBufferSize() const;

   virtual void setUseAsynchIO(bool on);
   virtual bool useAsynchIO() const;

   virtual void setMulticastTtl(int ttl);
   virtual int multicastTtl() const;

   virtual void setTimeStampType(DtTimeStampType relOrAbs);
   virtual DtTimeStampType timeStampType() const;

   virtual void setUseAbsoluteTimeStamp(bool useAbsoluteTimeStamp);
   virtual bool useAbsoluteTimeStamp() const;

   virtual void setMulticastAddresses(const std::vector<DtString>& addresses);
   virtual const std::vector<DtString>& multicastAddresses() const;

   virtual void setUseIpv6(bool val);
   virtual bool useIpv6() const;

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

   virtual void setSuppressSelfReflect(bool yesNo);

   virtual bool suppressSelfReflect() const;

   virtual void setDeviceAddress(const DtString& devAddr);

   virtual DtString deviceAddress() const;

   virtual void setSubnetMask(const DtString& mask);

   virtual DtString subnetMask() const;

   virtual void setAttributePduStrategy(DtAttributePduStrategy strat);

   virtual DtAttributePduStrategy attributePduStrategy() const;

   virtual void setOutputInterval(double period);

   virtual double outputInterval() const;


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

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


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

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

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

   //{@
   void setFedFileName(const DtString& name);
   virtual DtString fedFileName() 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 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 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 printFomModules();
   
   virtual void fomModules(std::vector<DtString>& fomModules) const;


   virtual void initializeFileLogging();

   virtual void initializeDisConnectionConfigVariables();

   virtual void initializeDisConnectionConfigVariablesNames();

   virtual void initializeHlaConnectionConfigVariables();

   virtual void initializeHlaConnectionConfigVariablesNames();


   virtual DtApplicationSettings& settings();

   virtual DtVariableGroup& disConnection();

   virtual DtVariableGroup& hlaConnection();

   virtual DtConfigVariable<int>& disVersion();

   virtual DtConfigVariable<int>& notifyLevel();

   virtual DtConfigVariable<int>& portConfigVar();

   virtual DtConfigVariable<int>& exerciseIdConfigVar();

   virtual DtConfigVariable<int>& siteIdConfigVar();

   virtual DtConfigVariable<int>& applicationNumberConfigVar();

   virtual DtConfigVariable<DtString>& destinationAddressConfigVar();

   virtual DtConfigVariable<int>& sendBufferSizeConfigVar();

   virtual DtConfigVariable<int>& receiveBufferSizeConfigVar();

   virtual DtMultiConfigVariable<DtString>& multicastAddressesConfigVar();

   virtual DtConfigVariable<bool>& useAsynchIOConfigVar();

   virtual DtConfigVariable<bool>& useIpv6ConfigVar();

   virtual DtConfigVariable<bool>& dis5TimeStampsConfigVar();

   virtual DtConfigVariable<bool>& useAbsoluteTimestampsConfigVar();

   virtual DtConfigVariable<int>& mutlicastTtlConfigVar();

   virtual DtConfigVariable<DtString>& deviceAddressConfigVar();

   virtual DtConfigVariable<DtString>& subnetMaskConfigVar();

   virtual DtConfigVariable<DtString>& notifyFilenameConfigVar();

   virtual DtConfigVariable<int>& notifyFileLevelConfigVar();

   virtual DtConfigVariable<int>& attributeStrategyConfigVar();

   virtual DtConfigVariable<double>& outputIntervalConfigVar();

   virtual DtMultiConfigVariable<DtString>& mutlicastAddressConfig();



   virtual DtConfigVariable<DtString>& execNameConfigVar();

   virtual DtConfigVariable<DtString>& federateNameConfigVar();

   virtual DtConfigVariable<DtString>& federateTypeConfigVar();

   virtual DtConfigVariable<DtString>& fedFileNameConfigVar();

   virtual DtMultiConfigVariable<DtString>& fomModulesConfigVar();

   virtual DtConfigVariable<DtString>& mimModuleConfigVar();

   virtual DtConfigVariable<DtString>& localSettingsDesignatorConfigVar();

   virtual DtConfigVariable<DtString>& fomMapperLibConfigVar();

   virtual DtConfigVariable<DtString>& fomMapperInitDataConfigVar();

   virtual DtConfigVariable<double>& rprFomVersionConfigVar();

   virtual DtConfigVariable<int>& rprFomRevisionConfigVar();

   virtual DtConfigVariable<double>& netnFomVersionConfigVar();

   virtual DtConfigVariable<int>& netnFomRevisionConfigVar();

   virtual DtConfigVariable<bool>& useAdvisoriesConfigVar();

   virtual DtConfigVariable<double>& defaultWaitListRefreshPeriodConfigVar();


protected:
   DtApplicationSettings           mySettings;
   DtConfigVariable<int>           myNotifyLevel;
   DtConfigVariable<int>           myConfigVarSiteNumber;
   DtConfigVariable<int>           myConfigVarApplicationNumber;
   DtConfigVariable<bool>          myConfigVarDis5TimeStamps;
   DtConfigVariable<bool>          myConfigVarUseAbsoluteTimestamps;
   DtConfigVariable<int>           myConfigVarNotifyFileLevel;
   DtConfigVariable<DtString>      myConfigVarNotifyFilename;
   DtConfigVariable<double>        myConfigVarOutputInterval;
   DtVariableGroup                 myDisConnection;
   DtVariableGroup                 myHlaConnection;
   DtConfigVariable<int>           myConfigVarPort;
   DtConfigVariable<int>           myConfigVarExerciseId;
   DtConfigVariable<int>           myConfigVarDisVersion;
   DtConfigVariable<DtString>      myConfigVarDestinationAddress;
   DtConfigVariable<int>           myConfigVarSendBufferSize;
   DtConfigVariable<int>           myConfigVarReceiveBufferSize;
   DtConfigVariable<bool>          myConfigVarUseAsyncIo;
   DtConfigVariable<bool>          myConfigVarUseIpv6;
   DtConfigVariable<bool>          myConfigVarSuppressSelfReflect;
   DtConfigVariable<int>           myConfigVarMulticastTtl;
   DtMultiConfigVariable<DtString> myConfigVarMulticastAddresses;
   DtConfigVariable<DtString>      myConfigVarDeviceAddress;
   DtConfigVariable<DtString>      myConfigVarSubnetMask;
   DtConfigVariable<int>           myConfigVarAttributeStrategy;

   // If logging is turned on, this printer will remain in memory
   // even after this class is destroyed. Otherwise we would 
   // have to stop logging prematurely.
   DtFilePrinter*                  myLogFilePrinter;




   DtConfigVariable<DtString> myConfigVarFederateType;
   DtConfigVariable<DtString> myConfigVarExecName;
   DtConfigVariable<DtString> myConfigVarFedFileName;
   DtConfigVariable<DtString> myConfigVarFederateName;

   DtMultiConfigVariable<DtString> myConfigVarFomModules;
   DtConfigVariable<DtString> myConfigVarMimModule;
   DtConfigVariable<DtString> myConfigVarLocalSettingsDesignator;


   DtConfigVariable<DtString> myConfigVarFomMapperLibName;
   DtConfigVariable<DtString> myConfigVarFomMapperInitData;
   DtConfigVariable<double>   myConfigVarRprFomVersion;
   DtConfigVariable<int>      myConfigVarRprFomRevision;
   DtConfigVariable<double>   myConfigVarNetnFomVersion;
   DtConfigVariable<int>      myConfigVarNetnFomRevision;
   DtConfigVariable<bool>     myConfigVarUseAdvisories;
   DtConfigVariable<bool>     myConfigVarRequestClassUpdate;
   DtConfigVariable<bool>     myConfigVarRequestObjectUpdate;
   DtConfigVariable<bool>     myConfigVarRequestWhenInitialized;
   DtConfigVariable<bool>     myConfigVarDefaultRefreshWaitList;
   DtConfigVariable<double>   myConfigVarDefaultWaitListRefreshPeriod;
   DtConfigVariable<bool>     myConfigVarUseGeographicDdm;
   DtConfigVariable<bool>     myConfigVarDestroyFedExec;
   DtConfigVariable<bool>     myConfigVarSendFedTime;
   DtConfigVariable<bool>     myConfigVarGenericAttributes;
   DtConfigVariable<bool>     myConfigVarPauseOnSaveRestore;
   DtConfigVariable<bool>     myConfigVarRtiCompilerCheck;
};