Cpl::Io::LineReader Class Reference

This concrete class implements a Line Reader stream using a previously opened Input stream. More...

Detailed Description

This concrete class implements a Line Reader stream using a previously opened Input stream.

#include <LineReader.h>

Inheritance diagram for Cpl::Io::LineReader:

Collaboration diagram for Cpl::Io::LineReader:

Public Member Functions
	LineReader (Input &stream, const char *newline=NewLine::standard())
	Constructor.
bool	readln (Cpl::Text::String &destString)
	See LineReaderApi.
bool	available ()
	See LineReaderApi.
void	close ()
	See LineReaderApi.
Public Member Functions inherited from Cpl::Io::LineReaderApi
virtual	~LineReaderApi ()
	Lets the make the destructor virtual.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Attributes
Input &	m_stream
	Data source.
const char *	m_newline
	Newline.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

LineReader()

Cpl::Io::LineReader::LineReader	(	Input &	stream,
		const char *	newline = NewLine::standard() )

Constructor.

Member Function Documentation

available()

bool Cpl::Io::LineReader::available ( )

virtual

See LineReaderApi.

Implements Cpl::Io::LineReaderApi.

close()

void Cpl::Io::LineReader::close ( )

virtual

See LineReaderApi.

Implements Cpl::Io::LineReaderApi.

readln()

bool Cpl::Io::LineReader::readln ( Cpl::Text::String & destString )

virtual

See LineReaderApi.

Implements Cpl::Io::LineReaderApi.

Member Data Documentation

m_newline

const char* Cpl::Io::LineReader::m_newline

protected

Newline.

m_stream

Input& Cpl::Io::LineReader::m_stream

protected

Data source.

---

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

• Cpl/Io/LineReader.h