vrfGuiApplication.h

Go to the documentation of this file.

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

#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfGuiPluginManager.h>
#include <vrvCore/DtVrvApplication.h>
#include <vlpi/simulationAddress.h>
#include <boost/signals2.hpp>

const int MIN_VRF_ELEMENT_DEFINITION_TYPE = 26000;
const int MIN_VRF_USER_ELEMENT_DEFINITION_TYPE = 27000;

namespace makVrv
{
   class DtMenuConfiguration;
   class DtDe;
   class DtVrvApplicationConfiguration;
   class DtElementDefinitionManager;
   class DtVrlinkDriver;
}

namespace makVrf 
{

   class DtVrfGuiPluginManager;

   class DT_DLL_VRFGUICORE DtVrfGuiApplication : public makVrv::DtVrvApplication
   {
   public:
      typedef std::map<std::string, std::string> ObserverModeBindings;

      enum ObserverMode
      {
         PvdAndStealthMode = 0,
         PvdMode,
         StealthMode
      };

   public:
      DtVrfGuiApplication(makVrv::DtVrvApplicationConfiguration& config);

      virtual ~DtVrfGuiApplication();

      static bool applicationIsTerminating(makVrv::DtDe&);

      virtual void initialize( int argc, char** argv);

      virtual void preInitialize(int argc, char** argv) override;
      virtual void assemble() override;

      virtual void run();

      static DtVrfGuiApplication* app(makVrv::DtDe&);

      static makVrv::DtDe* theDe();

      static void SetQtDesignerMode(bool);
      static bool QtDesignerMode();

      static void setNoSpotReportDefinitionLoading(bool val);
      static bool noSpotReportDefinitionLoading();

      static void setSpotReportElementDefinitionHierFilesOrDirs(const std::vector<std::string>& filesOrDirs);
      static const std::vector<std::string>& spotReportElementDefinitionHierFilesOrDirs();

      static void setSpotReportElementDefinitionLeafFilesOrDirs(const std::vector<std::string>& filesOrDirs);
      static const std::vector<std::string>& spotReportElementDefinitionLeafFilesOrDirs();

      static void setIgnoreLayoutGeometryOnInitialLoad(bool);
      static bool ignoreLayoutGeometryOnInitialLoad();

      static void setShowPerspective(const std::string&);

      static void setQtDesignerPluginSupport(bool);
      static bool qtDesignerPluginSupport();

      static void setGuiConfiguration(const std::string&);

      static void setObserverModeBindings(const ObserverModeBindings& modes);

      static const ObserverModeBindings& observerModeBindings();

      static const std::vector<std::string>& additionalPluginsToLoad();

      static void setAdditionalPluginsToLoad(const std::vector<std::string>&);

      static bool loadDefaultPlugins();

      static void setLoadDefaultPlugins(bool);

      static bool checkPluginVersions();

      static void setCheckPluginVersions(bool);

      static const std::string& transport();

      static void setTransport(const std::string&);

      static const std::string& loadScenario();

      static void setLoadScenario(const std::string&);

      static const std::string& useFileCommChannel();
      static void setUseFileCommChannel(const std::string&);

      static void setLayoutSettingsFile(const std::string&);
      static std::string layoutSettingsFile();

      virtual DtString layoutSettingsFileClassName() const;

      static const std::string& loadSimulationObjectGroup();

      static void setLoadSimulationObjectGroup(const std::string&);

      static void setDefaultSimulationModelSet(const std::string&);
      static const std::string& defaultSimulationModelSet();

      static ObserverMode observerMode();

      static void setObserverMode(ObserverMode);

      static void setUserScenarioDirectory(const std::string&);
      virtual std::string userScenarioDirectory();

      void setPluginApplication(const std::string&);

      const std::string& pluginApplication() const;

      static void setShouldLoadGuiSavedState(bool);
      static bool shouldLoadGuiSavedState();

      virtual void setLoadSystemPlugins(bool);
      virtual bool loadSystemPlugins() const;

      virtual makVrv::DtUnicode applicationName() const;

      virtual void writeGuiConfiguration();

      virtual void loadSavedGuiState();

      virtual bool getShowStartupScreen() const;

      virtual bool usingAbsoluteTimeStamps() const;

      virtual std::string restoreDefaultLayout(const DtString& layoutTemplate = "Scenario_Creation");

      virtual bool usingAsynchIO() const;

      virtual makVrv::DtVrlinkDriver* getVrlinkDriver() const;

      virtual DtSimulationAddress frontEndSimulationAddress() const;

      virtual bool vrlDriverHasBooleanValue(const std::string&, bool* hasValue = NULL) const;
      virtual bool vrlDriverHasBooleanValue(makVrv::DtVrlinkDriver*, const std::string&, bool* hasValue = NULL) const;
      virtual int vrlDriverHasIntegerValue(const std::string&, bool* hasValue = NULL) const;
      virtual int vrlDriverHasIntegerValue(makVrv::DtVrlinkDriver*, const std::string&, bool* hasValue = NULL) const;
      virtual double vrlDriverHasDoubleValue(const std::string&, bool* hasValue = NULL) const;
      virtual double vrlDriverHasDoubleValue(makVrv::DtVrlinkDriver*, const std::string&, bool* hasValue = NULL) const;
      virtual std::string vrlDriverHasStringValue(const std::string&, bool* hasValue = NULL) const;
      virtual std::string vrlDriverHasStringValue(makVrv::DtVrlinkDriver*, const std::string&, bool* hasValue = NULL) const;

      void setVrfSvnRevision(const std::string& s) { myVrfSvnRevision = s; };
      const std::string& vrfSvnRevision() const { return myVrfSvnRevision; };

      void setVrvSvnRevision(const std::string& s) { myVrvSvnRevision = s; };
      const std::string& vrvSvnRevision() const { return myVrvSvnRevision; };

      virtual bool terrainIsValid(int terrainPathOffset = 0);

      virtual std::string language() const;

      virtual void checkOrCreateModelDefinition(const std::string& definition, const std::string& filePath);

      virtual void addLoadVerifierFunction(const DtString&, DtVrfGuiPluginManagerExt::VerifierFunction f);

   protected:
      virtual void loadPluginModules() override;

      virtual void loadPluginModulesExt();

      virtual void addPluginVerifierFunctions();

      virtual void delayedAssemble();

   public:
      boost::signals2::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> signal_preAssemble;
      boost::signals2::signal<void (makVrv::DtDe&, makVrv::DtMenuConfiguration&)> signal_postAssemble;
      boost::signals2::signal<void (makVrv::DtDe&)> signal_deInitialized;
      boost::signals2::signal<void ()> signal_preLoadPlugins;
      boost::signals2::signal<void ()> signal_postLoadPlugins;
      boost::signals2::signal<void ()> signal_preWriteGuiConfiguration;
      boost::signals2::signal<void ()> signal_postWriteGuiConfiguration;
      boost::signals2::signal<void (std::string)> signal_terrainSaved;
      boost::signals2::signal<void (std::string)> signal_simTerrainSaved;
      boost::signals2::signal<void ()> signal_defaultLayoutLoaded;
      boost::signals2::signal<void ()> signal_vrfApplicationInitialized;
      boost::signals2::signal<void ()> signal_dataDoesNotExist;

      boost::signals2::signal<void ()> signal_qtExtensionsPreInitialize;
      boost::signals2::signal<void ()> signal_qtExtensionsPostInitialize;

   protected:
      virtual void loadTranslationFiles(const std::string& lang);

      virtual void initializePluginManager();

      virtual void initializePluginsForCommandLineArguments(int argc, char** argv);

      virtual void bindObserverModes(const ObserverModeBindings& modes);

      virtual DtVrfGuiPluginManager* createPluginManager();

      virtual void dePostInitialize();

      virtual void setupForObserverMode();

      virtual void setupForPvdMode();

      virtual void setupForStealthMode();

      virtual bool updateCurrentGuiConfiguration();

      virtual void initializeWithVRFSymbolDecorations(const std::string&);

   protected:
      static ObserverModeBindings      theObserverModeBindings;
      static std::vector<std::string>  theAdditionalPluginsToLoad;
      static bool                      theLoadDefaultPlugins;
      static bool                      theCheckPluginVersions;
      static std::string               theTransport;
      static std::string               theLoadScenario;
      static std::string               theLayoutSettingsFile;
      static std::string               theLoadSimulationObjectGroup;
      static std::string               theUseFileCommChannel;
      static std::string               theGuiConfiguration;
      static std::string               theShowPerspective;
      static std::string               theDefaultSimulationModelSet;
      static std::string               theUserScenarioDirectory;
      static ObserverMode              theObserverMode;
      static bool                      theLoadGuiSavedState;
      static bool                      theIgnoreLayoutGeometryOnInitialLoad;
      static bool                      theQtDesignerPluginSupport;
      static bool                      theNoSpotDefinitionLoading;
      static std::vector<std::string>  theSpotReportElementDefinitionHierFilesOrDirs;
      static std::vector<std::string>  theSpotReportElementDefinitionLeafFilesOrDirs;
      static bool                      theQtDesignerMode;
      static makVrv::DtDe*             theAppDe;

      DtVrfGuiPluginManager*           myVrfGuiPluginManager;
      std::string                      myPluginApplication;
      std::string                      myVrfSvnRevision;
      std::string                      myVrvSvnRevision;

      bool myLoadSystemPlugins;
      boost::signals2::scoped_connection myDelayedAssembleConnection;
   };
}