EqualBinSizesValidator : Checks that all bins in a workspace are equally sized to within a given tolerance. More...

#include <EqualBinSizesValidator.h>

Inheritance diagram for Mantid::API::EqualBinSizesValidator:

Public Member Functions
Kernel::IValidator_sptr	clone () const override
	Clone the current state. More...

	EqualBinSizesValidator (const double errorLevel)
	Constructor: sets properties. More...

std::string	getType () const
	Gets the type of the validator. More...

Private Member Functions
std::string	checkValidity (const MatrixWorkspace_sptr &value) const override
	Check for validity. More...

Private Attributes
const double	m_errorLevel
	Error threshold. More...

Detailed Description

EqualBinSizesValidator : Checks that all bins in a workspace are equally sized to within a given tolerance.

Definition at line 18 of file EqualBinSizesValidator.h.

Constructor & Destructor Documentation

◆ EqualBinSizesValidator()

Mantid::API::EqualBinSizesValidator::EqualBinSizesValidator ( const double errorLevel )

Constructor: sets properties.

Constructor - sets properties.

Definition at line 16 of file EqualBinSizesValidator.cpp.

Member Function Documentation

◆ checkValidity()

std::string Mantid::API::EqualBinSizesValidator::checkValidity ( const MatrixWorkspace_sptr & value ) const

overrideprivate

Check for validity.

Checks that the bin sizes of each histogram in the workspace are the same.

Parameters

value :: [input] The workspace to test

Returns: :: An error message (empty if no error)

Definition at line 27 of file EqualBinSizesValidator.cpp.

References m_errorLevel, Mantid::Kernel::EqualBinsChecker::validate(), and value.

◆ clone()

Kernel::IValidator_sptr Mantid::API::EqualBinSizesValidator::clone ( ) const

override

Clone the current state.

Definition at line 19 of file EqualBinSizesValidator.cpp.

◆ getType()

std::string Mantid::API::EqualBinSizesValidator::getType ( ) const

inline

Gets the type of the validator.

Definition at line 23 of file EqualBinSizesValidator.h.

Member Data Documentation

◆ m_errorLevel

const double Mantid::API::EqualBinSizesValidator::m_errorLevel

private

Error threshold.

Definition at line 31 of file EqualBinSizesValidator.h.

Referenced by checkValidity().

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

Framework/API/inc/MantidAPI/EqualBinSizesValidator.h
Framework/API/src/EqualBinSizesValidator.cpp

Public Member Functions

Private Member Functions

Private Attributes