DtObjectSettingsManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/signalslib.h>

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/DtGuiScenarioSettingsManager.h>
#include <vrvCore/DtSharedSettings.h>
#include <vrvCore/DtElementEntry.h>
#include <vrvUtil/event_signal.h>
#include <vrvUtil/DtUnicode.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrfGuiCore/DtVrfStateViewCollectionManager.h>

#include <vrvCore/DtDe.h>


namespace makVrv
{
   class DtEventQueueInterface;
   class DtSharedSettingsManager;
}

namespace makVrf
{
   enum ObjectSetting
   {
      ObjectSettingsRangeRings = 0x00000001
   };

   class DT_DLL_VRFGUICORE DtSharedObjectSettings : public makVrv::DtSharedSettings
   {
   public:
      typedef std::map<std::string, ObjectSetting> ObjectSettingsMap;

      friend class makVrv::DtReadSettingsLock<DtSharedObjectSettings>;
      friend class makVrv::DtWriteSettingsLock<DtSharedObjectSettings>;
      friend class makVrv::DtSharedSettingsManager;
      
      static std::string className();

      virtual ~DtSharedObjectSettings();

      virtual void removeSettings(const std::string& markingText);

      void setSettings(const std::string& markingText, ObjectSetting);
      ObjectSetting settingsFor(const std::string& markingText) const;

      virtual bool hasSetting(const std::string& markingText) const;

      void setFlagState(const std::string& markingText, ObjectSetting, bool onOff);

      bool flagState(const std::string&, ObjectSetting) const;

      virtual void write(boost::archive::xml_oarchive& ar, int version) const;
      virtual void read(boost::archive::xml_iarchive& ar, int version);

      const ObjectSettingsMap& settingsMap() const;

   protected:

      DtSharedObjectSettings(makVrv::DtSharedSettingsManager& manager);

   protected:
      ObjectSettingsMap mySettings;
   };

   class DT_DLL_VRFGUICORE DtObjectSettingsManager : public DtGuiSetting
   {
   public:
      struct ObjectSettingStruct
      {
         ObjectSettingStruct(ObjectSetting s, makVrv::DtUnicode n, std::set<makVrv::DtElementEntry::ElementType> e)
            : setting(s)
            , name(s)
            , validFor(e)
         {
         }

         ObjectSettingStruct()
            : setting((ObjectSetting)0)
            , validFor()
         {
            validFor.insert( makVrv::DtElementEntry::Unknown );
         }

         ObjectSettingStruct(const ObjectSettingStruct& s)
            : setting(s.setting)
            , name(s.name)
            , validFor(s.validFor)
         {
         }

         ObjectSettingStruct& operator=(const ObjectSettingStruct& s)
         {
            setting = s.setting;
            name = s.name;
            validFor = s.validFor;

            return *this;
         }

         ObjectSetting setting;
         makVrv::DtUnicode name;
         std::set<makVrv::DtElementEntry::ElementType> validFor;
      };

      typedef std::vector<ObjectSettingStruct> ObjectSettings;

   public:
      DtObjectSettingsManager(makVrv::DtDe&);
      virtual ~DtObjectSettingsManager();

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

      virtual void removeSettings(const std::string& markingText);

      virtual void removeAll();

      virtual void setSettings(const std::string& markingText, ObjectSetting);
      ObjectSetting settingsFor(const std::string& markingText) const;

      virtual DtObjectSettingsManager::ObjectSettingStruct addSetting(const makVrv::DtUnicode&, 
         ObjectSetting, std::set<makVrv::DtElementEntry::ElementType> validFor);
      virtual void removeSetting(ObjectSetting);
      ObjectSetting settingFor(const makVrv::DtUnicode&);
      makVrv::DtUnicode settingNameFor(ObjectSetting);

      bool flagState(const std::string& markingText, ObjectSetting) const;
      virtual void setFlagState(const std::string& markingText, ObjectSetting, bool onOff);
      const ObjectSettings& objectSettings() const;

      virtual void protect();

   protected:
      virtual void init();

      virtual void write(boost::archive::xml_oarchive& ar, int version) const;
      virtual void read(boost::archive::xml_iarchive& ar, int version);

      virtual void slot_onObjectAboutToBeRemoved(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>& s);

   protected:
      makVrv::DtDe& myDe;
      ObjectSettings myObjectSettings;
      makVrv::DtSignalConnectionManager myConnectionManager;

      typedef std::map<std::string, bool> ProtectedFromRemoval;
      ProtectedFromRemoval myProtectedFromRemoval;
   };

   class DT_DLL_VRFGUICORE DtSharedObjectSettingsSignaler : public makVrv::DtVirtualBaseClass
   {
   public:

      static DtSharedObjectSettingsSignaler& instance(const makVrv::DtSharedSettingsManager&);

      static DtSharedObjectSettingsSignaler& instance(makVrv::DtEventQueueInterface&);

      static DtSharedObjectSettingsSignaler* findInstance(
         makVrv::DtEventQueueInterface*);

      virtual ~DtSharedObjectSettingsSignaler();

      makVrv::event_signal<void (std::string, ObjectSetting)> signal_settingsChanged;

   protected:
      DtSharedObjectSettingsSignaler(makVrv::DtEventQueueInterface& eqi);

   private:
      DtSharedObjectSettingsSignaler(const DtSharedObjectSettingsSignaler&);
      DtSharedObjectSettingsSignaler& operator=(const DtSharedObjectSettingsSignaler&);
   };
}