WSF
usmtf::InnerOuterRange Class Reference

#include <InnerOuterRange.hpp>

Inheritance diagram for usmtf::InnerOuterRange:
Collaboration diagram for usmtf::InnerOuterRange:

Public Member Functions

bool ParseAndValidate (const Field &aField) override
const std::string & GetInnerRadiusValue () const noexcept
double GetInnerRadius () const noexcept
double GetInnerRadiusInMeters () const noexcept
Public Member Functions inherited from usmtf::Radius
 Radius ()
bool ParseAndValidate (const Field &aField) override
const std::string & GetRadiusValue () const noexcept
const std::string & GetUnitOfMeasure () const noexcept
const double GetRadiusInMeters () const noexcept
const double GetRadiusInMeters (double aRadius) const noexcept
const double GetRadius () const noexcept
Public Member Functions inherited from usmtf::RangeValidator< double >
bool ParseAndValidate (const usmtf::Field &aField) override
void SetValidRange (double aLowerBound, double aUpperBound)
double 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 mInnerRadius
double mInnerRadiusDouble
Protected Attributes inherited from usmtf::Radius
std::string mRadiusValue
std::string mUnitOfMeasure
double mRadiusDouble
Protected Attributes inherited from usmtf::RangeValidator< double >
double mCastedRangeValue
double mLowerBound
double 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::Radius
bool IsValidRadius () noexcept
bool IsValidUnitOfMeasureForRadius (const std::string &aUom) noexcept
Protected Member Functions inherited from usmtf::RangeValidator< double >
bool IsInvalidRange (double 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 usmtf InnerOuterRange. An InnerOuterRange is essentially two radius (as I use Radius class often to show distance, one inner and one outer. Its represented in the usmtf as the following: |This part to the end. EXAMPLE: /SECTIO:058190T45-60NM Given SectorGeometry covers start stop angle, this is used by it to cover parsing and validation of the inner outer Radii.

Member Function Documentation

◆ GetInnerRadius()

double usmtf::InnerOuterRange::GetInnerRadius ( ) const
noexcept

References mInnerRadiusDouble.

◆ GetInnerRadiusInMeters()

double usmtf::InnerOuterRange::GetInnerRadiusInMeters ( ) const
noexcept

◆ GetInnerRadiusValue()

const std::string & usmtf::InnerOuterRange::GetInnerRadiusValue ( ) const
noexcept

References mInnerRadius.

◆ ParseAndValidate()

bool usmtf::InnerOuterRange::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::AddError(), usmtf::Field::GetContent(), usmtf::RangeValidator< double >::IsInvalidRange(), usmtf::Validatable::IsValid(), usmtf::RangeValidator< double >::mCastedRangeValue, mInnerRadius, mInnerRadiusDouble, usmtf::Radius::mRadiusDouble, usmtf::Radius::mRadiusValue, usmtf::Radius::mUnitOfMeasure, usmtf::Radius::ParseAndValidate(), and usmtf::FFIRN_Validator::SplitOnDelimeter().

Member Data Documentation

◆ mInnerRadius

std::string usmtf::InnerOuterRange::mInnerRadius
protected

◆ mInnerRadiusDouble

double usmtf::InnerOuterRange::mInnerRadiusDouble
protected

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved