WSF
WsfPM_Platform Class Reference

#include <WsfPM_Platform.hpp>

Inheritance diagram for WsfPM_Platform:
Collaboration diagram for WsfPM_Platform:

Public Member Functions

 WsfPM_Platform ()
 WsfPM_Platform (const WsfPProxyNode &aNode)
virtual ~WsfPM_Platform ()=default
std::string Icon () const
std::string Side () const
bool Destructible () const
WsfProxy::Time CreationTime () const
WsfProxy::Angle Heading () const
WsfPProxyNode HeadingNode () const noexcept
WsfProxy::Angle InitialHeading () const
void SetHeading (const WsfProxy::Angle &aAngle)
WsfProxy::Angle Pitch () const
void SetPitch (const WsfProxy::Angle &aAngle)
WsfProxy::Angle Roll () const
void SetRoll (const WsfProxy::Angle &aAngle)
WsfProxy::Position Position () const
WsfPProxyNode PositionNode () const
bool SetPosition (const WsfProxy::Position &aPosition)
WsfProxy::Length Altitude () const
WsfPProxyNode AltitudeNode () const
WsfProxy::Int AltitudeReference () const
WsfPProxyNode AltitudeReferenceNode () const
wsf::proxy::AltitudeReferenceEnum AltitudeReferenceValue () const noexcept
bool SetAltitude (const WsfProxy::Length &aAlt)
bool SetAltitudeReference (const WsfProxy::Int &aAltRef)
bool SetAltitudeReferenceValue (wsf::proxy::AltitudeReferenceEnum aAltRef) noexcept
WsfProxy::Length EffectiveAltitude () const
wsf::proxy::AltitudeReferenceEnum EffectiveAGL () const noexcept
bool SetEffectiveAltitude (WsfProxy::Length aAltitude)
bool SetEffectiveAGL (bool aIsAGL) noexcept
std::string InfraredSignature () const
std::string RadarSignature () const
std::string OpticalSignature () const
std::string AcousticSignature () const
WsfPM_Fuel Fuel () const
WsfPM_Mover Mover () const
WsfPM_CommMap Comms () const
WsfPM_RouterMap Routers () const
WsfPM_SensorMap Sensors () const
WsfPM_ProcessorMap Processors () const
virtual WsfPProxyNode FindPart (const std::string &aName) const
WsfPM_ObjectMap Commanders () const
WsfPM_ZoneMap Zone () const
WsfPM_ObjectMap Categories () const
bool AddPart (const WsfPProxyNode &partTypeNode, const std::string &partName)
void SetIcon (const std::string &aIcon)
void SetSide (const std::string &aSide)
void SetDestructible (bool destructible)
void LocationLLA (double &aLat, double &aLon, double &aAlt) const
void InitialLocationLLA (double &aLat, double &aLon, double &aAlt) const
WsfProxy::Position InitialLocation () const
bool SetInitialLocation (const WsfProxy::Position &aPos) const
void SetInitialLocationLLA (double aLat, double aLon, double aAlt)
std::string CommanderName (const std::string &aChainName) const
bool RemoveFromCommandChain (const std::string &aChainName) const
bool SetCommanderName (std::string aChainName, std::string aCommanderName) const
std::vector< std::string > CommandChainNames () const
std::vector< std::string > CommNetworkNames () const
bool Rename (const std::string &aNewName)
void PlatformRenamed (const std::string &aOldName, const std::string &aNewName)
WsfPM_MoverMap MoverMap () const
WsfPM_FuelMap FuelMap () const
virtual WsfPM_ObjectMap GetTypeObjectMap (const WsfPProxyStructType &aProxyStruct)
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 ()

Static Public Member Functions

static const char * CommanderSelfValue ()
Static Public Member Functions inherited from WsfPProxyNode
static WsfPProxyNode FromProxy (WsfPProxy *aProxy)

Additional Inherited Members

template<typename T>
GetAttributeT (const std::string &aName) const
WsfPProxyPath mPath

Constructor & Destructor Documentation

◆ WsfPM_Platform() [1/2]

WsfPM_Platform::WsfPM_Platform ( )

◆ WsfPM_Platform() [2/2]

WsfPM_Platform::WsfPM_Platform ( const WsfPProxyNode & aNode)

◆ ~WsfPM_Platform()

Member Function Documentation

◆ AcousticSignature()

std::string WsfPM_Platform::AcousticSignature ( ) const

◆ AddPart()

◆ Altitude()

◆ AltitudeNode()

WsfPProxyNode WsfPM_Platform::AltitudeNode ( ) const

◆ AltitudeReference()

WsfProxy::Int WsfPM_Platform::AltitudeReference ( ) const

◆ AltitudeReferenceNode()

WsfPProxyNode WsfPM_Platform::AltitudeReferenceNode ( ) const

◆ AltitudeReferenceValue()

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

Get the altitude reference property

Return values
AltitudeReferenceEnum::MSLif the property is unset
AltitudeReferenceEnum::MSLif the property is set as MSL
AltitudeReferenceEnum::AGLif the property is set as AGL
See also
AltitudeReferenceEnum

References AltitudeReference(), wsf::proxy::Default, WsfProxy::BasicValueT< T, PROXY_TYPE_ID >::GetValue(), and wsf::proxy::MSL.

Referenced by EffectiveAGL(), and ~WsfPM_Platform().

◆ Categories()

WsfPM_ObjectMap WsfPM_Platform::Categories ( ) const
inline

◆ CommandChainNames()

std::vector< std::string > WsfPM_Platform::CommandChainNames ( ) const

◆ CommanderName()

std::string WsfPM_Platform::CommanderName ( const std::string & aChainName) const

◆ Commanders()

WsfPM_ObjectMap WsfPM_Platform::Commanders ( ) const
inline

References Commanders().

Referenced by Commanders(), and SetCommanderName().

◆ CommanderSelfValue()

const char * WsfPM_Platform::CommanderSelfValue ( )
static

◆ CommNetworkNames()

std::vector< std::string > WsfPM_Platform::CommNetworkNames ( ) const

◆ Comms()

WsfPM_CommMap WsfPM_Platform::Comms ( ) const

◆ CreationTime()

WsfProxy::Time WsfPM_Platform::CreationTime ( ) const

◆ Destructible()

bool WsfPM_Platform::Destructible ( ) const

◆ EffectiveAGL()

wsf::proxy::AltitudeReferenceEnum WsfPM_Platform::EffectiveAGL ( ) const
noexcept

Get the effective altitude reference of the platform

Return values
the first waypoint's altitude referenceif the platform has a route
the platform's altitude referenceif the platform has no route

References WsfPM_Waypoint::Altitude(), AltitudeReferenceValue(), WsfPM_Waypoint::AltitudeReferenceValue(), wsf::proxy::Default, WsfPM_Mover::DefaultAltitudeReference(), WsfPProxyNode::IsNull(), WsfProxy::BasicValue::IsSet(), and Mover().

Referenced by ~WsfPM_Platform().

◆ EffectiveAltitude()

WsfProxy::Length WsfPM_Platform::EffectiveAltitude ( ) const

Get the effective altitude of the platform

Return values
the first waypoint's altitudeif the platform has a route
the platform's altitudeif the platform has no route

References Altitude(), WsfPM_Waypoint::Altitude(), WsfPProxyNode::IsNull(), and WsfProxy::BasicValue::IsUnset().

Referenced by SetInitialLocationLLA(), and ~WsfPM_Platform().

◆ FindPart()

WsfPProxyNode WsfPM_Platform::FindPart ( const std::string & aName) const
virtual

◆ Fuel()

WsfPM_Fuel WsfPM_Platform::Fuel ( ) const

References FuelMap().

Referenced by ~WsfPM_Platform().

◆ FuelMap()

WsfPM_FuelMap WsfPM_Platform::FuelMap ( ) const

Referenced by Fuel(), and GetTypeObjectMap().

◆ GetTypeObjectMap()

WsfPM_ObjectMap WsfPM_Platform::GetTypeObjectMap ( const WsfPProxyStructType & aProxyStruct)
virtual

◆ Heading()

WsfProxy::Angle WsfPM_Platform::Heading ( ) const

Get the heading

Returns
the heading as a WsfProxy::Angle

References WsfPProxyNode::GetAttributeT().

Referenced by InitialHeading(), and ~WsfPM_Platform().

◆ HeadingNode()

WsfPProxyNode WsfPM_Platform::HeadingNode ( ) const
noexcept

Get the heading

Returns
the heading as a WsfPProxyNode

References WsfPProxyNode::WsfPProxyNode().

Referenced by ~WsfPM_Platform().

◆ Icon()

std::string WsfPM_Platform::Icon ( ) const

◆ InfraredSignature()

std::string WsfPM_Platform::InfraredSignature ( ) const

◆ InitialHeading()

◆ InitialLocation()

◆ InitialLocationLLA()

◆ LocationLLA()

void WsfPM_Platform::LocationLLA ( double & aLat,
double & aLon,
double & aAlt ) const

◆ Mover()

◆ MoverMap()

WsfPM_MoverMap WsfPM_Platform::MoverMap ( ) const

Referenced by GetTypeObjectMap(), and Mover().

◆ OpticalSignature()

std::string WsfPM_Platform::OpticalSignature ( ) const

◆ Pitch()

WsfProxy::Angle WsfPM_Platform::Pitch ( ) const

◆ PlatformRenamed()

void WsfPM_Platform::PlatformRenamed ( const std::string & aOldName,
const std::string & aNewName )

◆ Position()

WsfProxy::Position WsfPM_Platform::Position ( ) const

Get the position

Returns
the position as a WsfProxy::Position

References WsfPProxyNode::GetAttributeT().

Referenced by ~WsfPM_Platform().

◆ PositionNode()

WsfPProxyNode WsfPM_Platform::PositionNode ( ) const

Get the position

Returns
the position as a WsfPProxyNode

References WsfPProxyNode::WsfPProxyNode().

Referenced by ~WsfPM_Platform().

◆ Processors()

WsfPM_ProcessorMap WsfPM_Platform::Processors ( ) const

◆ RadarSignature()

std::string WsfPM_Platform::RadarSignature ( ) const

◆ RemoveFromCommandChain()

bool WsfPM_Platform::RemoveFromCommandChain ( const std::string & aChainName) const

◆ Rename()

◆ Roll()

WsfProxy::Angle WsfPM_Platform::Roll ( ) const

◆ Routers()

WsfPM_RouterMap WsfPM_Platform::Routers ( ) const

Referenced by ~WsfPM_Platform().

◆ Sensors()

WsfPM_SensorMap WsfPM_Platform::Sensors ( ) const

◆ SetAltitude()

bool WsfPM_Platform::SetAltitude ( const WsfProxy::Length & aAlt)

◆ SetAltitudeReference()

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

◆ SetAltitudeReferenceValue()

bool WsfPM_Platform::SetAltitudeReferenceValue ( wsf::proxy::AltitudeReferenceEnum aAltRef)
noexcept

◆ SetCommanderName()

bool WsfPM_Platform::SetCommanderName ( std::string aChainName,
std::string aCommanderName ) const

◆ SetDestructible()

void WsfPM_Platform::SetDestructible ( bool destructible)

◆ SetEffectiveAGL()

◆ SetEffectiveAltitude()

◆ SetHeading()

void WsfPM_Platform::SetHeading ( const WsfProxy::Angle & aAngle)

◆ SetIcon()

void WsfPM_Platform::SetIcon ( const std::string & aIcon)

◆ SetInitialLocation()

bool WsfPM_Platform::SetInitialLocation ( const WsfProxy::Position & aPos) const

◆ SetInitialLocationLLA()

◆ SetPitch()

void WsfPM_Platform::SetPitch ( const WsfProxy::Angle & aAngle)

◆ SetPosition()

bool WsfPM_Platform::SetPosition ( const WsfProxy::Position & aPosition)

◆ SetRoll()

void WsfPM_Platform::SetRoll ( const WsfProxy::Angle & aAngle)

◆ SetSide()

void WsfPM_Platform::SetSide ( const std::string & aSide)

◆ Side()

std::string WsfPM_Platform::Side ( ) const

◆ Zone()


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