Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Mantid::Kernel::RebinParamsValidator Class Reference

Validator to check the format of a vector providing the rebin parameters to an algorithm. More...

#include <RebinParamsValidator.h>

Inheritance diagram for Mantid::Kernel::RebinParamsValidator:

Public Member Functions

IValidator_sptr clone () const override
 
 RebinParamsValidator (bool allowEmpty=false, bool allowRange=false)
 

Private Member Functions

std::string checkValidity (const std::vector< double > &value) const override
 Check on the inputed bin boundaries and widths. More...
 

Private Attributes

bool m_allowEmpty
 
bool m_allowRange
 

Detailed Description

Validator to check the format of a vector providing the rebin parameters to an algorithm.

Author
Russell Taylor, Tessella plc

Definition at line 19 of file RebinParamsValidator.h.

Constructor & Destructor Documentation

◆ RebinParamsValidator()

Mantid::Kernel::RebinParamsValidator::RebinParamsValidator ( bool  allowEmpty = false,
bool  allowRange = false 
)

Definition at line 11 of file RebinParamsValidator.cpp.

Member Function Documentation

◆ checkValidity()

std::string Mantid::Kernel::RebinParamsValidator::checkValidity ( const std::vector< double > &  value) const
overrideprivate

Check on the inputed bin boundaries and widths.

Parameters
value:: The parameter array to check
Returns
A user level description of any problem or "" if there is no problem

Definition at line 20 of file RebinParamsValidator.cpp.

References m_allowEmpty, m_allowRange, and value.

◆ clone()

IValidator_sptr Mantid::Kernel::RebinParamsValidator::clone ( ) const
override

Definition at line 14 of file RebinParamsValidator.cpp.

Member Data Documentation

◆ m_allowEmpty

bool Mantid::Kernel::RebinParamsValidator::m_allowEmpty
private

Definition at line 26 of file RebinParamsValidator.h.

Referenced by checkValidity().

◆ m_allowRange

bool Mantid::Kernel::RebinParamsValidator::m_allowRange
private

Definition at line 27 of file RebinParamsValidator.h.

Referenced by checkValidity().


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