WSF
WsfPM_Waypoint Class Reference

#include <WsfPM_Waypoint.hpp>

Inheritance diagram for WsfPM_Waypoint:
Collaboration diagram for WsfPM_Waypoint:

Public Types

enum  WaypointType { cPOSITION , cOFFSET , cTURN , cOTHER }
enum  EndOfPathOption { cEP_DEFAULT , cEP_EXTRAPOLATE , cEP_STOP , cEP_REMOVE }
enum  TurnDirection { cTD_SHORTEST , cTD_LEFT , cTD_RIGHT }

Public Member Functions

 WsfPM_Waypoint ()
 WsfPM_Waypoint (const WsfPProxyNode &aNode)
WaypointType GetWaypointType () const
WsfProxy::Position Position () const noexcept
WsfPProxyNode PositionNode () const noexcept
WsfProxy::Speed Speed () const
WsfProxy::Speed ClimbRate () const
bool UseDefaultClimbRate () const
WsfProxy::Speed DiveRate () const
WsfProxy::Length Altitude () const
WsfProxy::Length2 Offset () const
WsfProxy::Angle HeadingChange () const
WsfProxy::Int GetAltitudeReference () const
wsf::proxy::AltitudeReferenceEnum AltitudeReferenceValue () const noexcept
EndOfPathOption EndOfPath () const
WsfProxy::Bool SwitchOnApproach () const
TurnDirection GetTurnDirection () const
WsfProxy::Acceleration LinearAcceleration () const
bool UseDefaultLinearAcceleration () const
WsfProxy::Acceleration RadialAcceleration () const
bool UseDefaultRadialAcceleration () const
WsfProxy::Angle BankAngleLimit () const
WsfProxy::Acceleration TurnG_Limit () const
WsfProxy::Time PauseTime () const
WsfProxy::Length Distance () const
WsfProxy::Time Time () const
WsfProxy::TimeTimeToPoint () const
WsfProxy::Angle Heading () const noexcept
WsfPProxyNode HeadingNode () const noexcept
std::string ExecuteScript () const
std::string GotoLabel () const
std::string Label () const
bool SetWaypointType (WaypointType aType)
bool SetAltitudeReference (const WsfProxy::Int &aAltRef)
bool SetAltitudeReferenceValue (wsf::proxy::AltitudeReferenceEnum aVal) noexcept
bool SetAltitude (WsfProxy::Length aAltitude)
bool SetPosition (WsfProxy::Position aPosition)
bool SetOffset (WsfProxy::Length2 aOffset)
bool SetTurnDirection (TurnDirection aDirection)
bool SetGotoLabel (const std::string &aGoto)
bool SetRadialAcceleration (WsfProxy::Acceleration aRadialAccel)
bool SetEndOfPath (EndOfPathOption aEndOfPath)
bool SetSwitchOnApproach (WsfProxy::Bool aSwitchOnApproach)
Public Member Functions inherited from WsfPProxyNode
void MoveTo (WsfPProxy *aProxy, const WsfPProxyPath &aPath, size_t aSubPathLength)
 WsfPProxyNode ()
 WsfPProxyNode (WsfPProxy *aProxy, const WsfPProxyPath &aPath)
 WsfPProxyNode (WsfPProxy *aProxy, const WsfPProxyPath &aPath, size_t aSubPathLength)
 WsfPProxyNode (WsfPProxy *aProxy, const WsfPProxyPath &aPath, WsfPProxyValue aValue)
 WsfPProxyNode (const WsfPProxyNode &aSrc)
WsfPProxyNode Root () const
WsfPProxyGetProxy () const
WsfPProxyValue GetRoot () const
WsfPProxyValue GetValue () const
WsfPProxyNode GetParent () const
WsfPProxyNode GetInherited () const
const WsfPProxyPathGetPath () const
std::string GetPathString () const
WsfPProxyPath GetStablePath () const
WsfPProxyPath GetInheritedPath () const
const WsfPProxyPathGetTypePath () const
const WsfPProxyPathGetBasePath () const
std::string GetName () const
std::string GetAttrName () const
std::string GetInheritedName () const
std::string GetTypeName () const
std::vector< std::string > GetInheritedTypeNames () const
UtTextDocumentRange GetSourceDocumentRange () const
UtTextDocumentRange GetFirstDocumentRange () const noexcept
UtTextDocumentRange GetLastDocumentRange () const noexcept
std::string GetSourceText () const
WsfPProxyIndexNodeFindIndexNode () const
const std::set< WsfPProxyPath > * GetInheritedValuePaths () const
bool SwitchToBasicTypes ()
bool SwitchToUserTypes ()
bool UpdateParentPath (const WsfPProxyPath &oldParentPath, const WsfPProxyPath &newParentPath)
void ResetToInheritedValue ()
 operator bool () const
 operator bool ()
bool IsValid () const
bool IsNull () const
bool operator== (const WsfPProxyNode &aRhs) const
bool operator!= (const WsfPProxyNode &aRhs) const
WsfPProxyNodeoperator+= (size_t aIndex)
WsfPProxyNodeoperator+= (const std::string &aStr)
WsfPProxyNodeoperator+= (const WsfPProxyPath &aSuffixPath)
WsfPProxyNodeoperator+= (const WsfPProxyKey &aEntry)
WsfPProxyNodeoperator+= (const WsfParseTypePath &aParseTypePath)
WsfPProxyNode operator+ (const WsfPProxyPath &aSuffixPath) const
WsfPProxyNode operator+ (const WsfPProxyKey &aEntry) const
WsfPProxyNode operator+ (size_t aEntryIndex) const
WsfPProxyNode operator+ (const std::string &aEntry) const
WsfPProxyNode operator+ (const char *aEntry) const
WsfPProxyNode operator+ (const WsfParseTypePath &aParseTypePath) const
WsfPProxyNodeToParent ()
WsfPProxyNodeTrimPath (size_t aPathLength)
bool operator< (const WsfPProxyNode &aRhs) const
void SetBasePath (const WsfPProxyPath &aNewPath)
void NotifyValueChanged () const
void NotifyValueAdded () const
void NotifyValueRemoved () const
void NotifyValueMoved (const std::string &aOldName) const
void NotifyAttributeChanged (const char *aAttributeName) const
void NotifyBeforeValueChanged () const
void NotifyBeforeAttributeChanged (const char *aAttributeName) const
template<typename T>
void ChangeAttribute (const char *aAttributeName, const T &aValue)
bool Assign (const WsfPProxyValue &aValue) const
bool Assign (const std::string &aValue) const
bool Assign (int aIntValue) const
bool Assign (double aDoubleVal) const
bool Assign (bool aBoolVal) const
bool ClearUnset () const
bool Unset () const
bool UnsetAttribute (const std::string &aAttrName) const
bool AssignAttribute (const std::string &aAttrName, const std::string &aValue) const
bool AssignAttribute (const std::string &aAttrName, int aIntValue) const
bool AssignAttribute (const std::string &aAttrName, double aDoubleVal) const
bool AssignAttribute (const std::string &aAttrName, bool aBoolVal) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::String &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Double &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Int &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Latitude &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Longitude &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Length &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Length2 &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Time &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Speed &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::DataSize &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Power &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::PowerDB &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::SolidAngle &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Mass &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Force &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Torque &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Area &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::AreaDB &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Volume &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Time2 &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Acceleration &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Frequency &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Angle &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::AngularRate &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::AngularAcceleration &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::DataRate &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::MassDensity &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::MassTransfer &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Energy &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Fluence &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Irradiance &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Ratio &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::NoisePressure &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Pressure &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Temperature &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::SpecificRange &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::AngularInertia &aValue) const
bool AssignAttribute (const std::string &aAttrName, const WsfProxy::Position &aValue) const
bool Assign (const WsfProxy::String &aValue) const
bool Assign (const WsfProxy::Double &aValue) const
bool Assign (const WsfProxy::Int &aValue) const
bool Assign (const WsfProxy::Latitude &aValue) const
bool Assign (const WsfProxy::Longitude &aValue) const
bool Assign (const WsfProxy::Length &aValue) const
bool Assign (const WsfProxy::Length2 &aValue) const
bool Assign (const WsfProxy::Time &aValue) const
bool Assign (const WsfProxy::Speed &aValue) const
bool Assign (const WsfProxy::DataSize &aValue) const
bool Assign (const WsfProxy::Power &aValue) const
bool Assign (const WsfProxy::PowerDB &aValue) const
bool Assign (const WsfProxy::SolidAngle &aValue) const
bool Assign (const WsfProxy::Mass &aValue) const
bool Assign (const WsfProxy::Force &aValue) const
bool Assign (const WsfProxy::Torque &aValue) const
bool Assign (const WsfProxy::Area &aValue) const
bool Assign (const WsfProxy::AreaDB &aValue) const
bool Assign (const WsfProxy::Volume &aValue) const
bool Assign (const WsfProxy::Time2 &aValue) const
bool Assign (const WsfProxy::Acceleration &aValue) const
bool Assign (const WsfProxy::Frequency &aValue) const
bool Assign (const WsfProxy::Angle &aValue) const
bool Assign (const WsfProxy::AngularRate &aValue) const
bool Assign (const WsfProxy::AngularAcceleration &aValue) const
bool Assign (const WsfProxy::DataRate &aValue) const
bool Assign (const WsfProxy::MassDensity &aValue) const
bool Assign (const WsfProxy::MassTransfer &aValue) const
bool Assign (const WsfProxy::Energy &aValue) const
bool Assign (const WsfProxy::Fluence &aValue) const
bool Assign (const WsfProxy::Irradiance &aValue) const
bool Assign (const WsfProxy::Ratio &aValue) const
bool Assign (const WsfProxy::NoisePressure &aValue) const
bool Assign (const WsfProxy::Pressure &aValue) const
bool Assign (const WsfProxy::Temperature &aValue) const
bool Assign (const WsfProxy::SpecificRange &aValue) const
bool Assign (const WsfProxy::AngularInertia &aValue) const
bool Assign (const WsfProxy::Position &aValue) const
std::string ToJSON (int aOutputFlags=0) const
bool IsOfBasicType () const noexcept
bool IsA_BasicType () const noexcept
bool IsA_StructType () const noexcept
bool IsA_ListType () const noexcept
bool IsA_MapType () const noexcept
bool IsOfBasicType (const std::string &aTypeName) const noexcept
bool IsA_PredefinedStructTypeOf (const std::string &aTypeName) const noexcept
bool IsOfUserType (const std::string &aTypeName) const noexcept
bool IsA_StructTypeOf (const std::string &aTypeName) const noexcept
bool IsA_ListTypeOf (const std::string &aTypeName) const noexcept
bool IsA_MapTypeOf (const std::string &aTypeName) const noexcept
bool IsOfType (const std::string &aTypeName) const noexcept
bool IsInherited () const
bool IsInheritedFromParent () const
void Invalidate ()

Additional Inherited Members

Static Public Member Functions inherited from WsfPProxyNode
static WsfPProxyNode FromProxy (WsfPProxy *aProxy)
template<typename T>
GetAttributeT (const std::string &aName) const
WsfPProxyPath mPath

Member Enumeration Documentation

◆ EndOfPathOption

Enumerator
cEP_DEFAULT 
cEP_EXTRAPOLATE 
cEP_STOP 
cEP_REMOVE 

◆ TurnDirection

Enumerator
cTD_SHORTEST 
cTD_LEFT 
cTD_RIGHT 

◆ WaypointType

Enumerator
cPOSITION 
cOFFSET 
cTURN 
cOTHER 

Constructor & Destructor Documentation

◆ WsfPM_Waypoint() [1/2]

WsfPM_Waypoint::WsfPM_Waypoint ( )

◆ WsfPM_Waypoint() [2/2]

WsfPM_Waypoint::WsfPM_Waypoint ( const WsfPProxyNode & aNode)

Member Function Documentation

◆ Altitude()

◆ AltitudeReferenceValue()

wsf::proxy::AltitudeReferenceEnum WsfPM_Waypoint::AltitudeReferenceValue ( ) const
noexcept

Get the altitude reference property

Return values
AltitudeReferenceEnum::Defaultif this waypoint is on a global route and the property is unset
AltitudeReferenceEnum::MSLif the property is set as MSL
AltitudeReferenceEnum::AGLif the property is set as AGL
WsfPM_Mover::DefaultAltitudeReferenceif this waypoint is on a local route and the property is unset
See also
AltitudeReferenceEnum

References wsf::proxy::Default, WsfPM_Mover::DefaultAltitudeReference(), GetAltitudeReference(), WsfPProxyNode::GetParent(), WsfProxy::BasicValueT< T, PROXY_TYPE_ID >::GetValue(), WsfPProxyNode::IsA_ListTypeOf(), WsfPProxyNode::IsOfType(), and WsfPProxyNode::IsValid().

Referenced by WsfPM_Platform::EffectiveAGL().

◆ BankAngleLimit()

WsfProxy::Angle WsfPM_Waypoint::BankAngleLimit ( ) const

◆ ClimbRate()

WsfProxy::Speed WsfPM_Waypoint::ClimbRate ( ) const

◆ Distance()

WsfProxy::Length WsfPM_Waypoint::Distance ( ) const

◆ DiveRate()

WsfProxy::Speed WsfPM_Waypoint::DiveRate ( ) const

◆ EndOfPath()

◆ ExecuteScript()

std::string WsfPM_Waypoint::ExecuteScript ( ) const
inline

◆ GetAltitudeReference()

WsfProxy::Int WsfPM_Waypoint::GetAltitudeReference ( ) const

Get the altitude reference property

Return values
0if the property is "unset"
1if the property is set as MSL
2if the property is set as AGL
Note
"unset": Since the altitude reference always has a default, calls to IsUnset will always return true.

References WsfPProxyNode::GetAttributeT().

Referenced by AltitudeReferenceValue().

◆ GetTurnDirection()

◆ GetWaypointType()

◆ GotoLabel()

std::string WsfPM_Waypoint::GotoLabel ( ) const
inline

◆ Heading()

WsfProxy::Angle WsfPM_Waypoint::Heading ( ) const
noexcept

Get the heading

Returns
the initial heading as a WsfProxy::Angle

References WsfPProxyNode::GetAttributeT().

Referenced by WsfPM_Platform::InitialHeading().

◆ HeadingChange()

WsfProxy::Angle WsfPM_Waypoint::HeadingChange ( ) const

◆ HeadingNode()

WsfPProxyNode WsfPM_Waypoint::HeadingNode ( ) const
noexcept

Get the heading

Returns
the initial heading as a WsfPProxyNode

References WsfPProxyNode::WsfPProxyNode().

◆ Label()

std::string WsfPM_Waypoint::Label ( ) const
inline

◆ LinearAcceleration()

WsfProxy::Acceleration WsfPM_Waypoint::LinearAcceleration ( ) const

◆ Offset()

WsfProxy::Length2 WsfPM_Waypoint::Offset ( ) const

◆ PauseTime()

WsfProxy::Time WsfPM_Waypoint::PauseTime ( ) const

◆ Position()

WsfProxy::Position WsfPM_Waypoint::Position ( ) const
noexcept

◆ PositionNode()

WsfPProxyNode WsfPM_Waypoint::PositionNode ( ) const
noexcept

Get the position

Returns
the position as a WsfPProxyNode

References WsfPProxyNode::WsfPProxyNode().

◆ RadialAcceleration()

WsfProxy::Acceleration WsfPM_Waypoint::RadialAcceleration ( ) const

◆ SetAltitude()

bool WsfPM_Waypoint::SetAltitude ( WsfProxy::Length aAltitude)

◆ SetAltitudeReference()

bool WsfPM_Waypoint::SetAltitudeReference ( const WsfProxy::Int & aAltRef)

◆ SetAltitudeReferenceValue()

bool WsfPM_Waypoint::SetAltitudeReferenceValue ( wsf::proxy::AltitudeReferenceEnum aVal)
noexcept

◆ SetEndOfPath()

bool WsfPM_Waypoint::SetEndOfPath ( EndOfPathOption aEndOfPath)

◆ SetGotoLabel()

bool WsfPM_Waypoint::SetGotoLabel ( const std::string & aGoto)

◆ SetOffset()

bool WsfPM_Waypoint::SetOffset ( WsfProxy::Length2 aOffset)

◆ SetPosition()

bool WsfPM_Waypoint::SetPosition ( WsfProxy::Position aPosition)

◆ SetRadialAcceleration()

bool WsfPM_Waypoint::SetRadialAcceleration ( WsfProxy::Acceleration aRadialAccel)

◆ SetSwitchOnApproach()

bool WsfPM_Waypoint::SetSwitchOnApproach ( WsfProxy::Bool aSwitchOnApproach)

◆ SetTurnDirection()

bool WsfPM_Waypoint::SetTurnDirection ( TurnDirection aDirection)

◆ SetWaypointType()

bool WsfPM_Waypoint::SetWaypointType ( WaypointType aType)

◆ Speed()

WsfProxy::Speed WsfPM_Waypoint::Speed ( ) const

◆ SwitchOnApproach()

WsfProxy::Bool WsfPM_Waypoint::SwitchOnApproach ( ) const

◆ Time()

WsfProxy::Time WsfPM_Waypoint::Time ( ) const

References WsfPProxyNode::GetAttributeT().

Referenced by TimeToPoint().

◆ TimeToPoint()

WsfProxy::Time * WsfPM_Waypoint::TimeToPoint ( ) const
inline

◆ TurnG_Limit()

WsfProxy::Acceleration WsfPM_Waypoint::TurnG_Limit ( ) const

◆ UseDefaultClimbRate()

bool WsfPM_Waypoint::UseDefaultClimbRate ( ) const

◆ UseDefaultLinearAcceleration()

bool WsfPM_Waypoint::UseDefaultLinearAcceleration ( ) const

◆ UseDefaultRadialAcceleration()

bool WsfPM_Waypoint::UseDefaultRadialAcceleration ( ) const

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