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

VCF::VariantDataInputStream Class Reference

The VariantDataInputStream is used to read a VariantData object from an InputStream source. More...

#include <vcf/FoundationKit/VariantDataStream.h>

Inheritance diagram for VCF::VariantDataInputStream:

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

Public Member Functions

 VariantDataInputStream (InputStream *sourceInputStream)
virtual ~VariantDataInputStream ()
virtual void seek (const uint64 &offset, const SeekType &offsetFrom)
virtual uint64 getSize ()
 returns the size of the stream.
virtual uchargetBuffer ()
 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 readVariantData (VariantData *data)

Detailed Description

The VariantDataInputStream is used to read a VariantData object from an InputStream source.


Constructor & Destructor Documentation

VCF::VariantDataInputStream::VariantDataInputStream InputStream sourceInputStream  )  [inline]
 

virtual VCF::VariantDataInputStream::~VariantDataInputStream  )  [inline, virtual]
 


Member Function Documentation

virtual uchar* VCF::VariantDataInputStream::getBuffer  )  [inline, virtual]
 

returns a pointer to the buffer that holds the stream memory

Implements VCF::Stream.

virtual uint64 VCF::VariantDataInputStream::getCurrentSeekPos  )  [inline, virtual]
 

this is a global offset from the beggining of the stream

Implements VCF::Stream.

virtual uint64 VCF::VariantDataInputStream::getSize  )  [inline, 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.

virtual bool VCF::VariantDataInputStream::isEOS  )  [inline, virtual]
 

Implements VCF::InputStream.

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

Implements VCF::InputStream.

void VCF::VariantDataInputStream::readVariantData VariantData data  )  [inline]
 

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

Implements VCF::Stream.


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