include/vrvCore/DtReadSettingsLock.h

Go to the documentation of this file.

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


#ifndef DtReadSettingsLock_H_
#define DtReadSettingsLock_H_

#include <vrvCore/vrvCore.h>
#include <vrvCore/DtSharedSettingsManager.h>

#include <boost/thread/shared_mutex.hpp>
#include <boost/thread/locks.hpp>

namespace makVrv
{
   class DtSharedSettingsManager;

   template <typename SettingsClass>
   class DtReadSettingsLock
   {
   public:

      //Acquired an instance of the SettingsClass with a read lock.
      DtReadSettingsLock(DtSharedSettingsManager& manager);

      //release the lock on the object.
      ~DtReadSettingsLock();

      //Access the instance using pointer notation.
      inline const SettingsClass* operator->() { return myObject; }
      inline const SettingsClass* operator->() const { return myObject; }

      //Access the instance using deref notation.
      inline const SettingsClass& operator*() { return *myObject; }
      inline const SettingsClass& operator*() const { return *myObject; }

   private:
      //Not copyable or assignable.
      DtReadSettingsLock(const DtReadSettingsLock&);
      DtReadSettingsLock& operator=(const DtReadSettingsLock&);

   private:
      DtSharedSettingsManager& myManager;
      SettingsClass* myObject;

      boost::shared_lock<boost::shared_mutex> myManagerLock;
      boost::shared_lock<boost::shared_mutex> myObjectLock;
   };
}

#define DtReadSettingsLock_INL_
#include <vrvCore/DtReadSettingsLock.inl>
#undef DtReadSettingsLock_INL_

#endif