An internal private RNDF header class. More...

#include <RNDF.hh>

Public Member Functions
	RNDFHeader ()
	Default constructor. More...

	~RNDFHeader ()=default
	Destructor. More...

std::string	Date () const
	Date. More...

bool	Load (std::ifstream &_rndfFile, int &_lineNumber)
	Parsing. More...

void	SetDate (const std::string &_newDate) const
	Set the creation date. More...

void	SetVersion (const std::string &_version) const
	Set the format version. More...

std::string	Version () const
	Version. More...

Detailed Description

An internal private RNDF header class.

Constructor & Destructor Documentation

ignition::rndf::RNDFHeader::RNDFHeader ( )

Default constructor.

ignition::rndf::RNDFHeader::~RNDFHeader ( )

default

Destructor.

std::string ignition::rndf::RNDFHeader::Date ( ) const

Date.

Get the creation date.

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

Parsing.

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

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

void ignition::rndf::RNDFHeader::SetDate ( const std::string & _newDate ) const

Set the creation date.

Parameters

[in] _newDate The new creation date.

void ignition::rndf::RNDFHeader::SetVersion ( const std::string & _version ) const

Set the format version.

Parameters

[in] _version The new version.

std::string ignition::rndf::RNDFHeader::Version ( ) const

Version.

Get the format version. E.g.: "2.3.6".

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