IMaskWorkspace.h

#ifndef MANTID_API_IMASKWORKSPACE_H_
#define MANTID_API_IMASKWORKSPACE_H_

#include "MantidGeometry/IDTypes.h"

#include <boost/shared_ptr.hpp>
#include <memory>
#include <set>
#include <string>

namespace Mantid {
namespace API {

/** This class provides an interface to a MaskWorkspace.

  Copyright &copy; 2010 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
  National Laboratory & European Spallation Source

  This file is part of Mantid.

  Mantid is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 3 of the License, or
  (at your option) any later version.

  Mantid is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  File change history is stored at: <https://github.com/mantidproject/mantid>.
  Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport IMaskWorkspace {
public:
  IMaskWorkspace() = default;
  IMaskWorkspace &operator=(const IMaskWorkspace &) = delete;
  virtual ~IMaskWorkspace() = default;
  /// Return the workspace typeID
  virtual const std::string id() const { return "IMaskWorkspace"; }
  /// Total number of masked pixels
  virtual std::size_t getNumberMasked() const = 0;
  /// Check if a detector is masked
  virtual bool isMasked(const detid_t detectorID) const = 0;
  /// Check if all detectors in a set are masked
  virtual bool isMasked(const std::set<detid_t> &detectorIDs) const = 0;
  /// Set / remove mask of a detector
  virtual void setMasked(const detid_t detectorID, const bool mask = true) = 0;
  /// Set / remove masks of all detectors in a set
  virtual void setMasked(const std::set<detid_t> &detectorIDs,
                         const bool mask = true) = 0;
  /// Returns a clone of the workspace
  std::unique_ptr<IMaskWorkspace> clone() const {
    return std::unique_ptr<IMaskWorkspace>(doInterfaceClone());
  }

protected:
  /// Protected copy constructor. May be used by childs for cloning.
  IMaskWorkspace(const IMaskWorkspace &other) { (void)other; }

  /// returns a clone of the workspace as the interface
  virtual IMaskWorkspace *doInterfaceClone() const = 0;
};

/// shared pointer to the matrix workspace base class
using IMaskWorkspace_sptr = boost::shared_ptr<IMaskWorkspace>;
/// shared pointer to the matrix workspace base class (const version)
using IMaskWorkspace_const_sptr = boost::shared_ptr<const IMaskWorkspace>;
} // namespace API
} // namespace Mantid

#endif // MANTID_API_IMASKWORKSPACE_H_