WossWpPosition::WayPoint Class Reference

#include <uw-woss-waypoint-position.h>

Collaboration diagram for WossWpPosition::WayPoint:

Public Member Functions
	WayPoint (const woss::CoordZ &destination, double speed=0.0, double time=HUGE_VAL, int loop_id=INT_MAX, int total_loops=0)
void	setDestination (const woss::CoordZ &dest)
void	setSpeed (double s)
void	setTimeToWait (double t)
void	setLoopId (int id)
void	setTotalLoops (int loops)
const woss::CoordZ &	getDestination () const
double	getSpeed () const
double	getTimeToWait () const
int	getLoopId () const
int	getTotalLoops () const
bool	isValid () const
bool	hasToLoop () const
bool	hasToWait () const
bool	hasToStop () const
virtual double	getTimeOfArrival (const WayPoint &dest_waypoint) const
virtual woss::CoordZ	getCurrentPosition (const WayPoint &dest_waypoint, double time_elapsed) const

Protected Attributes
woss::CoordZ	destination
double	speed
double	time_to_wait
int	loop_to_waypoint_id
int	total_loops

Friends
std::ostream &	operator<< (std::ostream &os, const WayPoint &instance)

Constructor & Destructor Documentation

WayPoint()

WossWpPosition::WayPoint::WayPoint	(	const woss::CoordZ &	destination,
		double	speed = 0.0,
		double	time = HUGE_VAL,
		int	loop_id = INT_MAX,
		int	total_loops = 0 )

References destination, loop_to_waypoint_id, speed, time_to_wait, and total_loops.

Referenced by getCurrentPosition(), getTimeOfArrival(), and operator<<.

Member Function Documentation

getCurrentPosition()

woss::CoordZ WossWpPosition::WayPoint::getCurrentPosition ( const WayPoint & dest_waypoint, double time_elapsed ) const

virtual

References destination, woss::CoordZ::getCoordZAlongGreatCircle(), speed, time_to_wait, and WayPoint().

Here is the call graph for this function:

getDestination()

const woss::CoordZ & WossWpPosition::WayPoint::getDestination ( ) const

inline

References destination.

Referenced by getTimeOfArrival().

getLoopId()

int WossWpPosition::WayPoint::getLoopId ( ) const

inline

References loop_to_waypoint_id.

Referenced by WossWpPosition::addLoopPoint().

getSpeed()

double WossWpPosition::WayPoint::getSpeed ( ) const

inline

References speed.

Referenced by WossWpPosition::addLoopPoint().

getTimeOfArrival()

double WossWpPosition::WayPoint::getTimeOfArrival ( const WayPoint & dest_waypoint ) const

virtual

References destination, woss::CoordZ::getDepth(), getDestination(), speed, time_to_wait, and WayPoint().

Here is the call graph for this function:

getTimeToWait()

double WossWpPosition::WayPoint::getTimeToWait ( ) const

inline

References time_to_wait.

getTotalLoops()

int WossWpPosition::WayPoint::getTotalLoops ( ) const

inline

References total_loops.

Referenced by WossWpPosition::addLoopPoint().

hasToLoop()

bool WossWpPosition::WayPoint::hasToLoop ( ) const

inline

References loop_to_waypoint_id, and total_loops.

hasToStop()

bool WossWpPosition::WayPoint::hasToStop ( ) const

inline

References speed, and time_to_wait.

hasToWait()

bool WossWpPosition::WayPoint::hasToWait ( ) const

inline

References speed, and time_to_wait.

isValid()

bool WossWpPosition::WayPoint::isValid ( ) const

inline

References destination, speed, and time_to_wait.

setDestination()

void WossWpPosition::WayPoint::setDestination ( const woss::CoordZ & dest )

inline

References destination.

setLoopId()

void WossWpPosition::WayPoint::setLoopId ( int id )

inline

References loop_to_waypoint_id.

setSpeed()

void WossWpPosition::WayPoint::setSpeed ( double s )

inline

References speed.

setTimeToWait()

void WossWpPosition::WayPoint::setTimeToWait ( double t )

inline

References time_to_wait.

setTotalLoops()

void WossWpPosition::WayPoint::setTotalLoops ( int loops )

inline

References total_loops.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & os, const WayPoint & instance )

friend

References destination, loop_to_waypoint_id, speed, time_to_wait, total_loops, and WayPoint().

Member Data Documentation

destination

woss::CoordZ WossWpPosition::WayPoint::destination

protected

Referenced by getCurrentPosition(), getDestination(), getTimeOfArrival(), isValid(), operator<<, setDestination(), and WayPoint().

loop_to_waypoint_id

int WossWpPosition::WayPoint::loop_to_waypoint_id

protected

Referenced by getLoopId(), hasToLoop(), operator<<, setLoopId(), and WayPoint().

speed

double WossWpPosition::WayPoint::speed

protected

Referenced by getCurrentPosition(), getSpeed(), getTimeOfArrival(), hasToStop(), hasToWait(), isValid(), operator<<, setSpeed(), and WayPoint().

time_to_wait

double WossWpPosition::WayPoint::time_to_wait

protected

Referenced by getCurrentPosition(), getTimeOfArrival(), getTimeToWait(), hasToStop(), hasToWait(), isValid(), operator<<, setTimeToWait(), and WayPoint().

total_loops

int WossWpPosition::WayPoint::total_loops

protected

Referenced by getTotalLoops(), hasToLoop(), operator<<, setTotalLoops(), and WayPoint().

---

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

• woss_phy/uw-woss-waypoint-position.h
• woss_phy/uw-woss-waypoint-position.cpp