include/vrvCore/DtSettingsBackupManager.h

Go to the documentation of this file.

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

#include <vrvCore/vrvCore.h> 
#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvCore/DtSettingsBackup.h>
#include <vrvUtil/DtLockedBufferedQueue.h>

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

#include <string>

namespace makVrv 
{
   class DtDe;

   class DT_DLL_VRVCORE DtSettingsBackupManager : public DtVirtualBaseClass 
   { 
   public:
      static DtSettingsBackupManager& instance(DtDe& de);

      virtual ~DtSettingsBackupManager();

      virtual void setBackupsPath(const std::string&);
      const std::string& backupsPath() const
      {
         return myBackupsPath;
      }

   public:
      virtual void registerSettingsBackup(
         DtSettingsBackup* backup);

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

      virtual void unregisterSettingsBackup(DtSettingsBackup* backup);

      virtual void settingsObjectDestroyed(const DtSettingsBackup*);
      virtual void settingsClearedBackup(const DtSettingsBackup*);
      virtual void settingsRestored(const DtSettingsBackup*);
      virtual void settingsBackedUp(const DtSettingsBackup*);

      virtual bool setFactoryFile(const std::string&, const std::string& factoryFile);

      virtual bool setFactoryFile(const DtSettingsBackup*, const std::string& factoryFile);

      virtual bool canBeRevertedFromStartup(const std::string&) const;

      virtual bool canBeRevertedFromStartup(const DtSettingsBackup*) const;

      virtual bool canBeRestoredFromFactory(const std::string&) const;

      virtual bool canBeRestoredFromFactory(const DtSettingsBackup*) const;

      virtual bool backup(const std::string&);

      virtual bool backup(const DtSettingsBackup*);

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

      virtual void clearBackup(const DtSettingsBackup*);

      virtual bool revertToStartup(const std::string&);

      virtual bool revertToStartup(const DtSettingsBackup*);

      virtual bool restoreFromFactory(const std::string&);

      virtual bool restoreFromFactory(const DtSettingsBackup*);

      virtual bool registered(const std::string&) const;

      virtual bool registered(const DtSettingsBackup*) const;

      virtual void restoreWhenRestored(const std::string& toRestore, const std::string& whenRestored, 
         const DtSettingsBackup::RestoreFlags& f = DtSettingsBackup::RestoreAll);

      virtual void restoreWhenRestored(const DtSettingsBackup* toRestore, const DtSettingsBackup* whenRestored,
         const DtSettingsBackup::RestoreFlags& f = DtSettingsBackup::RestoreAll);

      virtual void cancelRestoreWhenRestored(const std::string& toRestore, const std::string& whenRestored,
         const DtSettingsBackup::RestoreFlags& f = DtSettingsBackup::RestoreAll);

      virtual void cancelRestoreWhenRestored(const DtSettingsBackup* toRestore, const DtSettingsBackup* whenRestored,
         const DtSettingsBackup::RestoreFlags& f = DtSettingsBackup::RestoreAll);

      virtual std::vector<std::string> willRestoreWhenRestored(const DtSettingsBackup* toRestore,
         const DtSettingsBackup::RestoreFlags& f = DtSettingsBackup::RestoreAll) const;

   protected:
      void willRestoreWhenRestored(const std::string& toRestore,
         std::vector<std::string>& willRestore, const DtSettingsBackup::RestoreFlags& f = DtSettingsBackup::RestoreAll) const;

   protected:
      DtSettingsBackupManager(DtDe& de);

   protected:
      DtDe&                                           myDe;
      typedef std::map<std::string, DtSettingsBackup*> DtSettingsBackupMap;
      DtSettingsBackupMap                             myBackups;        
      std::string                                     myBackupsPath;
      mutable boost::mutex                            myMonitor;
   }; 
}