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

VCF::FileInputStream Class Reference

#include <vcf/FoundationKit/FileStream.h>

Inheritance diagram for VCF::FileInputStream:

List of all members.

Public Member Functions
	FileInputStream (File *file)
	FileInputStream (const String &filename)
virtual	~FileInputStream ()
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)
	input
virtual bool	isEOS ()
	end of stream
void	open (const String &filename)

---

Constructor & Destructor Documentation

VCF::FileInputStream::FileInputStream (  File *  file  )

VCF::FileInputStream::FileInputStream (  const String &  filename  )

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

---

Member Function Documentation

virtual char* VCF::FileInputStream::getBuffer (   )  [virtual]

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

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

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

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

returns the size of the stream. The size represents the number of bytes that have been read from the stream Implements VCF::Stream.

virtual bool VCF::FileInputStream::isEOS (   )  [inline, virtual]

end of stream Implements VCF::InputStream.

void VCF::FileInputStream::open (  const String &  filename  )

virtual uint64 VCF::FileInputStream::read (  unsigned char *  bytesToRead, uint64  sizeOfBytes )  [virtual]

input Implements VCF::InputStream.

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

Implements VCF::Stream.

---

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

• vcf/FoundationKit/FileStream.h

Comments or Suggestions?    License Information