#include <IntervalDuration.hpp>

Inheritance diagram for usmtf::IntervalDuration:

[legend]

Collaboration diagram for usmtf::IntervalDuration:

[legend]

Public Member Functions
	IntervalDuration ()=default
bool	ParseAndValidate (const Field &aField) override
const std::string &	GetIntervalDuration () const noexcept
const std::string &	GetContextQuantity () const noexcept
const std::string &	GetUOM () const noexcept
Public Member Functions inherited from usmtf::TimePoint
	TimePoint (bool aTimeQualifersAllowed=false) noexcept
bool	ParseAndValidate (const Field &aField) override
const std::string &	GetDay () const noexcept
const std::string &	GetMonth () const noexcept
const std::string &	GetYear () const noexcept
const std::string &	GetTimeZone () const noexcept
const std::string &	GetMinute () const noexcept
const std::string &	GetHour () const noexcept
const std::string &	GetStopTimeQualifier () const noexcept
Public Member Functions inherited from usmtf::FFIRN_Validator
	FFIRN_Validator ()=default
const std::string &	GetRawContent () const noexcept
	Return the content of the field as it was in the USMTF set.
std::vector< std::string >	SplitOnDelimeter (const std::string &value, const std::string &delimeter)
	Values separated by delimeter.
const std::string &	GetFieldContent () const noexcept
Public Member Functions inherited from usmtf::Validatable
bool	IsValid () const noexcept
Public Member Functions inherited from usmtf::ErrorManager
virtual	~ErrorManager ()=default
bool	HasErrors () const noexcept
void	LogErrors (std::ostream &aOut) const noexcept
const std::vector< ValidationError > &	GetErrors () const

Protected Member Functions
bool	IsValidIntervalDuration () noexcept
bool	IsValidUnitOfTimeMeasurement (const std::string &aValue) noexcept
bool	IsUntilFurtherNotice () noexcept
Protected Member Functions inherited from usmtf::TimePoint
bool	IsValidStopTimeQualifier () noexcept
bool	IsValidDateTimeGroup () noexcept
bool	IsValidDayTimeMonth () noexcept
bool	IsValidDayTime () noexcept
bool	IsValidDay (const std::string &aDay) noexcept
bool	IsValidHour (const std::string &aHour) noexcept
bool	IsValidMinuteOrSecond (const std::string &aUnit) noexcept
bool	IsValidTimeZone (const std::string &aTimeZone) noexcept
bool	IsValidMonthName (const std::string &aMonth) noexcept
bool	IsValidYear (const std::string &aYear) noexcept
bool	ValidateDayTime (const std::string &aDayTime) noexcept
Protected Member Functions inherited from usmtf::FFIRN_Validator
bool	ValidateByDescriptor (const FFIRN_DescriptorMap &aDescriptorMap)
	Speed up validation if descriptor is present. Runs all functions if it isn't.
void	ClearErrorsIfValid (bool aHasAtLeastOnePassed) noexcept
void	SetField (const Field &aField) noexcept
	Field Setter for internal use only.
Protected Member Functions inherited from usmtf::ErrorManager
void	AddError (const ValidationError &aError) noexcept
void	AddError (const std::string &aFailureReason, const std::string &aValueValidatied, const std::string &aOptionalSuggestion="") noexcept
void	AddError (const std::string &aErrorMessage) noexcept
void	AddErrors (const std::vector< ValidationError > &aErrors) noexcept
void	ClearErrors () noexcept

Protected Attributes
std::string	mContextQuantity
std::string	mUOM
std::string	mIntervalDuration
Protected Attributes inherited from usmtf::TimePoint
bool	mTimeQualifersAllowed
std::string	mStopTimeQualifier
std::string	mDay
std::string	mHour
std::string	mMinute
std::string	mTimeZone
std::string	mMonth
std::string	mYear
Protected Attributes inherited from usmtf::FFIRN_Validator
Field	mField

Additional Inherited Members
Public Types inherited from usmtf::FFIRN_Validator
using	FFIRN_Func = std::function<bool(void)>
using	FFIRN_DescriptorMap = std::unordered_map<std::string, FFIRN_Func>
Static Public Member Functions inherited from usmtf::FFIRN_Validator
static bool	IsInSelection (const std::string &aValue, const std::vector< std::string > &choices) noexcept
static bool	IsStringLength (const std::string &aValue, size_t aLength) noexcept
static size_t	CheckForAnyDelimeter (const std::string &aValue, const std::vector< std::string > &aDelimeters) noexcept
	Returns the positions of a specified delimiter if present, npos if not.
static size_t	CheckForAnyDelimeter (const std::string &aValue, const std::vector< std::string > &aDelimeters, std::string &aFoundDelimeter) noexcept
template<class T>
static bool	IsInRange (T aValue, T aLowerBound, T aUpperBound) noexcept

Detailed Description

FFIRN_Validator responsible for the validation and property extraction of an IntervalDuration. An IntervalDuration is a field that indicates an interval time frames duration. It comes in several forms.

USMTF Excerpt: A. INTERVAL DURATION

EXPRESSED AS FOLLOWS: CONTEXT QUANTITY, 1-999 ALLOWABLE ENTRIES: (1 THROUGH 999).

UNIT OF TIME MEASUREMENT, DAY/WK/BIWK/MON/YR EXAMPLE: /4WK

B. TIME QUALIFIER, UNTIL FURTHER NOTICE ALLOWABLE ENTRIES: UFN. EXAMPLE: /UFN

C. ENDING DATE-TIME GROUP EXAMPLE: /141325ZFEB1997

Constructor & Destructor Documentation

◆ IntervalDuration()

usmtf::IntervalDuration::IntervalDuration ( )

default

References GetContextQuantity(), GetIntervalDuration(), GetUOM(), IsUntilFurtherNotice(), IsValidIntervalDuration(), IsValidUnitOfTimeMeasurement(), and ParseAndValidate().

Member Function Documentation

◆ GetContextQuantity()

const std::string & usmtf::IntervalDuration::GetContextQuantity ( ) const

noexcept

References mContextQuantity.

Referenced by IntervalDuration().

◆ GetIntervalDuration()

const std::string & usmtf::IntervalDuration::GetIntervalDuration ( ) const

noexcept

References mIntervalDuration.

Referenced by IntervalDuration().

◆ GetUOM()

const std::string & usmtf::IntervalDuration::GetUOM ( ) const

noexcept

References mUOM.

Referenced by IntervalDuration().

◆ IsUntilFurtherNotice()

bool usmtf::IntervalDuration::IsUntilFurtherNotice ( )

protectednoexcept

References usmtf::ErrorManager::AddError(), usmtf::FFIRN_Validator::mField, and mIntervalDuration.

Referenced by IntervalDuration(), and ParseAndValidate().

◆ IsValidIntervalDuration()

bool usmtf::IntervalDuration::IsValidIntervalDuration ( )

protectednoexcept

References usmtf::ErrorManager::AddError(), usmtf::FFIRN_Validator::CheckForAnyDelimeter(), usmtf::FFIRN_Validator::IsInRange(), IsValidUnitOfTimeMeasurement(), mContextQuantity, usmtf::FFIRN_Validator::mField, mIntervalDuration, and mUOM.

Referenced by IntervalDuration(), and ParseAndValidate().

◆ IsValidUnitOfTimeMeasurement()

bool usmtf::IntervalDuration::IsValidUnitOfTimeMeasurement ( const std::string & aValue )

protectednoexcept

References usmtf::ErrorManager::AddError(), and usmtf::FFIRN_Validator::IsInSelection().

Referenced by IntervalDuration(), and IsValidIntervalDuration().

◆ ParseAndValidate()

bool usmtf::IntervalDuration::ParseAndValidate ( const Field & aField )

overridevirtual

I am not a huge fan of violating command query separation. But, in this case it makes sense. The functions that come into ParseAndValidate have to parse to get value of the component, sometimes there are many components in a single field. Unfortunately parsing is an intertwined attribute of validation. You cant parse according to some rule set if the field is invalid, making it impossible to separate the two notions easily. I have opted to instead name the functions for what they are actually doing. Parsing components and validating them as well. Optionally members can be set within the function as well.

Implements usmtf::FFIRN_Validator.

References usmtf::FFIRN_Validator::ClearErrorsIfValid(), IsUntilFurtherNotice(), usmtf::TimePoint::IsValidDateTimeGroup(), IsValidIntervalDuration(), and usmtf::FFIRN_Validator::SetField().

Referenced by IntervalDuration().