USMTF Excerpt: More...

#include <Altitude.hpp>

Inheritance diagram for usmtf::Altitude:

[legend]

Collaboration diagram for usmtf::Altitude:

[legend]

Public Member Functions
	Altitude () noexcept
bool	ParseAndValidate (const Field &aField) override
const std::string &	GetVerticalDistance () 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	mVerticalDistance
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

USMTF Excerpt:

FFIRN_Validator responsible for the validation and property extraction of a Altitude. An Altitude is somewhat self explanatory given the mathematical definition. The class simply Captures a height with a Unit for understanding the height number.

VERTICAL DISTANCE IN HUNDREDS OF FEET ABOVE MEAN SEA LEVEL (MSL) This definition is subject to change based on individual needs. This can be expanded to be arbitrary units and reference points. EXAMPLE: /210

Constructor & Destructor Documentation

◆ Altitude()

usmtf::Altitude::Altitude ( )

noexcept

Default Range for valid Altitude is [0,999]; this can be configured with SetValidRange

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

Member Function Documentation

◆ GetVerticalDistance()

const std::string & usmtf::Altitude::GetVerticalDistance ( ) const

noexcept

References mVerticalDistance.

◆ ParseAndValidate()

bool usmtf::Altitude::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::ErrorManager::ClearErrors(), usmtf::RangeValidator< float >::mCastedRangeValue, mVerticalDistance, usmtf::RangeValidator< T >::ParseAndValidate(), and usmtf::FFIRN_Validator::SetField().

Member Data Documentation

◆ mVerticalDistance

std::string usmtf::Altitude::mVerticalDistance

protected

Referenced by GetVerticalDistance(), and ParseAndValidate().

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

Public Member Functions

Protected Attributes

Additional Inherited Members