Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Mantid::Geometry::HKLFilterAnd Class Referencefinal

Logical "And"-operation for HKLFilter. More...

#include <HKLFilter.h>

Inheritance diagram for Mantid::Geometry::HKLFilterAnd:
Mantid::Geometry::HKLFilterBinaryLogicOperation Mantid::Geometry::HKLFilter

Public Member Functions

std::string getDescription () const noexcept override
 Returns a description of the HKLFilterAnd. More...
 
 HKLFilterAnd (const HKLFilter_const_sptr &lhs, const HKLFilter_const_sptr &rhs)
 Constructor, calls base class constructor, throws exception if either of the operands is null. More...
 
bool isAllowed (const Kernel::V3D &hkl) const noexcept override
 Returns true if both wrapped filters return true. More...
 
- Public Member Functions inherited from Mantid::Geometry::HKLFilterBinaryLogicOperation
const HKLFilter_const_sptrgetLHS () const noexcept
 Returns the left-hand side operand of the operation. More...
 
const HKLFilter_const_sptrgetRHS () const noexcept
 Returns the right-hand side operand of the operation. More...
 
 HKLFilterBinaryLogicOperation (HKLFilter_const_sptr lhs, HKLFilter_const_sptr rhs)
 Stores the left-hand and right-hand side operators, throws exception if either is null. More...
 
- Public Member Functions inherited from Mantid::Geometry::HKLFilter
std::function< bool(const Kernel::V3D &)> fn () const noexcept
 Returns a function object that wraps HKLFilter::isAllowed. More...
 
virtual std::string getDescription () const =0
 
virtual bool isAllowed (const Kernel::V3D &hkl) const =0
 
virtual ~HKLFilter ()=default
 

Additional Inherited Members

- Protected Attributes inherited from Mantid::Geometry::HKLFilterBinaryLogicOperation
HKLFilter_const_sptr m_lhs
 
HKLFilter_const_sptr m_rhs
 

Detailed Description

Logical "And"-operation for HKLFilter.

Definition at line 119 of file HKLFilter.h.

Constructor & Destructor Documentation

◆ HKLFilterAnd()

Mantid::Geometry::HKLFilterAnd::HKLFilterAnd ( const HKLFilter_const_sptr lhs,
const HKLFilter_const_sptr rhs 
)
inline

Constructor, calls base class constructor, throws exception if either of the operands is null.

Definition at line 123 of file HKLFilter.h.

Member Function Documentation

◆ getDescription()

std::string Mantid::Geometry::HKLFilterAnd::getDescription ( ) const
overridevirtualnoexcept

◆ isAllowed()

bool Mantid::Geometry::HKLFilterAnd::isAllowed ( const Kernel::V3D hkl) const
overridevirtualnoexcept

Returns true if both wrapped filters return true.

Implements Mantid::Geometry::HKLFilter.

Definition at line 57 of file HKLFilter.cpp.


The documentation for this class was generated from the following files: