vrfSimulationSettingsManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiApplicationSettings.h>
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfSimulationSettingsRecord.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vlutil/vlFilename.h>
#include <boost/unordered_map.hpp>
#include <boost/signals2.hpp>

class DtUUID;

namespace makVrv
{
   class DtRecordSettingsBackupInterface;
   class DtDe;
}

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtVrfSimulationSettingsManager : public makVrv::DtVirtualBaseClass
   {
   public:
      DtVrfSimulationSettingsManager(makVrv::DtDe&);
      virtual ~DtVrfSimulationSettingsManager() override;

      static DtVrfSimulationSettingsManager& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe& de, DtVrfSimulationSettingsManager*);

      virtual void setDefaultScenarioFile(const std::string& f, bool save = false);
      virtual std::string defaultScenarioFile() const;

      virtual void setSimulationObjectGroupTerrain(const std::string& f, bool save = false);
      virtual std::string simulationObjectGroupTerrain() const;

      virtual void setDefaultSimulationModelSetFile(const std::string& f, bool save = false, bool signalChange = true);
      virtual std::string defaultSimulationModelSetFile() const;
      virtual void setFromRecord(const DtVrfSimulationSettingsRecord& rec);
      virtual void loadDefaultSimulationSettings(bool loadOnlyFactorySettings = false);
      virtual void getRecord(DtVrfSimulationSettingsRecord& rec) const;

      virtual void getSplitRecord(std::vector<DtVrfSimulationSettingsRecord>& rec,
         std::vector<std::string>& fileNames) {};

      virtual void addRecords(DtVrfSimulationSettingsRecord& recs,
         DtVrfSimulationSettingsRecord& combinedRec) {};

      virtual void setAutoSave(bool);
      virtual bool autoSave() const;

      virtual void setCheckForUnusedTriggersOnPlanSave(bool);
      virtual bool checkForUnusedTriggersOnPlanSave() const;

      virtual void setDefaultScenarioStartTime(time_t);
      virtual time_t defaultScenarioStartTime() const;

      virtual void setDefaultEnvironmentCondition(const std::string& defaultCondition, bool save = true);
      virtual std::string defaultEnvironmentCondition() const;

      virtual void setEnablePeriodicCheckpointing(bool);
      virtual bool enablePeriodicCheckpointing() const;

      virtual void setPeriodicCheckpointingFrequency(int);
      virtual int periodicCheckpointingFrequency() const;

      virtual void setPeriodicCheckpointingDirectory(const std::string&);
      virtual const std::string& periodicCheckpointingDirectory() const;
      const DtFilename& periodicCheckpointingDirectoryResolved() const { return myPeriodicCheckpointDirectory; };

      makVrv::DtRecordSettingsBackupInterface*  simulationSettingsBackup()
      {
         return mySimulationSettingsBackup;
      }

      void exportSimulationSettings(const std::string& fileName);

      void importSimulationSettings(const std::string& fileName);

      virtual void setStartupTerrain(const std::string&);
      virtual const std::string& startupTerrain() const;

      virtual void setStartupScenario(const std::string&);
      virtual const std::string& startupScenario() const;

      virtual void setStartupSimulationModelSet(const std::string&);
      virtual const std::string& startupSimulationModelSet() const;

      virtual void setAllowOrbatDeletionChoice(bool);
      virtual bool allowOrbatDeletionChoice() const;

      virtual void saveSettingsAsDefault();

      virtual void setSimulationModelSetConfigurations(const std::vector<DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration>&);
      virtual const std::vector<DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration>& simulationModelSetConfigurations() const;

      virtual void addSimulationModelSetConfiguration(const DtVrfSimulationSettingsRecord::SimulationModelSetConfiguration&,
         bool autoSaveIfEnabled = true);

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

      virtual void setAutomaticallyStartMissingBackends(bool);
      virtual bool automaticallyStartMissingBackends() const;

   public:
      boost::signals2::signal<void (const DtVrfSimulationSettingsRecord&)> signal_simulationSettingsChanged;

   protected:
      makVrv::DtDe&              myDe;
      DtVrfSimulationSettingsRecord            mySimulationSettings;
      makVrv::DtRecordSettingsBackupInterface*  mySimulationSettingsBackup;

      DtFilename myPeriodicCheckpointDirectory;
   };
}