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

VCF::BasicOutputStream Class Reference

#include <BasicOutputStream.h>

Inheritance diagram for VCF::BasicOutputStream:

List of all members.

Public Member Functions
	BasicOutputStream ()
	BasicOutputStream (OutputStream *outStream)
	This constructor is used in stream chaining.
virtual	~BasicOutputStream ()
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)
void	init ()
void	clear ()

---

Constructor & Destructor Documentation

VCF::BasicOutputStream::BasicOutputStream (   )

VCF::BasicOutputStream::BasicOutputStream (  OutputStream *  outStream  )

This constructor is used in stream chaining. The flow goes from the BasicOutputStream to the outStream. So if a write is called on the BasicOutputStream, it simply passes it to the outStream's write() method

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

---

Member Function Documentation

void VCF::BasicOutputStream::clear (   )

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

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

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

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

virtual uint64 VCF::BasicOutputStream::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. Reimplemented in VCF::XMLDictOutputStream.

void VCF::BasicOutputStream::init (   )

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

Implements VCF::Stream. Reimplemented in VCF::XMLDictOutputStream.

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

Implements VCF::OutputStream.

---

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

• vcf/FoundationKit/BasicOutputStream.h

Comments or Suggestions?    License Information