Cpl::Io::LineWriter Class Reference

This concrete class implements a Line Writer stream using a previously opened Output stream. More...

Detailed Description

This concrete class implements a Line Writer stream using a previously opened Output stream.

NOTE: The LineWriter class does NOT provide any multi-thread mechanisms and/or protections. In addition, using an instance of the AtomicOutputApi interface as the underlying Output stream will NOT make output of the println() calls atomic! The intended way to have an 'Atomic' LineWriter is to use the AtomicOutput callback mechanism (i.e. requestOutputs()) and within the callback create the desired LineWriter using the supplied Output stream.

#include <LineWriter.h>

Inheritance diagram for Cpl::Io::LineWriter:

Collaboration diagram for Cpl::Io::LineWriter:

Public Member Functions
	LineWriter (Output &stream, const char *newline=NewLine::standard())
	Constructor.
bool	print (const char *srcstring)
	See LineWriterApi.
bool	println (const char *srcstring)
	See LineWriterApi.
bool	println ()
	See LineWriterApi.
bool	print (const char *srcstring, int numbytes)
	See LineWriterApi.
bool	println (const char *srcstring, int numbytes)
	See LineWriterApi.
bool	print (Cpl::Text::String &formatBuffer, const char *format,...)
	See LineWriterApi.
bool	println (Cpl::Text::String &formatBuffer, const char *format,...)
	See LineWriterApi.
bool	vprint (Cpl::Text::String &formatBuffer, const char *format, va_list ap)
	See LineWriterApi.
bool	vprintln (Cpl::Text::String &formatBuffer, const char *format, va_list ap)
	See LineWriterApi.
void	flush ()
	See LineWriterApi.
void	close ()
	See LineWriterApi.
Public Member Functions inherited from Cpl::Io::LineWriterApi
virtual	~LineWriterApi ()
	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
Output &	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

LineWriter()

Cpl::Io::LineWriter::LineWriter	(	Output &	stream,
		const char *	newline = NewLine::standard()
	)

Constructor.

Member Function Documentation

close()

void Cpl::Io::LineWriter::close ( )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

flush()

void Cpl::Io::LineWriter::flush ( )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

print() [1/3]

bool Cpl::Io::LineWriter::print ( const char *  srcstring )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

print() [2/3]

bool Cpl::Io::LineWriter::print ( const char *  srcstring, int  numbytes  )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

print() [3/3]

bool Cpl::Io::LineWriter::print ( Cpl::Text::String &  formatBuffer, const char *  format,   ...  )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

println() [1/4]

bool Cpl::Io::LineWriter::println ( )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

println() [2/4]

bool Cpl::Io::LineWriter::println ( const char *  srcstring )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

println() [3/4]

bool Cpl::Io::LineWriter::println ( const char *  srcstring, int  numbytes  )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

println() [4/4]

bool Cpl::Io::LineWriter::println ( Cpl::Text::String &  formatBuffer, const char *  format,   ...  )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

vprint()

bool Cpl::Io::LineWriter::vprint ( Cpl::Text::String &  formatBuffer, const char *  format, va_list  ap  )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

vprintln()

bool Cpl::Io::LineWriter::vprintln ( Cpl::Text::String &  formatBuffer, const char *  format, va_list  ap  )

virtual

See LineWriterApi.

Implements Cpl::Io::LineWriterApi.

Member Data Documentation

m_newline

const char* Cpl::Io::LineWriter::m_newline

protected

Newline.

m_stream

Output& Cpl::Io::LineWriter::m_stream

protected

Data source.

---

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

• Cpl/Io/LineWriter.h