Mantid::Kernel::StartsWithValidator Class Reference

StartsWithValidator is a validator that requires the value of a property to start with one of the strings in a defined list of possibilities. More...

#include <StartsWithValidator.h>

Inheritance diagram for Mantid::Kernel::StartsWithValidator:

Public Member Functions
IValidator_sptr	clone () const override
	Clone the validator.
	StartsWithValidator ()=default
template<std::size_t SIZE>
	StartsWithValidator (const std::array< std::string, SIZE > &values)
	Constructor.
	StartsWithValidator (const std::set< std::string > &values)
	Constructor.
	StartsWithValidator (const std::vector< std::string > &values)
	Constructor.
Public Member Functions inherited from Mantid::Kernel::ListValidator< TYPE >
void	addAllowedValue (const TYPE &value)
	Add value to the list of allowable values if it's not already there.
std::vector< std::string >	allowedValues () const override
	Returns the set of allowed values currently defined.
IValidator_sptr	clone () const override
	Clone the validator.
std::string	getValueForAlias (const std::string &alias) const override
	Return an allowed value (as a string) given an alias.
bool	isMultipleSelectionAllowed () override
	ListValidator ()
	Default constructor. Sets up an empty list of valid values.
template<typename T >
	ListValidator (const T &values, const std::map< std::string, std::string > &aliases=std::map< std::string, std::string >(), const bool allowMultiSelection=false)
	Constructor.
void	setMultipleSelectionAllowed (const bool isMultiSelectionAllowed)

Protected Member Functions
std::string	checkValidity (const std::string &value) const override
	Checks if the string passed starts with one from the list.
Protected Member Functions inherited from Mantid::Kernel::ListValidator< TYPE >
std::string	checkValidity (const std::string &value) const
std::string	checkValidity (const TYPE &value) const override
	Checks if the string passed is in the list.
bool	isAlias (const std::string &value) const
	Test if a value is an alias of an alowed value.
template<typename T >
bool	isAlias (const T &value) const
	Test if a value is an alias of an alowed value.
bool	isEmpty (const std::string &value) const
	Is the value considered empty.
template<typename T >
bool	isEmpty (const T &value) const
	Is the value considered empty.

Additional Inherited Members
Protected Attributes inherited from Mantid::Kernel::ListValidator< TYPE >
std::map< std::string, std::string >	m_aliases
	The optional aliases for the allowed values.
std::vector< TYPE >	m_allowedValues
	The set of valid values.
bool	m_allowMultiSelection
	if the validator should allow multiple selection

Detailed Description

StartsWithValidator is a validator that requires the value of a property to start with one of the strings in a defined list of possibilities.

Definition at line 22 of file StartsWithValidator.h.

Constructor & Destructor Documentation

StartsWithValidator() [1/4]

Mantid::Kernel::StartsWithValidator::StartsWithValidator ( )

default

StartsWithValidator() [2/4]

Mantid::Kernel::StartsWithValidator::StartsWithValidator

(

const std::vector< std::string > &

values

)

Constructor.

Parameters

values

:: A vector with the allowed values.

Definition at line 18 of file StartsWithValidator.cpp.

StartsWithValidator() [3/4]

Mantid::Kernel::StartsWithValidator::StartsWithValidator

(

const std::set< std::string > &

values

)

Constructor.

Parameters

values

:: A set with the allowed values.

Definition at line 24 of file StartsWithValidator.cpp.

StartsWithValidator() [4/4]

template<std::size_t SIZE>

Mantid::Kernel::StartsWithValidator::StartsWithValidator ( const std::array< std::string, SIZE > &  values )

inline

Constructor.

Parameters

values

:: An array with the allowed values

Definition at line 34 of file StartsWithValidator.h.

Member Function Documentation

checkValidity()

std::string Mantid::Kernel::StartsWithValidator::checkValidity ( const std::string &  value ) const

overrideprotected

Checks if the string passed starts with one from the list.

Parameters

value

:: The value to test

Returns

"" if the value is on the list, or "The value does not start with any of the allowed values"

Definition at line 34 of file StartsWithValidator.cpp.

References Mantid::Kernel::ListValidator< TYPE >::isEmpty(), Mantid::Kernel::ListValidator< TYPE >::m_allowedValues, and value.

clone()

IValidator_sptr Mantid::Kernel::StartsWithValidator::clone ( ) const

override

Clone the validator.

Definition at line 27 of file StartsWithValidator.cpp.

---

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

• Framework/Kernel/inc/MantidKernel/StartsWithValidator.h
• Framework/Kernel/src/StartsWithValidator.cpp