The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::TextOutputStream Class Reference

The TextOutputStream is used for writing data from another stream as text. More...

#include <vcf/FoundationKit/TextOutputStream.h>

Inheritance diagram for VCF::TextOutputStream:

List of all members.

Public Member Functions
	TextOutputStream (OutputStream *outStream)
	TextOutputStream ()
virtual	~TextOutputStream ()
virtual void	seek (const uint64 &offset, const SeekType &offsetFrom)
virtual uint64	getSize ()
	returns the size of the stream.
virtual uchar *	getBuffer ()
	returns a pointer to the buffer that holds the stream memory
virtual uint64	getCurrentSeekPos ()
	this is a global offset from the beggining of the stream
virtual uint64	write (const unsigned char *bytesToRead, uint64 sizeOfBytes)
virtual void	write (const short &val)
	all numbers are written out as the number converted to text, followed by a space character ( ' ' ), so the value 2 becomes "2 "
virtual void	write (const long &val)
virtual void	write (const int &val)
virtual void	write (const bool &val)
virtual void	write (const float &val)
virtual void	write (const double &val)
virtual void	write (const String &val)
virtual void	write (Persistable *val)
void	init ()
void	writeLine (const String &line)
String	getTextBuffer ()
virtual String	toString () const

---

Detailed Description

The TextOutputStream is used for writing data from another stream as text.

---

Constructor & Destructor Documentation

VCF::TextOutputStream::TextOutputStream (  OutputStream *  outStream  )

VCF::TextOutputStream::TextOutputStream (   )

virtual VCF::TextOutputStream::~TextOutputStream (   )  [virtual]

---

Member Function Documentation

virtual uchar* VCF::TextOutputStream::getBuffer (   )  [virtual]

returns a pointer to the buffer that holds the stream memory Implements VCF::Stream.

virtual uint64 VCF::TextOutputStream::getCurrentSeekPos (   )  [virtual]

this is a global offset from the beggining of the stream Implements VCF::Stream.

virtual uint64 VCF::TextOutputStream::getSize (   )  [virtual]

returns the size of the stream. The size represents the number of bytes that have been written, or read to/from the stream Implements VCF::Stream.

String VCF::TextOutputStream::getTextBuffer (   )

void VCF::TextOutputStream::init (   )

virtual void VCF::TextOutputStream::seek (  const uint64 &  offset, const SeekType &  offsetFrom )  [virtual]

Implements VCF::Stream.

virtual String VCF::TextOutputStream::toString (   )  const [virtual]

virtual void VCF::TextOutputStream::write (  Persistable *  val  )  [inline, virtual]

Reimplemented from VCF::OutputStream.

virtual void VCF::TextOutputStream::write (  const String &  val  )  [virtual]

Reimplemented from VCF::OutputStream.

virtual void VCF::TextOutputStream::write (  const double &  val  )  [virtual]

Reimplemented from VCF::OutputStream.

virtual void VCF::TextOutputStream::write (  const float &  val  )  [virtual]

Reimplemented from VCF::OutputStream.

virtual void VCF::TextOutputStream::write (  const bool &  val  )  [virtual]

Reimplemented from VCF::OutputStream.

virtual void VCF::TextOutputStream::write (  const int &  val  )  [virtual]

Reimplemented from VCF::OutputStream.

virtual void VCF::TextOutputStream::write (  const long &  val  )  [virtual]

Reimplemented from VCF::OutputStream.

virtual void VCF::TextOutputStream::write (  const short &  val  )  [virtual]

all numbers are written out as the number converted to text, followed by a space character ( ' ' ), so the value 2 becomes "2 " Reimplemented from VCF::OutputStream.

virtual uint64 VCF::TextOutputStream::write (  const unsigned char *  bytesToRead, uint64  sizeOfBytes )  [virtual]

Implements VCF::OutputStream.

void VCF::TextOutputStream::writeLine (  const String &  line  )

---

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

• vcf/FoundationKit/TextOutputStream.h

Comments or Suggestions?    License Information