cgatools::util::DelimitedLineParser Class Reference

A class that parses delimited lines. More...

Public Types
enum	EmptyFieldHandling { PROCESS_EMPTY_FIELDS = 0, SKIP_EMPTY_FIELDS = 1 }
	Enumeration to describe how empty fields are handled in DelimitedLineParser::parseLine(). More...
typedef std::vector < boost::shared_ptr < DelimitedFieldParser > >	Fields
Public Member Functions
	DelimitedLineParser ()
	Construct a DelimitedLineParser with no fields.
template<class Field >
DelimitedLineParser &	addField (const Field &field)
	Adds another DelimitedFieldParser to this DelimitedLineParser.
template<class Field >
DelimitedLineParser &	setField (size_t offset, const Field &field)
	Overrides the DelimitedFieldParser at a given field offset.
void	parseLine (std::string &line, char delimiter= '\t', EmptyFieldHandling emptyHandling=PROCESS_EMPTY_FIELDS)
	Parses the given line.
const Fields &	getFields () const
	Provides read-only access to the list of currently defined fields.
Friends
class	DelimitedFile

Detailed Description

A class that parses delimited lines.

Enumeration to describe how empty fields are handled in DelimitedLineParser::parseLine().

Enumerator:

PROCESS_EMPTY_FIELDS	Treat empty fields like any other field.
SKIP_EMPTY_FIELDS	Skip empty fields, such that they do not contribute to the field count for the line.

template<class Field >

DelimitedLineParser& cgatools::util::DelimitedLineParser::addField ( const Field & field ) [inline]

The DelimitedFieldParsers must be added in order from left to right.

void cgatools::util::DelimitedLineParser::parseLine	(	std::string &	line,
		char	delimiter = `'\t'`,
		EmptyFieldHandling	emptyHandling = `PROCESS_EMPTY_FIELDS`
	)

Parses the given line.

During processing, the delimiter character is modified to be a null, but the line is returned to its original self when the function returns.

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