Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::BasicInputStream Class Reference

#include <vcf/FoundationKit/BasicOutputStream.h>

Inheritance diagram for VCF::BasicInputStream:

VCF::InputStream VCF::Stream List of all members.

Public Member Functions

 BasicInputStream ()
 BasicInputStream (const String &textBuffer)
 BasicInputStream (const char *dataBuffer, const uint32 &dataBufferSize)
 BasicInputStream (InputStream *inStream)
 This constructor is used in stream chaining.
virtual ~BasicInputStream ()
virtual void seek (const uint64 &offset, const SeekType &offsetFrom)
virtual uint64 getSize ()
 returns the size of the stream.
virtual char * 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 read (unsigned char *bytesToRead, uint64 sizeOfBytes)
virtual bool isEOS ()
void init ()

Constructor & Destructor Documentation

VCF::BasicInputStream::BasicInputStream  ) 
 

VCF::BasicInputStream::BasicInputStream const String textBuffer  ) 
 

VCF::BasicInputStream::BasicInputStream const char *  dataBuffer,
const uint32 dataBufferSize
 

VCF::BasicInputStream::BasicInputStream InputStream inStream  ) 
 

This constructor is used in stream chaining.

The flow goes from the BasicInputStream to the inStream. So if a read is called on the BasicInputStream, it simply passes it to the inStream's read() method

virtual VCF::BasicInputStream::~BasicInputStream  )  [virtual]
 


Member Function Documentation

virtual char* VCF::BasicInputStream::getBuffer  )  [virtual]
 

returns a pointer to the buffer that holds the stream memory

Implements VCF::Stream.

virtual uint64 VCF::BasicInputStream::getCurrentSeekPos  )  [virtual]
 

this is a global offset from the beggining of the stream

Implements VCF::Stream.

virtual uint64 VCF::BasicInputStream::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.

void VCF::BasicInputStream::init  ) 
 

virtual bool VCF::BasicInputStream::isEOS  )  [virtual]
 

Implements VCF::InputStream.

virtual uint64 VCF::BasicInputStream::read unsigned char *  bytesToRead,
uint64  sizeOfBytes
[virtual]
 

Implements VCF::InputStream.

virtual void VCF::BasicInputStream::seek const uint64 offset,
const SeekType offsetFrom
[virtual]
 

Implements VCF::Stream.


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information