manifold::rndf::Checkpoint Class Reference

A checkpoint is a waypoint that has to be visited. More...

#include <Checkpoint.hh>

Public Member Functions
	Checkpoint ()
	Default constructor. More...
	Checkpoint (const int _checkpointId, const int _waypointId)
	Constructor. More...
	Checkpoint (const Checkpoint &_other)
	Copy constructor. More...
virtual	~Checkpoint ()
	Destructor. More...
int	CheckpointId () const
	Get the checkpoint Id. More...
bool	operator!= (const Checkpoint &_other) const
	Inequality. More...
Checkpoint &	operator= (const Checkpoint &_other)
	Assignment operator. More...
bool	operator== (const Checkpoint &_other) const
	Equality operator, result = this == _other. More...
bool	SetCheckpointId (const int _id)
	Set the identifier of the checkpoint. More...
bool	SetWaypointId (const int _id)
	Set the identifier of the waypoint. More...
bool	Valid () const
int	WaypointId () const
	Get the waypoint Id. More...

Detailed Description

A checkpoint is a waypoint that has to be visited.

It also has its own Id.

Constructor & Destructor Documentation

manifold::rndf::Checkpoint::Checkpoint

(

)

Default constructor.

manifold::rndf::Checkpoint::Checkpoint ( const int  _checkpointId, const int  _waypointId  )

explicit

Constructor.

Parameters

[in]	_checkpointId	Checkpoint Id (a positive number).
[in]	_waypointId	The waypoint Id associated to the checkpoint.

See Also

Valid.

manifold::rndf::Checkpoint::Checkpoint

(

const Checkpoint &

_other

)

Copy constructor.

Parameters

[in]

_other

Other checkpoint.

virtual manifold::rndf::Checkpoint::~Checkpoint ( )

virtual

Destructor.

Member Function Documentation

int manifold::rndf::Checkpoint::CheckpointId

(

)

const

Get the checkpoint Id.

Returns

The checkpoint Id.

bool manifold::rndf::Checkpoint::operator!=

(

const Checkpoint &

_other

)

const

Inequality.

Parameters

[in]

_other

Checkpoint to check for inequality

Returns

true if this != _other

Checkpoint& manifold::rndf::Checkpoint::operator=

(

const Checkpoint &

_other

)

Assignment operator.

Parameters

[in]

_other

The new checkpoint.

Returns

A reference to this instance.

bool manifold::rndf::Checkpoint::operator==

(

const Checkpoint &

_other

)

const

Equality operator, result = this == _other.

Parameters

[in]

_other

Checkpoint to check for equality

Returns

true if this == _other

bool manifold::rndf::Checkpoint::SetCheckpointId

(

const int

_id

)

Set the identifier of the checkpoint.

Parameters

[in]

_id

New unique Id.

Returns

True if the operation succeed or false otherwise (e.g.: if the id is not valid).

See Also

Valid.

bool manifold::rndf::Checkpoint::SetWaypointId

(

const int

_id

)

Set the identifier of the waypoint.

Parameters

[in]

_id

New unique Id.

Returns

True if the operation succeed or false otherwise (e.g.: if the id is not valid).

See Also

Valid.

bool manifold::rndf::Checkpoint::Valid

(

)

const

Returns

True if the checkpoint is valid.

int manifold::rndf::Checkpoint::WaypointId

(

)

const

Get the waypoint Id.

Returns

The waypoint Id.

---

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

• Checkpoint.hh