#include <Frequency.hpp>

Inheritance diagram for usmtf::Frequency:

[legend]

Collaboration diagram for usmtf::Frequency:

[legend]

Public Member Functions
	Frequency ()
bool	ParseAndValidate (const Field &aField) override
float	GetNumericalFrequency () const noexcept
const std::string &	GetFrequency () const noexcept
Public Member Functions inherited from usmtf::RangeValidator< float >
bool	ParseAndValidate (const usmtf::Field &aField) override
void	SetValidRange (float aLowerBound, float aUpperBound)
float	GetCastedValue () 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 Attributes
std::string	mFrequency
Protected Attributes inherited from usmtf::RangeValidator< float >
float	mCastedRangeValue
float	mLowerBound
float	mUpperBound
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
Protected Member Functions inherited from usmtf::RangeValidator< float >
bool	IsInvalidRange (float aValue) 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

Detailed Description

FFIRN_Validator responsible for the validation and property extraction of Frequency. USMTF Excerpt:

A. PRIMARY FREQUENCY IN MEGAHERTZ

ALLOWABLE ENTRIES: (.0000001 THROUGH 99999999) [0 TO 7 DECIMAL PLACES]. DATA ITEM AND DATA CODE VALUES CONSIST OF THE INTEGERS 1 THROUGH 99999999, AND DECIMAL POINT VALUES. DECIMAL POINT VALUES RANGE FROM .0000001 TO 999999.9, CONSISTING OF ALL POSSIBLE COMBINATIONS OF SEVEN OR FEWER SIGNIFICANT DIGITS AND A SIGNIFICANT DECIMAL POINT.

B. PRIMARY FREQUENCY DESIGNATOR ALLOWABLE ENTRIES: [LITERAL]. THE DESIGNATORS ARE ASSIGNED BY OPERATIONS ORDERS, HANDBOOKS, ETC.

/EXAMPLE: /PFREQ:342.5 EXAMPLE: /PDESIG:TAD01

Constructor & Destructor Documentation

◆ Frequency()

usmtf::Frequency::Frequency ( )

References usmtf::RangeValidator< float >::SetValidRange().

Member Function Documentation

◆ GetFrequency()

const std::string & usmtf::Frequency::GetFrequency ( ) const

noexcept

References mFrequency.

◆ GetNumericalFrequency()

float usmtf::Frequency::GetNumericalFrequency ( ) const

noexcept

References usmtf::RangeValidator< float >::GetCastedValue().

◆ ParseAndValidate()

bool usmtf::Frequency::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::Field::GetContent(), mFrequency, and usmtf::RangeValidator< T >::ParseAndValidate().