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 <boost/unordered_map.hpp>
#include <boost/signals2.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() override;

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

      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 alwaysJoinWithOpenDatabase() const;

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

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

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

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

      virtual void saveSettingsAsDefault();

      virtual void setAllowScenarioChanges(bool);
      virtual bool allowScenarioChanges() 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 setBackendTimeoutInterval(int);
      virtual int backendTimeoutInterval() const;

   public:
      boost::signals2::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;
   };
}