caffa::RangeValidator< DataType > Class Template Reference

Simple range validator. More...

#include <cafRangeValidator.h>

Inheritance diagram for caffa::RangeValidator< DataType >:

Collaboration diagram for caffa::RangeValidator< DataType >:

Public Types
using	FailureSeverity = FieldValidatorInterface::FailureSeverity
Public Types inherited from caffa::FieldValidator< DataType >
using	FailureSeverity = FieldValidatorInterface::FailureSeverity
Public Types inherited from caffa::FieldValidatorInterface
enum	FailureSeverity { VALIDATOR_WARNING, VALIDATOR_ERROR, VALIDATOR_CRITICAL }
	The severity of failure. Essentially tells the application how to treat a validator failure: VALIDATOR_WARNING -> user warning VALIDATOR_ERROR -> user error VALIDATOR_CRITICAL -> critical application failure.

Public Member Functions
	RangeValidator (DataType minimum, DataType maximum, FailureSeverity failureSeverity=FailureSeverity::VALIDATOR_ERROR)
void	readFromString (const std::string &string) override
	Read the validator from string. More...
std::string	writeToString () const override
	Write the validator tostring. More...
std::pair< bool, std::string >	validate (const DataType &value) const override
	Validate the value. More...
Public Member Functions inherited from caffa::FieldValidator< DataType >
	FieldValidator (FailureSeverity failureSeverity=FailureSeverity::VALIDATOR_ERROR)
Public Member Functions inherited from caffa::FieldValidatorInterface
	FieldValidatorInterface (FailureSeverity failureSeverity)
	Construct a new Field Validator Interface object. More...
FailureSeverity	failureSeverity () const
	Get the severity of a failure of the validator. More...

Static Public Member Functions
static std::unique_ptr< RangeValidator< DataType > >	create (DataType minimum, DataType maximum, FailureSeverity failureSeverity=FailureSeverity::VALIDATOR_ERROR)

Detailed Description

template<typename DataType>
class caffa::RangeValidator< DataType >

Simple range validator.

Template Parameters

DataType

Member Function Documentation

readFromString()

template<typename DataType >

void caffa::RangeValidator< DataType >::readFromString ( const std::string &  string )

inlineoverridevirtual

Read the validator from string.

Parameters

string

the string to read from

Implements caffa::FieldValidatorInterface.

validate()

template<typename DataType >

std::pair<bool, std::string> caffa::RangeValidator< DataType >::validate ( const DataType &  value ) const

inlineoverridevirtual

Validate the value.

Parameters

value

The value to validate

Returns

true if the value is acceptable

false if not

Implements caffa::FieldValidator< DataType >.

writeToString()

template<typename DataType >

std::string caffa::RangeValidator< DataType >::writeToString ( ) const

inlineoverridevirtual

Write the validator tostring.

Returns

a string containing the validator info

Implements caffa::FieldValidatorInterface.

---

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

• Core/cafRangeValidator.h