IMaskWorkspace.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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
 
#include "MantidAPI/DllConfig.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidKernel/PropertyWithValue.h"
 
#include <memory>
#include <set>
#include <string>
#include <vector>
 
namespace Mantid {
namespace API {
 
// Reference Docs
// Concepts: TODO
// API: TODO
 
class MANTID_API_DLL IMaskWorkspace {
public:
  IMaskWorkspace() = default;
  IMaskWorkspace &operator=(const IMaskWorkspace &) = delete;
  virtual ~IMaskWorkspace() = default;
  virtual const std::string id() const { return "IMaskWorkspace"; }
  virtual std::size_t getNumberMasked() const = 0;
  virtual bool containsDetID(const detid_t detectorID) const = 0;
  virtual bool containsDetIDs(const std::set<detid_t> &detectorIDs) const = 0;
  virtual bool containsDetIDs(const std::vector<detid_t> &detectorIDs) const = 0;
  virtual bool isMasked(const detid_t detectorID) const = 0;
  virtual bool isMasked(const std::set<detid_t> &detectorIDs) const = 0;
  virtual void setMasked(const detid_t detectorID, const bool mask = true) = 0;
  virtual void setMasked(const std::set<detid_t> &detectorIDs, const bool mask = true) = 0;
  std::unique_ptr<IMaskWorkspace> clone() const { return std::unique_ptr<IMaskWorkspace>(doInterfaceClone()); }
 
protected:
  IMaskWorkspace(const IMaskWorkspace &other) { (void)other; }
 
  virtual IMaskWorkspace *doInterfaceClone() const = 0;
};
 
using IMaskWorkspace_sptr = std::shared_ptr<IMaskWorkspace>;
using IMaskWorkspace_const_sptr = std::shared_ptr<const IMaskWorkspace>;
} // namespace API
} // namespace Mantid
 
// Instantiated and exported by API/src/PropertyWithValue.cpp
MANTID_API_EXTERN_TEMPLATE(Mantid::Kernel::PropertyWithValue<std::shared_ptr<Mantid::API::IMaskWorkspace>>);