TSLWayPointSet Class Reference

Detailed Description

This class encapsulates a collection of TSLWayPoint objects.

Public Member Functions
	TSLWayPointSet ()
	TSLWayPointSet (TSLWayPointSet const &other)
	~TSLWayPointSet ()
TSLWayPointSet &	operator= (TSLWayPointSet const &rhs)
TSLWayPoint *	operator[] (int sequenceNumber)
void	add (TSLWayPoint const &wayPoint)
void	clear ()
bool	empty () const
void	remove (int sequenceNumber)
int	size () const
TSLWayPoint *	wayPoint (int N)
TSLWayPoint const *	wayPoint (int N) const

Constructor & Destructor Documentation

TSLWayPointSet() [1/2]

TSLWayPointSet::TSLWayPointSet

(

)

Default constructor.

TSLWayPointSet() [2/2]

TSLWayPointSet::TSLWayPointSet

(

TSLWayPointSet const &

other

)

Copy constructor.

~TSLWayPointSet()

TSLWayPointSet::~TSLWayPointSet

(

)

Destructor.

Member Function Documentation

add()

void TSLWayPointSet::add

(

TSLWayPoint const &

wayPoint

)

Add a waypoint to the collection.

Parameters

wayPoint

A (const) reference to the waypoint.

The waypoint is always added in sequence order. If another waypoint has the same sequence number, it is replaced.

clear()

void TSLWayPointSet::clear

(

)

Clears the collection.

empty()

bool TSLWayPointSet::empty

(

)

const

Returns true if the collection is empty, false otherwise.

operator=()

TSLWayPointSet & TSLWayPointSet::operator=

(

TSLWayPointSet const &

rhs

)

Assignment operator.

operator[]()

TSLWayPoint * TSLWayPointSet::operator[]

(

int

sequenceNumber

)

Returns a pointer to the waypoint which has the corresponding sequence number.

Parameters

seq	The sequence number of the waypoint.

Returns

a pointer to the waypoint or NULL if no waypoint exists with the given sequence number..

remove()

void TSLWayPointSet::remove

(

int

sequenceNumber

)

Removes from the collection the waypoint with the given sequence number.

Parameters

sequenceNumber

The sequence number of the waypoint that is to be removed.

size()

int TSLWayPointSet::size

(

)

const

Returns the number of waypoints in the collection.

wayPoint() [1/2]

TSLWayPoint * TSLWayPointSet::wayPoint

(

int

N

)

Returns a pointer to the Nth waypoint.

Parameters

N	The index of the waypoint.

Returns

a pointer to the waypoint or NULL if out of bounds.

wayPoint() [2/2]

TSLWayPoint const * TSLWayPointSet::wayPoint

(

int

N

)

const

Returns a pointer to the Nth (const) waypoint.

Parameters

N	The index of the waypoint.

Returns

a pointer to the (const) waypoint or NULL if out of bounds.