ignition::rndf::ZoneHeader Class Reference

#include <Zone.hh>

Public Member Functions
	ZoneHeader ()
	Default constructor. More...
	~ZoneHeader ()=default
	Destructor. More...
bool	Load (std::ifstream &_rndfFile, const int _zoneId, int &_lineNumber)
	Parsing. More...
std::string	Name () const
	Name. More...
void	SetName (const std::string &_name) const
	Set the zone name. More...

Constructor & Destructor Documentation

ignition::rndf::ZoneHeader::ZoneHeader

(

)

Default constructor.

ignition::rndf::ZoneHeader::~ZoneHeader ( )

default

Destructor.

Member Function Documentation

bool ignition::rndf::ZoneHeader::Load	(	std::ifstream &	_rndfFile,
		const int	_zoneId,
		int &	_lineNumber
	)

Parsing.

Load a zone header 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]	_zoneId	The expected zone Id.
[in,out]	_lineNumber	Line number pointed by the stream position indicator.

Returns

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

std::string ignition::rndf::ZoneHeader::Name

(

)

const

Name.

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

Returns

The zone name.

void ignition::rndf::ZoneHeader::SetName

(

const std::string &

_name

)

const

Set the zone name.

E.g.: "North_parking_lot".

Parameters

[in]

_name

The new name.

---

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

• Zone.hh