vrfSessionSettingsManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiApplicationSettings.h>
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfSessionSettingsRecord.h>
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vlutil/vlFilename.h>

#include <vrvCore/DtStateView.h>
#include <vrvCore/DtEntityState.h>

#include <boost/signal.hpp>
#include <boost/unordered_map.hpp>

class DtUUID;

namespace makVrv
{
   class DtRecordSettingsBackupInterface;
   class DtDe;
}

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

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

      virtual void setHelpFile(const std::string&, bool save = false);
      virtual std::string helpFile() const;

      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 DtVrfSessionSettingsRecord& rec);
      virtual void loadDefaultSessionSettings(bool loadOnlyFactorySettings = false);
      virtual void getRecord(DtVrfSessionSettingsRecord& rec) const;

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

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

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

      virtual bool autoJoinSession() const;
      virtual bool automaticallyOpenSessionDatabaseWithoutJoiningSession() const;
      virtual bool askToJoin() const;
      virtual bool alwaysJoinWithSessionDatabase() const;
      virtual bool zoomToScenarioExtentsOnLoad() const;
      virtual bool alwaysJoinWithOpenDatabase() const;
      virtual bool useSimulationTimeForAdvancement() const;
      virtual bool showOverlayBar() const;

      virtual void setUseAdditionalWindowTitle(bool);
      virtual bool useAdditionalWindowTitle() const;

      virtual void setAdditionalWindowTitle(const makVrv::DtUnicode&);
      virtual makVrv::DtUnicode additionalWindowTitle() const;

      virtual void setScenarioStartTimeAtDefault(bool);
      virtual bool scenarioStartTimeAtDefault() const;

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

      virtual void setUseStartFreezePdus(bool);
      virtual bool useStartFreezePdus() 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 addValueFor(const DtUUID&, const std::string& key, const std::string& value);
      virtual void removeValueFor(const DtUUID&, const std::string& key);
      virtual void removeValuesFor(const DtUUID&);
      virtual std::string valueFor(const DtUUID&, const std::string& key) 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*  sessionSettingsBackup()
      {
         return mySessionSettingsBackup;
      }

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

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

      virtual void setDoNotShowSessionStartupDialog(bool, bool save = true, bool signal = true);
      bool showSessionStartupDialog() const;

      virtual void setDisplaySessionDialogs(bool);
      virtual bool displaySessionDialogs() const;

      virtual void setDisplayCorrelationWarningMessages(bool);
      virtual bool displayCorrelationWarningMessages() const;

      virtual void setStartupPreference(int);
      int startupPreference() const;

      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 setTimeScaleRange(double low, double high, bool save = true);
      virtual void getTimeScaleRange(double& low, double& high) const;
      
      virtual void setAggregateOnCreate(bool);
      bool aggregateOnCreate() const;

      virtual void setUserDefinedSmoothing(bool);
      bool userDefinedSmoothing() const;

      virtual void setShowScenarioDescriptionDialog(bool b);
      virtual bool showScenarioDescriptionDialog() const;

      virtual void saveSettingsAsDefault();

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

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

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

   public:
      boost::signal<void (const DtVrfSessionSettingsRecord&)> signal_sessionSettingsChanged;

   protected:
      makVrv::DtDe&              myDe;
      DtVrfSessionSettingsRecord            mySessionSettings;
      makVrv::DtRecordSettingsBackupInterface*  mySessionSettingsBackup;

      typedef boost::unordered_map<std::string, std::string> KeyValuePairs;
      typedef boost::unordered_map<DtUUID, KeyValuePairs> KeyValuePairsByUUID;
      typedef boost::unordered_map<DtString, DtUUID> UUIDByMarkingText;
      KeyValuePairsByUUID myKeyValuePairsByUUID;
      UUIDByMarkingText myUUIDByMarkingText;

      DtFilename myPeriodicCheckpointDirectory;
   };
}