Mantid
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | List of all members
Mantid::API::IncreasingAxisValidator Class Reference

A validator which checks that the X axis of a workspace is increasing from left to right. More...

#include <IncreasingAxisValidator.h>

Inheritance diagram for Mantid::API::IncreasingAxisValidator:
Mantid::API::MatrixWorkspaceValidator

Public Member Functions

Kernel::IValidator_sptr clone () const override
 Clone the current state. More...
 
std::string getType () const
 Get the type of the validator. More...
 

Private Member Functions

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

Detailed Description

A validator which checks that the X axis of a workspace is increasing from left to right.

Definition at line 18 of file IncreasingAxisValidator.h.

Member Function Documentation

◆ checkValidity()

std::string Mantid::API::IncreasingAxisValidator::checkValidity ( const MatrixWorkspace_sptr value) const
overrideprivate

Check for validity.

Checks that X axis is in the right direction.

Parameters
valueThe workspace to check
Returns
"" if is valid, otherwise a user level description of a problem

Definition at line 24 of file IncreasingAxisValidator.cpp.

References value.

◆ clone()

Kernel::IValidator_sptr Mantid::API::IncreasingAxisValidator::clone ( ) const
override

Clone the current state.

Definition at line 14 of file IncreasingAxisValidator.cpp.

◆ getType()

std::string Mantid::API::IncreasingAxisValidator::getType ( ) const
inline

Get the type of the validator.

Definition at line 21 of file IncreasingAxisValidator.h.


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