DtVrfSessionSettingsManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/DtVrfGuiApplicationSettings.h>
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/DtVrfSessionSettingsRecord.h>
#include <vrvUtil/DtVirtualBaseClass.h>

#include <boost/signal.hpp>

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 setDefaultSimulationModelSetFile(const std::string& f, bool save = false);
      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 setAutoSave(bool);
      virtual bool autoSave() const;

      virtual bool autoJoinSession() const;
      virtual bool askToJoin() const;
      virtual bool alwaysJoinWithSessionDatabase() const;
      virtual bool zoomToScenarioExtentsOnLoad() const;
      virtual bool alwaysJoinWithOpenDatabase() const;

      makVrv::DtRecordSettingsBackupInterface*  sessionSettingsBackup()
      {
         return mySessionSettingsBackup;
      }

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

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

      virtual void setDoNotShowSessionStartupDialog(bool);
      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 setAggregateOnCreate(bool);
      bool aggregateOnCreate() const;

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

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

      virtual void saveSettingsAsDefault();

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

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