WsfPathTarget Struct Reference

#include <WsfPathComputer.hpp>

Public Types
enum	TargetType {   cLOCATION = 0x1 , cALTITUDE = 0x2 , cHEADING = 0x4 , cSPEED = 0x8 ,   cEXTRAPOLATE = 0x10 , cTURN_ON_APPROACH = 0x20 , cRELATIVE_TURN = 0x40 , cREQUIRED_POINT = 0x80 ,   cOPTIONAL_POINT = 0x100 , cTIME_TO_POINT = 0x200 }
enum	TurnDirection { cTURN_DIR_LEFT = -1 , cTURN_DIR_SHORTEST = 0 , cTURN_DIR_RIGHT = 1 }

Public Member Functions
	WsfPathTarget ()
void	Print (ut::log::MessageStream &aStream)

Public Attributes
unsigned int	mTargetType
	Bit combination of TargetType.
double	mLatitude
	Specifies the target latitude. Must be used with (mTargetType & cLOCATION).
double	mLongitude
	Specifies the target longitude. Must be used with (mTargetType & cLOCATION).
double	mAltitude
	Specifies the target altitude. Must be used with (mTargetType & cALTITUDE).
double	mHeading
	Specifies the target heading. Must be used with (mTargetType & cHEADING).
double	mSpeed
	Specifies the target speed. Must be used with (mTargetType & cSPEED).
double	mDistance
	Specifies the distance traveled before completion.
double	mTime
	Specifies the length of time to travel before completion.
TurnDirection	mTurnDirection
	Specifies the direction used to complete a turn.
double	mNextPointLat
double	mNextPointLon
double	mNextPointRadialAccel
double	mTurnFailureThreshold
	}

Member Enumeration Documentation

TargetType

enum WsfPathTarget::TargetType

Enumerator
cLOCATION
cALTITUDE
cHEADING
cSPEED
cEXTRAPOLATE
cTURN_ON_APPROACH
cRELATIVE_TURN
cREQUIRED_POINT
cOPTIONAL_POINT
cTIME_TO_POINT

TurnDirection

enum WsfPathTarget::TurnDirection

Enumerator
cTURN_DIR_LEFT	Turn to the left, even if right is closer.
cTURN_DIR_SHORTEST	Turn in the direction that results in the shortest turn (DEFAULT).
cTURN_DIR_RIGHT	Turn to the right, even if left is closer.

Constructor & Destructor Documentation

WsfPathTarget()

WsfPathTarget::WsfPathTarget ( )

inline

References cLOCATION, cTURN_DIR_SHORTEST, mAltitude, mDistance, mHeading, mLatitude, mLongitude, mNextPointLat, mNextPointLon, mNextPointRadialAccel, mSpeed, mTargetType, mTime, mTurnDirection, and mTurnFailureThreshold.

Member Function Documentation

Print()

void WsfPathTarget::Print

(

ut::log::MessageStream &

aStream

)

References cALTITUDE, cEXTRAPOLATE, cHEADING, cLOCATION, cSPEED, cTURN_DIR_LEFT, cTURN_DIR_RIGHT, cTURN_DIR_SHORTEST, cTURN_ON_APPROACH, mAltitude, mHeading, mLatitude, mLongitude, mNextPointLat, mNextPointLon, mNextPointRadialAccel, mSpeed, mTargetType, and mTurnDirection.

Member Data Documentation

mAltitude

double WsfPathTarget::mAltitude

Specifies the target altitude. Must be used with (mTargetType & cALTITUDE).

Referenced by WsfPathComputer::ComputeSpeedAltitudeTargets(), WsfPathComputer::ConstrainTarget(), WsfPathComputer::CreateTarget(), Print(), and WsfPathTarget().

mDistance

double WsfPathTarget::mDistance

Specifies the distance traveled before completion.

Referenced by WsfPathComputer::CreateTarget(), WsfPathComputer::StraightOnHeading(), WsfPathComputer::TurnRelative(), and WsfPathTarget().

mHeading

double WsfPathTarget::mHeading

Specifies the target heading. Must be used with (mTargetType & cHEADING).

Referenced by WsfPathComputer::ComputePath(), WsfPathComputer::CreateTarget(), Print(), WsfPathComputer::TurnRelative(), WsfPathComputer::TurnToHeading(), and WsfPathTarget().

mLatitude

double WsfPathTarget::mLatitude

Specifies the target latitude. Must be used with (mTargetType & cLOCATION).

Referenced by WsfPathComputer::CreateTarget(), Print(), WsfPathComputer::StraightToPoint(), and WsfPathTarget().

mLongitude

double WsfPathTarget::mLongitude

Specifies the target longitude. Must be used with (mTargetType & cLOCATION).

Referenced by WsfPathComputer::CreateTarget(), Print(), WsfPathComputer::StraightToPoint(), and WsfPathTarget().

mNextPointLat

double WsfPathTarget::mNextPointLat

Specifies the location and radial acceleration used to get to the point after the target point. Only used if point type includes cTURN_ON_APPROACH. {

Referenced by WsfPathComputer::CreateTarget(), Print(), WsfPathComputer::StraightToPoint(), and WsfPathTarget().

mNextPointLon

double WsfPathTarget::mNextPointLon

Referenced by WsfPathComputer::CreateTarget(), Print(), WsfPathComputer::StraightToPoint(), and WsfPathTarget().

mNextPointRadialAccel

double WsfPathTarget::mNextPointRadialAccel

Referenced by WsfPathComputer::CreateTarget(), Print(), WsfPathComputer::StraightToPoint(), and WsfPathTarget().

mSpeed

double WsfPathTarget::mSpeed

Specifies the target speed. Must be used with (mTargetType & cSPEED).

Referenced by WsfPathComputer::ComputeSpeedAltitudeTargets(), WsfPathComputer::ConstrainTarget(), WsfRoadMover::CreateRoute(), WsfPathComputer::CreateTarget(), Print(), WsfPathComputer::RevisePathHitPointAtTime(), WsfPathComputer::Rotate(), WsfPathComputer::StraightToPoint(), and WsfPathTarget().

mTargetType

unsigned int WsfPathTarget::mTargetType

Bit combination of TargetType.

Referenced by WsfPathComputer::ComputePath(), WsfPathComputer::ComputeSpeedAltitudeTargets(), WsfPathComputer::ConstrainTarget(), WsfPathComputer::CreateTarget(), WsfWaypointMover::GetFutureLocationWCS(), Print(), WsfPathComputer::RevisePathHitPointAtTime(), WsfPathComputer::Rotate(), WsfPathComputer::StraightToPoint(), and WsfPathTarget().

mTime

double WsfPathTarget::mTime

Specifies the length of time to travel before completion.

Referenced by WsfPathComputer::CreateTarget(), WsfPathComputer::RevisePathHitPointAtTime(), WsfPathComputer::StraightOnHeading(), WsfPathComputer::TurnRelative(), and WsfPathTarget().

mTurnDirection

TurnDirection WsfPathTarget::mTurnDirection

Specifies the direction used to complete a turn.

Referenced by WsfPathComputer::ComputePath(), WsfPathComputer::CreateTarget(), Print(), and WsfPathTarget().

mTurnFailureThreshold

double WsfPathTarget::mTurnFailureThreshold

}

Referenced by WsfPathTarget().

---

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

• WsfPathComputer.hpp
• WsfPathComputer.cpp