ignition::rndf::Waypoint Class Reference

A reference point. More...

#include <Waypoint.hh>

Public Member Functions
	Waypoint ()
	Default constructor. More...
	Waypoint (const int _id, const ignition::math::SphericalCoordinates &_location)
	Constructor. More...
	Waypoint (const Waypoint &_other)
	Copy constructor. More...
virtual	~Waypoint ()
	Destructor. More...
int	Id () const
	Id. More...
bool	Load (std::ifstream &_rndfFile, const int _segmentId, const int _laneId, int &_lineNumber)
	Parsing. More...
ignition::math::SphericalCoordinates &	Location ()
	Location. More...
bool	operator!= (const Waypoint &_other) const
	Inequality. More...
Waypoint &	operator= (const Waypoint &_other)
	Assignment operator. More...
bool	operator== (const Waypoint &_other) const
	Operators. More...
bool	SetId (const int _id)
	Set the identifier of the waypoint. More...
bool	Valid () const
	Validation. More...

Detailed Description

A reference point.

Constructor & Destructor Documentation

ignition::rndf::Waypoint::Waypoint

(

)

Default constructor.

ignition::rndf::Waypoint::Waypoint	(	const int	_id,
		const ignition::math::SphericalCoordinates &	_location
	)

Constructor.

Parameters

[in]	_id	Waypoint Id (a positive number).
[in]	_location	Location of the waypoint in decimal-degrees, using ITRF00 reference frame and the GRS80 ellipsoid.

See also

Valid.

ignition::rndf::Waypoint::Waypoint

(

const Waypoint &

_other

)

Copy constructor.

Parameters

[in]

_other

Other waypoint.

virtual ignition::rndf::Waypoint::~Waypoint ( )

virtual

Destructor.

Member Function Documentation

int ignition::rndf::Waypoint::Id

(

)

const

Id.

Get the unique identifier of the waypoint.

Returns

The waypoint Id.

bool ignition::rndf::Waypoint::Load	(	std::ifstream &	_rndfFile,
		const int	_segmentId,
		const int	_laneId,
		int &	_lineNumber
	)

Parsing.

Load a waypoint from an input stream coming from a text file. The expected format is the one specified on the RNDF spec.

Parameters

[in,out]	_rndfFile	Input file stream.
[in]	_segmentId	The segment Id in which the waypoint is located.
[in]	_laneId	The lane Id in which the waypoint is located.
[in,out]	_lineNumber	Line number pointed by the stream position indicator.

Returns

True if a waypoint block was found and parsed or false otherwise (e.g.: EoF or incorrect format found).

ignition::math::SphericalCoordinates& ignition::rndf::Waypoint::Location

(

)

Location.

Get a mutable reference to the waypoint location.

Returns

A mutable reference to the waypoint location.

bool ignition::rndf::Waypoint::operator!=

(

const Waypoint &

_other

)

const

Inequality.

Parameters

[in]

_other

Waypoint to check for inequality.

Returns

true if this != _other

Waypoint& ignition::rndf::Waypoint::operator=

(

const Waypoint &

_other

)

Assignment operator.

Parameters

[in]

_other

The new Waypoint.

Returns

A reference to this instance.

bool ignition::rndf::Waypoint::operator==

(

const Waypoint &

_other

)

const

Operators.

Equality operator, result = this == _other

Parameters

[in]

_other

Waypoint to check for equality.

Returns

true if this == _other

bool ignition::rndf::Waypoint::SetId

(

const int

_id

)

Set the identifier of the waypoint.

Parameters

[in]

_id

New unique Id.

Returns

True if the operation succeed or false otherwise. If the Id is not valid, the operation won't have any effect.

bool ignition::rndf::Waypoint::Valid

(

)

const

Validation.

Returns

True if the waypoint Id is valid. A valid waypoint Id is a positive number.

---

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

• Waypoint.hh