ignition::rndf::Zone Class Reference

An abstraction for representing areas within free vehicle movement is permitted. More...

#include <Zone.hh>

Public Member Functions
	Zone ()
	Default constructor. More...
	Zone (const int _id)
	Constructor. More...
	Zone (const Zone &_other)
	Copy constructor. More...
virtual	~Zone ()
	Destructor. More...
bool	AddSpot (const ParkingSpot &_newSpot)
	Add a new parking spot. More...
int	Id () const
	Id. More...
bool	Load (std::ifstream &_rndfFile, int &_lineNumber)
	Parsing. More...
std::string	Name () const
	Name. More...
unsigned int	NumSpots () const
	Parking spots. More...
bool	operator!= (const Zone &_other) const
	Inequality. More...
Zone &	operator= (const Zone &_other)
	Assignment operator. More...
bool	operator== (const Zone &_other) const
	Operators. More...
rndf::Perimeter &	Perimeter ()
	Perimeter. More...
const rndf::Perimeter &	Perimeter () const
	Get the perimeter. More...
bool	RemoveSpot (const int _psId)
	Remove an existing parking spot. More...
bool	SetId (const int _id)
	Set the identifier of the zone. More...
void	SetName (const std::string &_name) const
	Set the zone name. More...
bool	Spot (const int _psId, ParkingSpot &_ps) const
	Get the details of one of the parking spots with Id _psId. More...
std::vector< ParkingSpot > &	Spots ()
	Get a mutable reference to the vector of parking spots. More...
const std::vector< ParkingSpot > &	Spots () const
	Get the vector of parking spots. More...
bool	UpdateSpot (const ParkingSpot &_ps)
	Update an existing parking spot. More...
bool	Valid () const
	Validation. More...

Detailed Description

An abstraction for representing areas within free vehicle movement is permitted.

The zone is determined by a polygonal boundary defined by perimeter points. Some perimeter points are identified as entry and exit points into the zone area. A zone may also include one or more parking spots, each specified by a pair of waypoints.

Constructor & Destructor Documentation

ignition::rndf::Zone::Zone ( )

explicit

Default constructor.

See also

Valid.

ignition::rndf::Zone::Zone ( const int  _id )

explicit

Constructor.

Parameters

[in]

_id

Zone Id (a positive number).

See also

Valid.

ignition::rndf::Zone::Zone

(

const Zone &

_other

)

Copy constructor.

Parameters

[in]

_other

Other zone to copy from.

See also

Valid.

virtual ignition::rndf::Zone::~Zone ( )

virtual

Destructor.

Member Function Documentation

bool ignition::rndf::Zone::AddSpot

(

const ParkingSpot &

_newSpot

)

Add a new parking spot.

Parameters

[in]

_newSpot

A new spot to be added.

Returns

True when the parking spot was successfully added to the list or false otherwise (e.g. if the Id of the spot was already existing or invalid).

int ignition::rndf::Zone::Id

(

)

const

Id.

Get the unique identifier of the zone.

Returns

The zone Id.

bool ignition::rndf::Zone::Load	(	std::ifstream &	_rndfFile,
		int &	_lineNumber
	)

Parsing.

Load a zone 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,out]	_lineNumber	Line number pointed by the stream position indicator.

Returns

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

std::string ignition::rndf::Zone::Name

(

)

const

Name.

Get the zone name. E.g.: "North_parking_lot".

Returns

The zone name.

unsigned int ignition::rndf::Zone::NumSpots

(

)

const

Parking spots.

Get the number of parking spots stored.

Returns

The number of parking spots in the current zone.

bool ignition::rndf::Zone::operator!=

(

const Zone &

_other

)

const

Inequality.

Parameters

[in]

_other

Zone to check for inequality.

Returns

true if this != _other

Zone& ignition::rndf::Zone::operator=

(

const Zone &

_other

)

Assignment operator.

Parameters

[in]

_other

The new zone.

Returns

A reference to this instance.

bool ignition::rndf::Zone::operator==

(

const Zone &

_other

)

const

Operators.

Equality operator, result = this == _other

Parameters

[in]

_other

Zone to check for equality.

Returns

true if this == _other

rndf::Perimeter& ignition::rndf::Zone::Perimeter

(

)

Perimeter.

Get a mutable reference to the perimeter.

Returns

A mutable reference to the perimeter.

const rndf::Perimeter& ignition::rndf::Zone::Perimeter

(

)

const

Get the perimeter.

Returns

The perimeter.

bool ignition::rndf::Zone::RemoveSpot

(

const int

_psId

)

Remove an existing parking spot.

Parameters

[in]

_psId

The parking spot Id to be removed.

Returns

True when the sopt was successfully deleted from the list or false otherwise (e.g. if the Id of the waypoint was not found or invalid).

bool ignition::rndf::Zone::SetId

(

const int

_id

)

Set the identifier of the zone.

Parameters

[in]

_id

New unique Id.

Returns

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

void ignition::rndf::Zone::SetName

(

const std::string &

_name

)

const

Set the zone name.

E.g.: "North_parking_lot".

Parameters

[in]

_name

The new name.

bool ignition::rndf::Zone::Spot	(	const int	_psId,
		ParkingSpot &	_ps
	)		const

Get the details of one of the parking spots with Id _psId.

Parameters

[in]	_psId	The parking spot Id.
[out]	_ps	The parking spot requested.

Returns

True if the parking spot was found or false otherwise.

std::vector<ParkingSpot>& ignition::rndf::Zone::Spots

(

)

Get a mutable reference to the vector of parking spots.

Returns

A mutable reference to the vector of parking spots.

const std::vector<ParkingSpot>& ignition::rndf::Zone::Spots

(

)

const

Get the vector of parking spots.

Returns

The vector of parking spots.

bool ignition::rndf::Zone::UpdateSpot

(

const ParkingSpot &

_ps

)

Update an existing parking spot.

Parameters

[in]

_ps

The updated parking spot.

Returns

True if the spot was found and updated or false otherwise.

bool ignition::rndf::Zone::Valid

(

)

const

Validation.

Whether the current object is valid or not.

Returns

True if the zone is valid.

---

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

• Zone.hh