HKLFilter.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2015 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 "MantidGeometry/DllConfig.h"
#include "MantidKernel/V3D.h"
 
#include <functional>
#include <memory>
 
namespace Mantid {
namespace Geometry {
 
class MANTID_GEOMETRY_DLL HKLFilter {
public:
  virtual ~HKLFilter() = default;
 
  std::function<bool(const Kernel::V3D &)> fn() const noexcept;
 
  virtual std::string getDescription() const = 0;
  virtual bool isAllowed(const Kernel::V3D &hkl) const = 0;
};
 
using HKLFilter_uptr = std::unique_ptr<HKLFilter>;
using HKLFilter_const_sptr = std::shared_ptr<const HKLFilter>;
using HKLFilter_sptr = std::shared_ptr<HKLFilter>;
 
class MANTID_GEOMETRY_DLL HKLFilterUnaryLogicOperation : public HKLFilter {
public:
  HKLFilterUnaryLogicOperation(HKLFilter_const_sptr filter);
 
  const HKLFilter_const_sptr &getOperand() const noexcept { return m_operand; }
 
protected:
  HKLFilter_const_sptr m_operand;
};
 
class MANTID_GEOMETRY_DLL HKLFilterNot final : public HKLFilterUnaryLogicOperation {
public:
  HKLFilterNot(const HKLFilter_const_sptr &filter) : HKLFilterUnaryLogicOperation(filter) {}
 
  std::string getDescription() const noexcept override;
  bool isAllowed(const Kernel::V3D &hkl) const noexcept override;
};
 
class MANTID_GEOMETRY_DLL HKLFilterBinaryLogicOperation : public HKLFilter {
public:
  HKLFilterBinaryLogicOperation(HKLFilter_const_sptr lhs, HKLFilter_const_sptr rhs);
 
  const HKLFilter_const_sptr &getLHS() const noexcept { return m_lhs; }
 
  const HKLFilter_const_sptr &getRHS() const noexcept { return m_rhs; }
 
protected:
  HKLFilter_const_sptr m_lhs;
  HKLFilter_const_sptr m_rhs;
};
 
class MANTID_GEOMETRY_DLL HKLFilterAnd final : public HKLFilterBinaryLogicOperation {
public:
  HKLFilterAnd(const HKLFilter_const_sptr &lhs, const HKLFilter_const_sptr &rhs)
      : HKLFilterBinaryLogicOperation(lhs, rhs) {}
 
  std::string getDescription() const noexcept override;
  bool isAllowed(const Kernel::V3D &hkl) const noexcept override;
};
 
class MANTID_GEOMETRY_DLL HKLFilterOr final : public HKLFilterBinaryLogicOperation {
public:
  HKLFilterOr(const HKLFilter_const_sptr &lhs, const HKLFilter_const_sptr &rhs)
      : HKLFilterBinaryLogicOperation(lhs, rhs) {}
 
  std::string getDescription() const noexcept override;
  bool isAllowed(const Kernel::V3D &hkl) const noexcept override;
};
 
MANTID_GEOMETRY_DLL const HKLFilter_const_sptr operator~(const HKLFilter_const_sptr &filter);
 
MANTID_GEOMETRY_DLL const HKLFilter_const_sptr operator&(const HKLFilter_const_sptr &lhs,
                                                         const HKLFilter_const_sptr &rhs);
 
MANTID_GEOMETRY_DLL const HKLFilter_const_sptr operator|(const HKLFilter_const_sptr &lhs,
                                                         const HKLFilter_const_sptr &rhs);
 
} // namespace Geometry
} // namespace Mantid