openfluid::tools::ColumnTextParser Class Reference

Detailed Description

Class for column file management and handling

#include <tools/ColumnTextParser.hpp>

Public Member Functions
	ColumnTextParser (const std::string &CommentLineSymbol="", const std::string &Delimiter=" \t\r\n")
	~ColumnTextParser ()
bool	loadFromFile (const std::string &Filename)
bool	setFromString (const std::string &Contents, unsigned int ColumnsNbr)
std::string	getValue (unsigned int Line, unsigned int Column) const
bool	getStringValue (unsigned int Line, unsigned int Column, std::string *Value) const
bool	getLongValue (unsigned int Line, unsigned int Column, long *Value) const
bool	getDoubleValue (unsigned int Line, unsigned int Column, double *Value) const
std::vector< std::string >	getValues (unsigned int Line) const
unsigned int	getLinesCount () const
unsigned int	getColsCount () const
void	streamContents (std::ostream &OStream) const

Constructor & Destructor Documentation

ColumnTextParser()

openfluid::tools::ColumnTextParser::ColumnTextParser	(	const std::string &	CommentLineSymbol = "",
		const std::string &	Delimiter = " \t\r\n"
	)

Constructor

~ColumnTextParser()

openfluid::tools::ColumnTextParser::~ColumnTextParser

(

)

Destructor

Member Function Documentation

getColsCount()

unsigned int openfluid::tools::ColumnTextParser::getColsCount ( ) const

inline

Returns the number of columns

Returns

the number of columns

getDoubleValue()

bool openfluid::tools::ColumnTextParser::getDoubleValue	(	unsigned int	Line,
		unsigned int	Column,
		double *	Value
	)		const

Gets the value at a specified row-column, as a double precision float

Parameters

[in]	Line	the line number of the value (first line is 0)
[in]	Column	the column number of the value (first column is 0)
[out]	Value	the requested value if exists

Returns

true if the value has been found, false otherwise

getLinesCount()

unsigned int openfluid::tools::ColumnTextParser::getLinesCount ( ) const

inline

Returns the number of lines

Returns

the number of lines

getLongValue()

bool openfluid::tools::ColumnTextParser::getLongValue	(	unsigned int	Line,
		unsigned int	Column,
		long *	Value
	)		const

Gets the value at a specified row-column, as a long int

Parameters

[in]	Line	the line number of the value (first line is 0)
[in]	Column	the column number of the value (first column is 0)
[out]	Value	the requested value if exists

Returns

true if the value has been found, false otherwise

getStringValue()

bool openfluid::tools::ColumnTextParser::getStringValue	(	unsigned int	Line,
		unsigned int	Column,
		std::string *	Value
	)		const

Gets the value at a specified row-column, as a string

Parameters

[in]	Line	the line number of the value (first line is 0)
[in]	Column	the column number of the value (first column is 0)
[out]	Value	the requested value if exists

Returns

true if the value has been found, false otherwise

getValue()

std::string openfluid::tools::ColumnTextParser::getValue	(	unsigned int	Line,
		unsigned int	Column
	)		const

Returns the value at a specified row-column, as a string

Parameters

[in]	Line	the line number of the value (first line is 0)
[in]	Column	the column number of the value (first column is 0)

Returns

the requested value

getValues()

std::vector<std::string> openfluid::tools::ColumnTextParser::getValues

(

unsigned int

Line

)

const

Returns the values at a specified line

Parameters

[in]

Line

the line number of the value (first line is 0)

Returns

the requested values

loadFromFile()

bool openfluid::tools::ColumnTextParser::loadFromFile

(

const std::string &

Filename

)

Loads a column text file

Parameters

[in]

Filename

the full path of the file to load

Returns

true if everything went fine

setFromString()

bool openfluid::tools::ColumnTextParser::setFromString	(	const std::string &	Contents,
		unsigned int	ColumnsNbr
	)

Parses a one-line delimiter-separated string to set contents ex: "147.2 18 15 25 36 51.3 25.1 15", for 4 columns

Parameters

[in]	Contents	the string to parse
[in]	ColumnsNbr	the number of columns (for splitting the sting into lines)

Returns

true if everything went fine

streamContents()

void openfluid::tools::ColumnTextParser::streamContents

(

std::ostream &

OStream

)

const

---

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

• tools/ColumnTextParser.hpp