WsfPathList Class Reference

Defines a list of motions a platform could take. More...

#include <WsfPathList.hpp>

Classes
class	Segment
	Defines an entity's segment from one state to another over time. More...
class	DynamicsData
	Contains data about the acceleration and altitude changes during a segment. More...
class	RotationData
	Contains data about a rotation. More...
class	RotationArcSegment
	Represents a rotation around an axis, using constant speed / altitude. More...
class	RotationSegment
	Represents a rotation around an axis. Behaves using values in DynamicsData. More...
class	PauseSegment

Public Types
typedef std::vector< Segment * >	SegmentList

Public Member Functions
	WsfPathList ()
	WsfPathList (const WsfPathList &aSrc)
	~WsfPathList ()
WsfPathList &	operator= (const WsfPathList &aRhs)=delete
void	GetState (double aRelativeSimTime, WsfPathState &aState)
	Returns the state at a time offset from the beginning of the path.
void	Reset ()
	Removes all segments from the path.
void	Append (Segment *aSegmentPtr)
	Appends a segment to the path.
void	Append (Segment *aSegmentPtr, const WsfPathState &aEndState)
	Appends a segment to the path, and sets the related end state.
void	Append (double aDuration, WsfPathList &aPathList)
void	PopBack ()
double	GetDuration () const
	Returns the sim-time required to move along the path.
double	GetEndStateValid ()
bool	Empty () const
	Returns true if the path list is empty.
const WsfPathState &	GetEndState ()
void	SetEndState (WsfPathState &aState)
	Sets the final state at the end of the path.
const SegmentList &	GetSegments () const
	returns the list of segments in the path
void	PrintPath (ut::log::MessageStream &aStream)

Detailed Description

Defines a list of motions a platform could take.

Member Typedef Documentation

SegmentList

typedef std::vector<Segment*> WsfPathList::SegmentList

Constructor & Destructor Documentation

WsfPathList() [1/2]

WsfPathList::WsfPathList

(

)

Referenced by Append(), operator=(), and WsfPathList().

WsfPathList() [2/2]

WsfPathList::WsfPathList

(

const WsfPathList &

aSrc

)

References WsfPathList().

~WsfPathList()

WsfPathList::~WsfPathList

(

)

References Reset().

Member Function Documentation

Append() [1/3]

void WsfPathList::Append	(	double	aDuration,
		WsfPathList &	aPathList )

References WsfPathList::Segment::GetDuration(), WsfPathList::Segment::SetDuration(), and WsfPathList().

Append() [2/3]

void WsfPathList::Append

(

Segment *

aSegmentPtr

)

Appends a segment to the path.

References WsfPathList::Segment::GetDuration().

Referenced by Append(), WsfPathComputer::ComputePath(), operator=(), WsfPathComputer::RevisePathHitPointAtTime(), WsfPathComputer::Rotate(), and WsfPathComputer::TurnRelative().

Append() [3/3]

void WsfPathList::Append	(	Segment *	aSegmentPtr,
		const WsfPathState &	aEndState )

Appends a segment to the path, and sets the related end state.

References Append().

Empty()

bool WsfPathList::Empty ( ) const

inline

Returns true if the path list is empty.

Referenced by WsfPathComputer::ComputePath(), and WsfPathComputer::RevisePathHitPointAtTime().

GetDuration()

double WsfPathList::GetDuration

(

)

const

Returns the sim-time required to move along the path.

Referenced by GetEndState(), WsfWaypointMover::GetFutureLocationWCS(), operator=(), WsfPathComputer::RevisePathHitPointAtTime(), and WsfPathComputer::TurnRelative().

GetEndState()

const WsfPathState & WsfPathList::GetEndState

(

)

Returns the state at the end of the path Not valid when Empty()

References GetDuration().

Referenced by WsfPathComputer::ComputePath(), WsfWaypointMover::GetFutureLocationWCS(), GetState(), WsfPathComputer::Rotate(), and WsfPathComputer::TurnRelative().

GetEndStateValid()

double WsfPathList::GetEndStateValid ( )

inline

GetSegments()

const SegmentList & WsfPathList::GetSegments ( ) const

inline

returns the list of segments in the path

Referenced by WsfPathComputer::RevisePathHitPointAtTime().

GetState()

void WsfPathList::GetState	(	double	aRelativeSimTime,
		WsfPathState &	aState )

Returns the state at a time offset from the beginning of the path.

References GetEndState().

Referenced by WsfWaypointMover::GetFutureLocationWCS(), operator=(), and WsfPathComputer::RevisePathHitPointAtTime().

operator=()

WsfPathList & WsfPathList::operator= ( const WsfPathList & aRhs )

delete

References Append(), GetDuration(), GetState(), PopBack(), Reset(), and WsfPathList().

PopBack()

void WsfPathList::PopBack

(

)

Referenced by operator=(), and WsfPathComputer::RevisePathHitPointAtTime().

PrintPath()

void WsfPathList::PrintPath

(

ut::log::MessageStream &

aStream

)

References WsfPathList::Segment::Print().

Reset()

void WsfPathList::Reset

(

)

Removes all segments from the path.

Referenced by operator=(), and ~WsfPathList().

SetEndState()

void WsfPathList::SetEndState ( WsfPathState & aState )

inline

Sets the final state at the end of the path.

---

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

• WsfPathList.hpp
• WsfPathList.cpp