Mantid::Kernel::MandatoryValidator< TYPE > Class Template Reference

Validator to check that a property is not left empty. More...

#include <Kernel/MandatoryValidator.h>

Inheritance diagram for Mantid::Kernel::MandatoryValidator< TYPE >:

Public Member Functions
IValidator_sptr	clone () const override

Private Member Functions
std::string	checkValidity (const TYPE &value) const override
	Check if a value has been provided. More...

Detailed Description

template<typename TYPE>
class Mantid::Kernel::MandatoryValidator< TYPE >

Validator to check that a property is not left empty.

MandatoryValidator is a validator that requires a string to be set to a non-blank value or a vector (i.e. ArrayProperty) is not empty.

Author

Nick Draper, Tessella Support Services plc

Date

28/11/2007

Definition at line 43 of file MandatoryValidator.h.

Member Function Documentation

checkValidity()

template<typename TYPE >

std::string Mantid::Kernel::MandatoryValidator< TYPE >::checkValidity ( const TYPE &  value ) const

inlineoverrideprivate

Check if a value has been provided.

Parameters

value

:: the string to test

Returns

"A value must be entered for this parameter" if empty or ""

Definition at line 53 of file MandatoryValidator.h.

References value.

clone()

template<typename TYPE >

IValidator_sptr Mantid::Kernel::MandatoryValidator< TYPE >::clone ( ) const

inlineoverride

Definition at line 45 of file MandatoryValidator.h.

---

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

• Framework/Kernel/inc/MantidKernel/MandatoryValidator.h