Checks that a string contains a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm) More...

#include <DateTimeValidator.h>

Inheritance diagram for Mantid::Kernel::DateTimeValidator:

Public Member Functions
void	allowEmpty (const bool &)
	Sets the value of the m_allowEmpty variable.

IValidator_sptr	clone () const override
	Clone the current state.

	DateTimeValidator (bool allowEmpty=false)

Private Member Functions
std::string	checkValidity (const std::string &value) const override
	Checks the value is valid.

Private Attributes
bool	m_allowedEmpty
	Allows for an empty string to be accepted as input.

Detailed Description

Checks that a string contains a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)

Definition at line 20 of file DateTimeValidator.h.

Constructor & Destructor Documentation

◆ DateTimeValidator()

Mantid::Kernel::DateTimeValidator::DateTimeValidator ( bool allowEmpty = false )

Definition at line 21 of file DateTimeValidator.cpp.

References allowEmpty(), and m_allowedEmpty.

Member Function Documentation

◆ allowEmpty()

void Mantid::Kernel::DateTimeValidator::allowEmpty ( const bool & allow )

Sets the value of the m_allowEmpty variable.

Parameters

allow The new value of m_allowEmpty

Definition at line 27 of file DateTimeValidator.cpp.

References m_allowedEmpty.

Referenced by DateTimeValidator().

◆ checkValidity()

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

overrideprivate

Checks the value is valid.

Parameters

value A string to check for an ISO formatted timestamp

Returns: An empty string if the value is valid or an string containing a description of the error otherwise

Definition at line 34 of file DateTimeValidator.cpp.

References error, m_allowedEmpty, UNUSED_ARG, and value.

◆ clone()

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

override

Clone the current state.

Returns: A clone of the current state of the validator

Definition at line 19 of file DateTimeValidator.cpp.

Member Data Documentation

◆ m_allowedEmpty

bool Mantid::Kernel::DateTimeValidator::m_allowedEmpty

private

Allows for an empty string to be accepted as input.

Definition at line 34 of file DateTimeValidator.h.

Referenced by allowEmpty(), checkValidity(), and DateTimeValidator().

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

Framework/Kernel/inc/MantidKernel/DateTimeValidator.h
Framework/Kernel/src/DateTimeValidator.cpp

Public Member Functions

Private Member Functions

Private Attributes