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

An internal private segment header class. More...

#include <Segment.hh>

Public Member Functions

 SegmentHeader ()
 Default constructor. More...
 
 ~SegmentHeader ()=default
 Destructor. More...
 
bool Load (std::ifstream &_rndfFile, const int _segmentId, int &_lineNumber)
 Parsing. More...
 
std::string Name () const
 Name. More...
 
void SetName (const std::string &_name) const
 Set the segment name. More...
 

Detailed Description

An internal private segment header class.

Constructor & Destructor Documentation

manifold::rndf::SegmentHeader::SegmentHeader ( )

Default constructor.

manifold::rndf::SegmentHeader::~SegmentHeader ( )
default

Destructor.

Member Function Documentation

bool manifold::rndf::SegmentHeader::Load ( std::ifstream &  _rndfFile,
const int  _segmentId,
int &  _lineNumber 
)

Parsing.

Load a segment 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]_segmentIdThe next expected segment Id.
[in,out]_lineNumberLine number pointed by the stream position indicator.
Returns
True if a segment header block was found and parsed or false otherwise (e.g.: EoF or incorrect format found).
std::string manifold::rndf::SegmentHeader::Name ( ) const

Name.

Get the segment name. E.g.: "Wisconsin_Ave".

Returns
The segment name.
void manifold::rndf::SegmentHeader::SetName ( const std::string &  _name) const

Set the segment name.

E.g.: "Wisconsin_Ave".

Parameters
[in]_nameThe new name.

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