ignition::rndf::RNDFNode Class Reference

An RNDF node class. More...

#include <RNDFNode.hh>

Public Member Functions
	RNDFNode ()
	Default constructor. More...
	RNDFNode (const rndf::UniqueId &_id)
	Default constructor. More...
	RNDFNode (const RNDFNode &_other)
	Copy constructor. More...
virtual	~RNDFNode ()
	Destructor. More...
rndf::Lane *	Lane () const
	Get the pointer to the lane where the waypoint is contained. More...
bool	operator!= (const RNDFNode &_other) const
	Inequality. More...
RNDFNode &	operator= (const RNDFNode &_other)
	Assignment operator. More...
bool	operator== (const RNDFNode &_other) const
	Operators. More...
rndf::Segment *	Segment () const
	Get the pointer to the segment where the waypoint is contained. More...
void	SetLane (rndf::Lane *_lane)
	Set the pointer to the lane that contains the waypoint. More...
void	SetSegment (rndf::Segment *_segment)
	Set the pointer to the segment that contains the waypoint. More...
void	SetUniqueId (const rndf::UniqueId &_id)
	Set the unique unique Id. More...
void	SetWaypoint (rndf::Waypoint *_waypoint)
	Set the pointer to the waypoint associated with the given unique Id passed in the constructor. More...
void	SetZone (rndf::Zone *_zone)
	Set the pointer to the zone that contains the waypoint. More...
rndf::UniqueId &	UniqueId () const
	Get the Unique Id of the RNDF node. More...
rndf::Waypoint *	Waypoint () const
	Get the pointer to the waypoint with the stored unique Id. More...
rndf::Zone *	Zone () const
	Get the pointer to the zone where the waypoint is contained. More...

Detailed Description

An RNDF node class.

Stores all the information associated with a given a unique Id .

Constructor & Destructor Documentation

ignition::rndf::RNDFNode::RNDFNode

(

)

Default constructor.

See also

Valid.

ignition::rndf::RNDFNode::RNDFNode ( const rndf::UniqueId &  _id )

explicit

Default constructor.

Parameters

[in]

_id

A unique Id.

ignition::rndf::RNDFNode::RNDFNode ( const RNDFNode &  _other )

explicit

Copy constructor.

Parameters

[in]

_other

Other RNDFNode.

virtual ignition::rndf::RNDFNode::~RNDFNode ( )

virtual

Destructor.

Member Function Documentation

rndf::Lane* ignition::rndf::RNDFNode::Lane

(

)

const

Get the pointer to the lane where the waypoint is contained.

Returns

Pointer to the lane or nullptr if not possible (e.g. if the waypoint belongs to a zone).

bool ignition::rndf::RNDFNode::operator!=

(

const RNDFNode &

_other

)

const

Inequality.

Parameters

[in]

_other

RNDFNode to check for inequality.

Returns

true if this != _other

RNDFNode& ignition::rndf::RNDFNode::operator=

(

const RNDFNode &

_other

)

Assignment operator.

Parameters

[in]

_other

The new RNDFNode.

Returns

A reference to this instance.

bool ignition::rndf::RNDFNode::operator==

(

const RNDFNode &

_other

)

const

Operators.

Equality operator, result = this == _other

Parameters

[in]

_other

RNDFNode to check for equality.

Returns

true if this == _other

rndf::Segment* ignition::rndf::RNDFNode::Segment

(

)

const

Get the pointer to the segment where the waypoint is contained.

Returns

Pointer to the segment or nullptr if not possible (e.g. if the waypoint belongs to a zone).

void ignition::rndf::RNDFNode::SetLane

(

rndf::Lane *

_lane

)

Set the pointer to the lane that contains the waypoint.

Parameters

[in]

_lane

Pointer to the lane that contains the waypoint or nullpr if there's no lane (e.g. ig the waypoint belongs to a zone).

void ignition::rndf::RNDFNode::SetSegment

(

rndf::Segment *

_segment

)

Set the pointer to the segment that contains the waypoint.

Parameters

[in]

_segment

Pointer to the segment that contains the waypoint or nullpr if there's no segment (e.g. ig the waypoint belongs to a zone).

void ignition::rndf::RNDFNode::SetUniqueId

(

const rndf::UniqueId &

_id

)

Set the unique unique Id.

Parameters

[in]

_id

Unique Id of the node.

void ignition::rndf::RNDFNode::SetWaypoint

(

rndf::Waypoint *

_waypoint

)

Set the pointer to the waypoint associated with the given unique Id passed in the constructor.

Parameters

[in]

_segment

Pointer to the waypoint with the given unique Id passed in the constructor or null not possible (e.g. if the Id

void ignition::rndf::RNDFNode::SetZone

(

rndf::Zone *

_zone

)

Set the pointer to the zone that contains the waypoint.

Parameters

[in]

_zone

Pointer to the zone that contains the waypoint or nullpr if there's no zone (e.g. ig the waypoint belongs to a segment).

rndf::UniqueId& ignition::rndf::RNDFNode::UniqueId

(

)

const

Get the Unique Id of the RNDF node.

Returns

The Unique Id.

rndf::Waypoint* ignition::rndf::RNDFNode::Waypoint

(

)

const

Get the pointer to the waypoint with the stored unique Id.

Returns

Pointer to the waypoint or nullptr if not possible (e.g. if the Id passed in the constructor was incorrect).

rndf::Zone* ignition::rndf::RNDFNode::Zone

(

)

const

Get the pointer to the zone where the waypoint is contained.

Returns

Pointer to the zone or nullptr if not possible (e.g. if the waypoint belongs to a segment).

---

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

• RNDFNode.hh