openfluid::tools::ProgressiveColumnFileReader Class Reference

Detailed Description

Progressive reader for column text files

#include <tools/ProgressiveColumnFileReader.hpp>

Public Member Functions
	ProgressiveColumnFileReader (const std::string &FileName, const std::string &ColSeparators=" \t\r\n")
virtual	~ProgressiveColumnFileReader ()
bool	getNextLine (std::string &Line)
bool	getNextLine (std::vector< std::string > &Values)
void	reset ()
std::string	getFileName () const

Protected Attributes
std::string	m_FileName
std::string	m_ColSeparators

Inheritance diagram for openfluid::tools::ProgressiveColumnFileReader:

Constructor & Destructor Documentation

ProgressiveColumnFileReader()

openfluid::tools::ProgressiveColumnFileReader::ProgressiveColumnFileReader	(	const std::string &	FileName,
		const std::string &	ColSeparators = " \t\r\n"
	)

Constructor

Parameters

[in]	FileName	the file to open
[in]	ColSeparators	a list of columns separators. Default value is " \t\r\n"

~ProgressiveColumnFileReader()

virtual openfluid::tools::ProgressiveColumnFileReader::~ProgressiveColumnFileReader ( )

inlinevirtual

Member Function Documentation

getFileName()

std::string openfluid::tools::ProgressiveColumnFileReader::getFileName ( ) const

inline

Returns the file name

Returns

the file name

getNextLine() [1/2]

bool openfluid::tools::ProgressiveColumnFileReader::getNextLine

(

std::string &

Line

)

Gets the next line of data in the file, as a single string

Parameters

[out]

Line

the read line

Returns

true if the next line has been read, false otherwise

getNextLine() [2/2]

bool openfluid::tools::ProgressiveColumnFileReader::getNextLine

(

std::vector< std::string > &

Values

)

Gets the next line of data in the file, as a vector of strings

Parameters

[out]

Values

the vector of read values

Returns

true if the next line has been read and splitted into a vector of strings, false otherwise

reset()

void openfluid::tools::ProgressiveColumnFileReader::reset

(

)

Resets the internal iterator of the file

Member Data Documentation

m_ColSeparators

std::string openfluid::tools::ProgressiveColumnFileReader::m_ColSeparators

protected

m_FileName

std::string openfluid::tools::ProgressiveColumnFileReader::m_FileName

protected

---

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

• tools/ProgressiveColumnFileReader.hpp