vrfGuiCommandLineParser.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiApplication.h>
#include <vrfGuiCore/vrfDe.h>
#include <vrfGuiCore/vrfGuiPluginManager.h>

#include <vrvCore/DtStealthCommandLineProcessor.h>

#include <cmdLine/cmdArg.h>
#include <cmdLine/cmdLine.h>

#include <boost/function.hpp>

namespace makVrf
{
   class DtVrfGuiCommandLineParser : public makVrv::DtStealthCommandLineProcessor
   {
   protected:
      typedef boost::function<void (std::vector<DtCmdLine::Arg*>&,
         makVrv::DtStealthCommandLineProcessor::StealthArgs&)> DtAdditionalCommandsFcn;

   public:
      DtVrfGuiCommandLineParser();

      virtual ~DtVrfGuiCommandLineParser() override;

      virtual void processCommandLine(makVrv::DtVrvApplicationConfiguration& appConfig, int argc, char** argv) override;

      virtual void removeAutoStartDriver();

      void setAllowObserverModeFlags(bool);

      virtual void addAdditionalCommandLineArgument(DtCmdLine::Arg* addlArg);

      const std::string& autoStartDriver() const
      {
         return myAutoStartDriver;
      }

   protected:
      struct BaseArgs
      {
         virtual void processArgs(makVrv::DtVrvApplicationConfiguration& appConfig, StealthArgs& args, std::string& autoStartDriver) = 0;
         virtual std::string driverName() const = 0;
         virtual std::string driverClass() const = 0;

         DtVrfGuiCommandLineParser* myParser;
         DtCmdLine::ValueArg<int>*     siteId;
         DtCmdLine::ValueArg<int>*     appId;
         DtCmdLine::SwitchArg*         useAbsoluteTimeStamps;
         DtCmdLine::ValueArg<int>*     fileTransporterReceivePort;
         DtCmdLine::ValueArg<int>*     numberOfRemoteNetworkThreads;
         DtCmdLine::SwitchArg*         disableRemoteDiscovery;
         DtCmdLine::SwitchArg*         processStateDataUponDiscovery;
      };

      struct LegionArgs : public BaseArgs
      {
         virtual void processArgs(
            makVrv::DtVrvApplicationConfiguration& appConfig, StealthArgs& args, std::string& autoStartDriver) override;
         virtual std::string driverName() const override;
         virtual std::string driverClass() const override;

         DtCmdLine::ValueArg<int>*     port;
         DtCmdLine::ValueArg<int>*     siteId;
         DtCmdLine::ValueArg<int>*     appId;
         DtCmdLine::ValueArg<int>*     sessionId;
         DtCmdLine::ValueArg<std::string>*   serverAddress;
         DtCmdLine::ValueArg<std::string>*   deviceAddress;
         DtCmdLine::ValueArg<std::string>*   hostAddress;
         DtCmdLine::ValueArg<std::string>*   reportedHostAddress;
      };

      struct DisArgs : public BaseArgs
      {
         virtual void processArgs(
            makVrv::DtVrvApplicationConfiguration& appConfig, StealthArgs& args, std::string& autoStartDriver) override;
         virtual std::string driverName() const override;
         virtual std::string driverClass() const override;

         DtCmdLine::ValueArg<int>*     port;
         DtCmdLine::ValueArg<int>*     exerciseId;
         DtCmdLine::ValueArg<int>*     disVersion;
         DtCmdLine::ValueArg<std::string>*   destinationAddress;
         DtCmdLine::ValueArg<std::string>*   deviceAddress;
         DtCmdLine::ValueArg<std::string>*   subnetMask;
         DtCmdLine::ValueArg<std::string>*   hostAddress;
         DtCmdLine::ValueArg<std::string>*   reportedHostAddress;
         DtCmdLine::ValueArg<std::string>*   appIdRange;
         DtCmdLine::ValueArg<int>*        sessionId;
         DtCmdLine::ValueArg<int>*     receiveBufferSize;
         DtCmdLine::ValueArg<int>*     sendBufferSize;
         DtCmdLine::SwitchArg*         useAsynchIO;
         DtCmdLine::SwitchArg*         useIpv6;
         DtCmdLine::ValueArg<int>*     multicastTTL;
         DtCmdLine::MultiArg<std::string>* multicastAddresses;
         DtCmdLine::ValueArg<double>*      defaultObjectTimeout;
      };

      struct Hla13Args : public BaseArgs
      {
         virtual void processArgs(
            makVrv::DtVrvApplicationConfiguration& appConfig, StealthArgs& args, std::string& autoStartDriver) override;
         virtual void setupHlaConfiguration(makVrv::DtConfiguration& config, StealthArgs& args);
         virtual std::string driverName() const override;
         virtual std::string driverClass() const override;

         DtCmdLine::ValueArg<std::string>*     execName;
         DtCmdLine::ValueArg<std::string>*     fedFileName;
         DtCmdLine::ValueArg<std::string>*     fomMapperLibName;
         DtCmdLine::ValueArg<std::string>*     fomMapperInitData;
         DtCmdLine::ValueArg<std::string>*     hostAddress;
         DtCmdLine::ValueArg<std::string>*     reportedHostAddress;
         DtCmdLine::ValueArg<int>*             sessionId;
         DtCmdLine::ValueArg<double>*          rprFomVersion;
         DtCmdLine::ValueArg<int>*             rprFomRevision;
         DtCmdLine::SwitchArg*                 useAdvisories;
         DtCmdLine::SwitchArg*                 useGeographicDdm;
         DtCmdLine::ValueArg<std::string>*     federateType;
         DtCmdLine::SwitchArg*                 disableRequestUpdates;
         DtCmdLine::SwitchArg*                 requestWhenInitialized;
      };

      struct Hla1516Args : public Hla13Args
      {
         virtual std::string driverName() const override;
         virtual std::string driverClass() const override;
      };

      struct Hla1516eArgs : public Hla13Args
      {
         virtual void setupHlaConfiguration(makVrv::DtConfiguration& config, StealthArgs& args) override;

         virtual std::string driverName() const override;
         virtual std::string driverClass() const override;

         DtCmdLine::MultiArg<std::string>*   fomModule;
         DtCmdLine::ValueArg<std::string>*   federateName;
         DtCmdLine::ValueArg<std::string>*   localSettingsDesignator;
      };

      struct Hla4Args : public Hla1516eArgs
      {
         virtual void setupHlaConfiguration(makVrv::DtConfiguration& config, StealthArgs& args) override;

         virtual std::string driverName() const override;
         virtual std::string driverClass() const override;
      };

      struct VrfGuiArgs : public makVrv::DtStealthCommandLineProcessor::StealthArgs
      {
         DtCmdLine::SwitchArg* disMode;
         DtCmdLine::SwitchArg* legionMode;
         DtCmdLine::SwitchArg* hla13Mode;
         DtCmdLine::SwitchArg* hla1516Mode;
         DtCmdLine::SwitchArg* hla1516eMode;
         DtCmdLine::SwitchArg* hla4Mode;

         DtCmdLine::MultiArg<std::string>*   pluginsToLoadArg;
         DtCmdLine::ValueArg<std::string>*   loadScenario;
         DtCmdLine::SwitchArg*               doNotLoadDefaultPluginsArg;
         DtCmdLine::SwitchArg*               doNotCheckPluginVersions;
         DtCmdLine::ValueArg<std::string>*     gui;
         DtCmdLine::ValueArg<std::string>*   fowPerspective;
         DtCmdLine::ValueArg<std::string>*   nonVrfObjectsUseUUIDScheme;
         DtCmdLine::ValueArg<std::string>*     useFileCommChannel;
         DtCmdLine::ValueArg<std::string>*     loadSimulationObjectGroup;
         DtCmdLine::ValueArg<std::string>*     defaultSimulationModelSet;
         DtCmdLine::ValueArg<std::string>*     layoutSettingsFile;
         DtCmdLine::SwitchArg*                 noAppDataSpotReportDefsLoadingArg;
         DtCmdLine::MultiArg<std::string>*     spotReportDefsHierFilesOrDirs;
         DtCmdLine::MultiArg<std::string>*     spotReportDefsLeafFilesOrDirs;
         DtCmdLine::ValueArg<std::string>*     userScenarioDirectory;
         DtCmdLine::ValueArg<std::string>*     userTerrainDirectory;
         DtCmdLine::ValueArg<std::string>*     sharedSettingsDirectory;
         DtCmdLine::SwitchArg*                 useUserSettingsDirectory;

         DtCmdLine::SwitchArg*             pvdModeOnly;
         DtCmdLine::SwitchArg*             stealthModeOnly;

         std::vector<BaseArgs*>            additionalArguments;

         DtCmdLine::SwitchArg*             enableLogFileTimestamps;
      };

      virtual void processArgs(makVrv::DtVrvApplicationConfiguration& appConfig, StealthArgs& args) override;
      virtual std::vector<DtCmdLine::Arg*> createDefaultArguments(VrfGuiArgs& args);

      virtual void addArgumentParserAddition(const std::string&, DtAdditionalCommandsFcn fcn);

      virtual void createDriver(const makVrv::DtVrvApplicationConfiguration&, const makVrv::DtConfiguration&,
         BaseArgs*, std::string& autoStarted);

      virtual std::string createDriver(const makVrv::DtVrvApplicationConfiguration& a, const makVrv::DtConfiguration&,
         const std::string& driverName, const std::string& driverClass, std::string& fullName);
      virtual std::string createDriverFileName(const makVrv::DtVrvApplicationConfiguration& a,
         const std::string& driverClass,const std::string& driverName);
      virtual void addHlaCommandArguments(std::vector<DtCmdLine::Arg*>& a,
         makVrv::DtStealthCommandLineProcessor::StealthArgs& args, Hla13Args* hlaArgs);

      virtual void bindObserverModes(const std::vector<std::string>&, makVrf::DtVrfGuiApplication::ObserverModeBindings&) const;

   protected:
      virtual void addLegionCommandArguments(std::vector<DtCmdLine::Arg*>&,
         makVrv::DtStealthCommandLineProcessor::StealthArgs&);
      virtual void addDisCommandArguments(std::vector<DtCmdLine::Arg*>&,
         makVrv::DtStealthCommandLineProcessor::StealthArgs&);
      virtual void addHla13CommandArguments(std::vector<DtCmdLine::Arg*>&,
         makVrv::DtStealthCommandLineProcessor::StealthArgs&);
      virtual void addHla1516CommandArguments(std::vector<DtCmdLine::Arg*>&,
         makVrv::DtStealthCommandLineProcessor::StealthArgs&);
      virtual void addHla1516eCommandArguments(std::vector<DtCmdLine::Arg*>&,
         makVrv::DtStealthCommandLineProcessor::StealthArgs&);
      virtual void addHla4CommandArguments(std::vector<DtCmdLine::Arg*>&,
         makVrv::DtStealthCommandLineProcessor::StealthArgs&);

      virtual void setupDefaultProtocolArguments(BaseArgs&);

      virtual std::vector<std::string> defaultObserverMode() const;

   protected:
      std::map<std::string, DtAdditionalCommandsFcn>  myAdditionalCommands;
      std::string myAutoStartDriver;
      bool myAllowObserverModeFlags;

      std::vector<DtCmdLine::Arg*> myAdditionalCommandLineArguments;
   };
}

#ifndef DtVrfGuiCommandLineParser_INL
#include <vrfGuiCore/vrfGuiCommandLineParser.inl>
#endif