#include <Beacon.hpp>

Inheritance diagram for usmtf::Beacon:

[legend]

Collaboration diagram for usmtf::Beacon:

[legend]

Public Member Functions
	Beacon ()
bool	ParseAndValidate (const Field &aField) override
const std::string &	GetFirst () const noexcept
const std::string &	GetSecond () const noexcept
const std::string &	GetThird () const noexcept
Public Member Functions inherited from usmtf::RegexValidator
	RegexValidator ()=default
bool	ParseAndValidate (const usmtf::Field &aField) override
void	SetRegexExpression (const std::string &aExpression)
	Configure to run against regex needs.
void	SetErrorMessage (const std::string &aMessage)
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	mFirst
std::string	mSecond
std::string	mThird
Protected Attributes inherited from usmtf::RegexValidator
QRegularExpressionMatch	mMatchResults
QRegularExpression	mRegexExpression
std::string	mRegexString {"No Regex Provided"}
std::string	mErrorMessage {"Failed Regex Validation for: " + mRegexString}
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
Static Public Attributes inherited from usmtf::RegexValidator
static const std::string	cAny = R"((.*))"
static const std::string	c00to90 = R"(([0-8][0-9]\|90))"
static const std::string	c00to59 = R"(([0-5][0-9]))"
static const std::string	c00to59dec000to999 = R"(([0-5][0-9])(.)([0-9]{3}))"
static const std::string	c00to59dec0to9 = R"(([0-5][0-9])(.)([0-9]{1}))"
static const std::string	c01to60 = R"(([0-5][1-9]\|10\|20\|30\|40\|50\|60))"
static const std::string	cNorS = R"((N\|S))"
static const std::string	cAtoZ = R"((A\|B\|C\|D\|E\|F\|G\|H\|I\|J\|K\|L\|M\|N\|O\|P\|Q\|R\|S\|T\|U\|V\|W\|X\|Y\|Z))"
static const std::string	c0to9 = R"(([0-9]))"
static const std::string	cHyphenDelimeter = R"((-))"
static const std::string	c000to180 = R"((0[0-9]{2}\|1[0-7][0-9]\|180))"
static const std::string	c000to359 = R"((0[0-9]{2}\|1[0-9]{2}\|2[0-9]{2}\|3[0-5][0-9]))"
static const std::string	c0to999 = R"(([0-9]{1,3}))"
static const std::string	c1to999 = R"(([1-9][0-9]{0,2}))"
static const std::string	c000to99999 = R"(([0-9]{3,5}))"
static const std::string	cEorW = R"((E\|W))"
static const std::string	cStart = R"(^)"
static const std::string	cEnd = R"($)"
static const std::string	cSpace = R"( )"
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 Beacon. USMTF Excerpt:

THE CODED SIGNAL TRANSMITTED AIR TO AIR FOR THE PURPOSE OF TANKER IDENTIFICATION DURING RENDEZVOUS.

EXPRESSED AS FOLLOWS:

CONTEXT QUANTITY, 0-6 ALLOWABLE ENTRIES: (0 THROUGH 6).

HYPHEN ALLOWABLE ENTRIES: -. A CHARACTER THAT SEPARATES DATA ELEMENTS.

CONTEXT QUANTITY, 0-6 ALLOWABLE ENTRIES: (0 THROUGH 6).

HYPHEN ALLOWABLE ENTRIES: -. A CHARACTER THAT SEPARATES DATA ELEMENTS.

CONTEXT QUANTITY, 0-6 ALLOWABLE ENTRIES: (0 THROUGH 6).

EXAMPLE: /4-3-1

Constructor & Destructor Documentation

◆ Beacon()

usmtf::Beacon::Beacon ( )

References usmtf::RegexValidator::cEnd, usmtf::RegexValidator::cHyphenDelimeter, usmtf::RegexValidator::cStart, and usmtf::RegexValidator::SetRegexExpression().

Member Function Documentation

◆ GetFirst()

const std::string & usmtf::Beacon::GetFirst ( ) const

noexcept

The USMTF Specification fails to elaborate on the purpose of the beacon portions, so they are named by position.

◆ GetSecond()

const std::string & usmtf::Beacon::GetSecond ( ) const

noexcept

◆ GetThird()

const std::string & usmtf::Beacon::GetThird ( ) const

noexcept

References usmtf::RegexValidator::ParseAndValidate().

◆ ParseAndValidate()

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

Member Data Documentation

◆ mFirst

std::string usmtf::Beacon::mFirst

protected

◆ mSecond

std::string usmtf::Beacon::mSecond

protected

◆ mThird

std::string usmtf::Beacon::mThird

protected

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Beacon()

Member Function Documentation

◆ GetFirst()

◆ GetSecond()

◆ GetThird()

◆ ParseAndValidate()

Member Data Documentation

◆ mFirst

◆ mSecond

◆ mThird