DataItem.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//-----------------------------------------------------------------------------
// Includes
//-----------------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
#ifndef Q_MOC_RUN
#include <memory>
#endif
#include <string>
 
// Poco forward declarations
namespace Poco {
class RWLock;
}
 
// Forward declaration to allow Friend class.
namespace Mantid {
namespace API {
class Algorithm;
}
} // namespace Mantid
 
namespace Mantid {
namespace Kernel {
 
class MANTID_KERNEL_DLL DataItem {
public:
  DataItem();
  DataItem(const DataItem &other);
  virtual ~DataItem();
 
  virtual const std::string id() const = 0;
  virtual const std::string &getName() const = 0;
  virtual bool threadSafe() const = 0;
  virtual const std::string toString() const = 0;
 
  void readLock();
  void unlock();
 
protected:
  Poco::RWLock *getLock() const;
 
private:
  std::unique_ptr<Poco::RWLock> m_lock;
 
  friend class ReadLock;
  friend class WriteLock;
  friend class Mantid::API::Algorithm;
  /* WARNING: Do not add other friend classes unless you really know what
   * you are doing. Write locks are INTENTIONALLY restricted to
   * only the Algorithm base class.
   */
};
 
using DataItem_sptr = std::shared_ptr<DataItem>;
using DataItem_const_sptr = std::shared_ptr<const DataItem>;
 
} // namespace Kernel
} // namespace Mantid