wsf::proxy Namespace Reference

Namespace for the WSF Parser Proxy. More...

Enumerations
enum class	AltitudeReferenceEnum { Default , MSL , AGL }
	Denotes altitude reference. More...

Functions
std::string WSF_PARSER_EXPORT	StringFromPosition (const WsfProxy::Position &aLatLon, const WsfProxy::Length &aAltitude, const WsfProxy::Int &aAltitudeRef) noexcept
bool WSF_PARSER_EXPORT	PositionFromString (const std::string &aString, WsfProxy::Position &aLatLon, WsfProxy::Length &aAltitude, WsfProxy::Int &aAltitudeRef) noexcept
static std::string	ValueKindToString (WsfProxy::ValueKind aKind) noexcept

Detailed Description

Namespace for the WSF Parser Proxy.

Enumeration Type Documentation

AltitudeReferenceEnum

enum class wsf::proxy::AltitudeReferenceEnum

strong

Denotes altitude reference.

Enumerator
Default	denotes the altitude reference defaults to what the symbol (platform or mover) defines Note If the AltitudeReferenceValue functions return AltitudeReferenceEnum::Default, it is the callee's responsibility to determine the actual default
MSL	denotes the altitude is measured from mean sea level (MSL)
AGL	denotes the altitude is measured from above ground level (AGL)

Function Documentation

PositionFromString()

bool wsf::proxy::PositionFromString ( const std::string & aString, WsfProxy::Position & aLatLon, WsfProxy::Length & aAltitude, WsfProxy::Int & aAltitudeRef )

noexcept

Converts a std::string to a WsfProxy::Position (for latitude and longitude), WsfProxy::Length (for altitude), and WsfProxy::Int (for altitude reference)

Parameters

aString	is the string representation of the position
aLatLon	is the latitude and longitude
aAltitude	is the altitude
aAltitudeRef	is the altitude reference

Returns

whether or not the conversion succeeded

Note

This will edit aAltitude and aAltitudeRef if the string contains a valid altitude and starts with a valid position.

References AGL, Default, and MSL.

StringFromPosition()

std::string wsf::proxy::StringFromPosition ( const WsfProxy::Position & aLatLon, const WsfProxy::Length & aAltitude, const WsfProxy::Int & aAltitudeRef )

noexcept

Converts a WsfProxy::Position (for latitude and longitude), WsfProxy::Length (for altitude), and WsfProxy::Int (for altitude reference) to a std::string

Parameters

aLatLon	is the latitude and longitude
aAltitude	is the altitude
aAltitudeRef	is the altitude reference

Returns

a string representing the position, altitude, and altitude reference

References AGL, Default, and MSL.

ValueKindToString()

std::string wsf::proxy::ValueKindToString ( WsfProxy::ValueKind aKind )

inlinestaticnoexcept

Converts a WsfProxy::ValueKind to a std::string

Parameters

aKind

is the WsfProxy::ValueKind to convert

Returns

the WsfProxy::ValueKind as a std::string

References WsfProxy::cACCELERATION_VALUE, WsfProxy::cANGLE_VALUE, WsfProxy::cANGULARACCELERATION_VALUE, WsfProxy::cANGULARINERTIA_VALUE, WsfProxy::cANGULARRATE_VALUE, WsfProxy::cAREA_VALUE, WsfProxy::cAREADB_VALUE, WsfProxy::cBOOL_VALUE, WsfProxy::cDATARATE_VALUE, WsfProxy::cDATASIZE_VALUE, WsfProxy::cDOUBLE_VALUE, WsfProxy::cENERGY_VALUE, WsfProxy::cENUMERATION_VALUE, WsfProxy::cFLUENCE_VALUE, WsfProxy::cFORCE_VALUE, WsfProxy::cFREQUENCY_VALUE, WsfProxy::cINT_VALUE, WsfProxy::cIRRADIANCE_VALUE, WsfProxy::cLATITUDE_VALUE, WsfProxy::cLENGTH2_VALUE, WsfProxy::cLENGTH3_VALUE, WsfProxy::cLENGTH_VALUE, WsfProxy::cLIST, WsfProxy::cLONGITUDE_VALUE, WsfProxy::cMASS_VALUE, WsfProxy::cMASSDENSITY_VALUE, WsfProxy::cMASSTRANSFER_VALUE, WsfProxy::cNOISEPRESSURE_VALUE, WsfProxy::cOBJECT_MAP, WsfProxy::cPOINTER, WsfProxy::cPOSITION_VALUE, WsfProxy::cPOWER_VALUE, WsfProxy::cPOWERDB_VALUE, WsfProxy::cPRESSURE_VALUE, WsfProxy::cQUOTABLE_STRING_VALUE, WsfProxy::cRATIO_VALUE, WsfProxy::cSOLIDANGLE_VALUE, WsfProxy::cSPECIFICRANGE_VALUE, WsfProxy::cSPEED_VALUE, WsfProxy::cSTRING_VALUE, WsfProxy::cSTRUCT, WsfProxy::cTEMPERATURE_VALUE, WsfProxy::cTIME2_VALUE, WsfProxy::cTIME_VALUE, WsfProxy::cTORQUE_VALUE, and WsfProxy::cVOLUME_VALUE.

Referenced by WsfPProxyEnumType::WsfPProxyEnumType(), and WsfPProxyType::WsfPProxyType().