usmtf::TrackWidth Class Reference

#include <TrackWidth.hpp>

Inheritance diagram for usmtf::TrackWidth:

Collaboration diagram for usmtf::TrackWidth:

Public Member Functions
	TrackWidth ()=default
const Radius *	GetLeftRadius () const noexcept
const Radius *	GetRightRadius () const noexcept
bool	ParseAndValidate (const Field &aField) override
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	IsValidTrackWidth () 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::unique_ptr< Radius >	mLeftRadius
std::unique_ptr< Radius >	mRightRadius
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 a TrackWidth. Which is simply 2 Radius Validators, see Radius.hpp USMTF Example: TrackWidth |||||||||| 1TRACK vvvvvvvvvv / LEG / LEG - BEGIN / LEG - END / LEG - WIDTH / MINALT - MAXALT / 01 / 152345N0505657E / 192646N0531226E / 30.5NML - 60.9NMR / 050AMSL - 100AMSL / 02 / 192646N0531226E / 231031N0545323E / 60.5NML - 60.5NMR / 080AMSL - 120AMSL / 03 / 231031N0545323E / 280628N0562901E / 60NML - 80NMR / 100AMSL - 150AMSL //

Constructor & Destructor Documentation

TrackWidth()

usmtf::TrackWidth::TrackWidth ( )

default

References GetLeftRadius(), GetRightRadius(), IsValidTrackWidth(), and ParseAndValidate().

Member Function Documentation

GetLeftRadius()

const Radius * usmtf::TrackWidth::GetLeftRadius ( ) const

noexcept

References mLeftRadius.

Referenced by TrackWidth().

GetRightRadius()

const Radius * usmtf::TrackWidth::GetRightRadius ( ) const

noexcept

References mRightRadius.

Referenced by TrackWidth().

IsValidTrackWidth()

bool usmtf::TrackWidth::IsValidTrackWidth ( )

protectednoexcept

References usmtf::ErrorManager::AddError(), usmtf::FFIRN_Validator::CheckForAnyDelimeter(), usmtf::Validatable::IsValid(), usmtf::FFIRN_Validator::mField, mLeftRadius, mRightRadius, and usmtf::Radius::ParseAndValidate().

Referenced by ParseAndValidate(), and TrackWidth().

ParseAndValidate()

bool usmtf::TrackWidth::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 IsValidTrackWidth(), and usmtf::FFIRN_Validator::SetField().

Referenced by TrackWidth().

Member Data Documentation

mLeftRadius

std::unique_ptr<Radius> usmtf::TrackWidth::mLeftRadius

protected

Referenced by GetLeftRadius(), and IsValidTrackWidth().

mRightRadius

std::unique_ptr<Radius> usmtf::TrackWidth::mRightRadius

protected

Referenced by GetRightRadius(), and IsValidTrackWidth().

---

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

• TrackWidth.hpp
• TrackWidth.cpp