WSF
usmtf::SectorGeometry Class Reference

#include <SectorGeometry.hpp>

Inheritance diagram for usmtf::SectorGeometry:
Collaboration diagram for usmtf::SectorGeometry:

Public Member Functions

 SectorGeometry ()
bool ParseAndValidate (const Field &aField) override
const std::string & GetSectorStartAngle () const noexcept
const std::string & GetSectorStopAngle () const noexcept
const std::string & GetAngleOrientation () const noexcept
const InnerOuterRangeGetRange () const noexcept
Public Member Functions inherited from usmtf::RangeValidator< int >
void SetValidRange (int aLowerBound, int aUpperBound)
int 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 mSectorStartAngle
std::string mSectorStopAngle
std::string mAngularOrientation
InnerOuterRange mRange
Protected Attributes inherited from usmtf::RangeValidator< int >
int mCastedRangeValue
int mLowerBound
int 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< int >
bool IsInvalidRange (int 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 a SectorGeometry. SectorGeometry is a semi circular shape that might represent a wedge with potentially inner and out radius. usmtf Example: /SECTIO:058190T45-60NM

Constructor & Destructor Documentation

◆ SectorGeometry()

usmtf::SectorGeometry::SectorGeometry ( )

Member Function Documentation

◆ GetAngleOrientation()

const std::string & usmtf::SectorGeometry::GetAngleOrientation ( ) const
noexcept

References mAngularOrientation.

◆ GetRange()

const InnerOuterRange & usmtf::SectorGeometry::GetRange ( ) const
noexcept

References mRange.

◆ GetSectorStartAngle()

const std::string & usmtf::SectorGeometry::GetSectorStartAngle ( ) const
noexcept

References mSectorStartAngle.

◆ GetSectorStopAngle()

const std::string & usmtf::SectorGeometry::GetSectorStopAngle ( ) const
noexcept

References mSectorStopAngle.

◆ ParseAndValidate()

bool usmtf::SectorGeometry::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.

Reimplemented from usmtf::RangeValidator< int >.

References usmtf::ErrorManager::AddError(), usmtf::ErrorManager::AddErrors(), usmtf::FFIRN_Validator::CheckForAnyDelimeter(), usmtf::Field::GetContent(), usmtf::RangeValidator< int >::IsInvalidRange(), usmtf::FFIRN_Validator::IsStringLength(), mAngularOrientation, usmtf::RangeValidator< int >::mCastedRangeValue, mRange, mSectorStartAngle, mSectorStopAngle, and usmtf::FFIRN_Validator::SplitOnDelimeter().

Member Data Documentation

◆ mAngularOrientation

std::string usmtf::SectorGeometry::mAngularOrientation
protected

◆ mRange

InnerOuterRange usmtf::SectorGeometry::mRange
protected

◆ mSectorStartAngle

std::string usmtf::SectorGeometry::mSectorStartAngle
protected

◆ mSectorStopAngle

std::string usmtf::SectorGeometry::mSectorStopAngle
protected

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