WsfStandardApplication.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFSTANDARDAPPLICATION_HPP
#define WSFSTANDARDAPPLICATION_HPP
 
#include "wsf_export.h"
 
#include "PakLogServerSubscriber.hpp"
#include "WsfApplication.hpp"

class WSF_EXPORT WsfStandardApplication : public WsfApplication
{
public:
   class InvalidCommandLineArgument : public Exception
   {
   public:
      InvalidCommandLineArgument(const std::string& aToken);
      ~InvalidCommandLineArgument() override = default;
   };

   class InputProcessingFailure : public Exception
   {
   public:
      InputProcessingFailure(const std::string& aWhat, bool aIsExpected);
      ~InputProcessingFailure() override = default;
   };

   struct SimulationResult
   {
      bool mResetRequested = false;
   };

   enum SimType
   {
      cEVENT_STEPPED, 
      cFRAME_STEPPED, 
      cREAL_TIME      
   };

   enum RunMode
   {
      cRUN_SCENARIO,   
      cLIST_VARIABLES, 
      cSHOW_USAGE,     
      cWRITE_GRAMMAR   
   };

   struct WSF_EXPORT Options
   {
      SimType                  mSimType = cEVENT_STEPPED;
      bool                     mFlushIO = false;
      std::vector<std::string> mInputFiles;
      double                   mDeferredConnectionTime  = 0.0;
      double                   mMessageInterval         = 1000.0;
      double                   mRealtimeMessageInterval = 1.0;
      RunMode                  mRunMode                 = cRUN_SCENARIO;
   };
 
   WsfStandardApplication(const std::string& aApplicationName,
                          int                argc,
                          char*              argv[],
                          const PluginPaths& aPluginPaths = PluginPaths());
   ~WsfStandardApplication() override = default;
 
   void ShowUsage();
 
   void ProcessCommandLine(Options& aOptions);
 
   void ProcessCommandLine(Options& aOptions, int argc, char* argv[]);
 
   void ProcessCommandLineCommands(WsfScenario& aScenario, const Options& aOptions);
 
   void ProcessInputFiles(WsfScenario& aScenario, const std::vector<std::string>& aFileList);
 
   virtual std::unique_ptr<WsfSimulation> CreateSimulation(WsfScenario& aScenario,
                                                           SimType      aSimulationType,
                                                           unsigned int aRunNumber);
   virtual std::unique_ptr<WsfSimulation> CreateSimulation(WsfScenario&   aScenario,
                                                           const Options& aOptions,
                                                           unsigned int   aRunNumber);
 
   bool InitializeSimulation(WsfSimulation* aSimPtr);
 
   SimulationResult RunEventLoop(WsfSimulation* aSimPtr, Options aOptions);
 
protected:
   log_server::LogSubscriber mLogServer;
   std::string               mLogServerHost            = "localhost";
   int                       mLogServerPort            = 18888;
   bool                      mShouldConnectToLogServer = false;
   virtual std::string       GetUsageString() const;
   void                      UpdateOptionsP(Options& aOptions, WsfSimulation* aSimPtr);
 
private:
   void ConnectToLogServer();
};
 
#endif