include/vrvCore/DtSettingsChangeManager.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2009 MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 
/****************************************************************************** 
** $RCSfile: DtSettingsChangeManager.h,v $ $Revision: 1.16 $ $State: Exp $ 
******************************************************************************/ 
 

#pragma once

#include <vrvCore/vrvCore.h> 
#include <vrvCore/DtSettings.h> 
#include <vrvUtil/DtVirtualBaseClass.h> 
#include <vrvUtil/event_signal.h>
#include <vrvUtil/DtLockedBufferedQueue.h>

#include <boost/thread/mutex.hpp>
#include <boost/signals.hpp>

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

namespace makVrv 
{ 
   class DtDe;
   class DtSharedSettingsManager;

   class DT_DLL_VRVCORE DtSettingsChangeObject
   {
   public:
      enum SettingsChangeType
      {
         SchemaRenamed = 1,
         SchemaParameterRenamed,
         ModelDefinitionRenamed,
         ElementDefinitionRenamed,
         SettingsChangedUserDefinedStart = 100000
      };

      enum UseType
      {
         ElementDefinition = 0,
         ModelDefinition,
         SchemaDefinition,
         UserDefined = 100000
      };

   public:
      DtSettingsChangeObject(SettingsChangeType type);

      virtual ~DtSettingsChangeObject();

      SettingsChangeType type() const
      {
         return myType;
      }

      boost::signal<void (DtSettingsChangeObject*)> signal_changeInvoked;

   protected:
      SettingsChangeType   myType;
   };

   class DT_DLL_VRVCORE DtSettingsChangeManager : public DtVirtualBaseClass
   { 
   public:
      typedef boost::function<bool (const std::string&, DtSettingsChangeObject::UseType)> DtSettingInUseFunction;
      typedef std::vector<DtSettingInUseFunction> DtSettingsInUse;
      typedef std::vector<DtSettingsChangeObject*> DtSettingsChangedList;

   public:
      static DtSettingsChangeManager& instance(DtDe& de);

      virtual ~DtSettingsChangeManager();

      virtual void addSettingsChangeObject(DtSettingsChangeObject*);

      virtual void removeSettingsChangeObject(DtSettingsChangeObject*);

      virtual DtSettingsChangedList changeObjectsFor(DtSettingsChangeObject::SettingsChangeType) const;

      static std::string className();

   public:
      virtual void addSettingInUseCheck(const DtSettingInUseFunction& f);

      virtual bool settingInUse(const std::string& setting, DtSettingsChangeObject::UseType) const;

   protected:
      virtual void settingsObjectInvoked(DtSettingsChangeObject*);

      DtSettingsChangeManager(DtDe&);

   protected:
      typedef std::map<DtSettingsChangeObject::SettingsChangeType, DtSettingsChangedList>   DtSettingsChangedMap;

      DtSettingsChangedMap    mySettings;
      DtSettingsInUse         mySettingsInUseChecks;
      DtDe&                   myDe;
      mutable boost::mutex    myMonitor;
   };

   class DT_DLL_VRVCORE DtSharedSettingsChangeManagerSignaler : 
      public DtVirtualBaseClass
   {
   public:

      static DtSharedSettingsChangeManagerSignaler& instance(const DtSharedSettingsManager&);

      static DtSharedSettingsChangeManagerSignaler& instance(DtEventQueueInterface&);

      static DtSharedSettingsChangeManagerSignaler* findInstance(
         DtEventQueueInterface*);

      virtual ~DtSharedSettingsChangeManagerSignaler();

      event_signal< void (DtSettingsChangeObject*)  > signal_changeInvoked;

   protected:
      DtSharedSettingsChangeManagerSignaler(DtEventQueueInterface& eqi);

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