All Classes Namespaces Files Functions Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
manifold::rndf::RNDFHeader Class Reference

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

manifold::rndf::RNDFHeader::RNDFHeader ( )

Default constructor.

manifold::rndf::RNDFHeader::~RNDFHeader ( )
default

Destructor.

Member Function Documentation

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

Date.

Get the creation date.

Returns
The creation date.
bool manifold::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]_rndfFileInput file stream.
[in,out]_lineNumberLine 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 manifold::rndf::RNDFHeader::SetDate ( const std::string &  _newDate) const

Set the creation date.

Parameters
[in]_dateThe new creation date.
void manifold::rndf::RNDFHeader::SetVersion ( const std::string &  _version) const

Set the format version.

Parameters
[in]_versionThe new version.
std::string manifold::rndf::RNDFHeader::Version ( ) const

Version.

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

Returns
The format version.

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