xvr2::StdioInputFile Class Reference

#include <StdioInputFile.h>

Inheritance diagram for xvr2::StdioInputFile:

[legend]

List of all members.

---

Detailed Description

Todo:

Document the StdioInputFile class please

Definition at line 25 of file StdioInputFile.h.

Public Member Functions
	StdioInputFile ()
	StdioInputFile (const String &fname)
	StdioInputFile (FILE *__f)
void	open (const String &path)
void	close ()
bool	opened ()
virtual	~StdioInputFile ()
UInt32	read (void *data, UInt32 size)
UInt32	read (Buffer &data, UInt32 size)
StdioInputFile &	read (Buffer &b)
	Reads all data starting from the current position to the end of the file and returns it in a Buffer object.
StdioInputFile &	readAll (Buffer &b)
	Loads the full contents and returns it in a Buffer.
void	flush ()
virtual ReadableStream &	operator>> (UInt32 n)
virtual ReadableStream &	operator>> (double n)
virtual ReadableStream &	operator>> (UInt64 n)
UInt32	read (UInt32 n)
UInt32	read (double n)
UInt32	read (UInt64 n)
virtual void	setTimeout (int millisecs)
virtual FileSizeT	size ()=0
virtual FileOffsetT	tell ()=0
virtual void	seek (FileOffsetT _pos)=0
virtual void	seekEnd ()=0
virtual void	seekBegin ()=0
virtual void	seekStep (FileOffsetT _step)=0
virtual bool	eof ()=0
virtual const char *	getClassName ()
	Returns the name of the current class.
virtual std::string	toString ()
FILE *	cFILE () const
virtual FileSizeT	size ()
virtual FileOffsetT	tell ()
void	seek (FileOffsetT _pos)
void	seekBegin ()
void	seekEnd ()
void	seekStep (FileOffsetT step)
bool	eof ()
Static Public Member Functions
static void	debugmsg (Object *obj, const char *msg, int linenumber=__LINE__, const char *srcfile=__FILE__)
	Will print a debug message to the screen.
static void	debugmsgln (Object *obj, const char *msg, int linenumber=__LINE__, const char *srcfile=__FILE__)
Protected Member Functions
void	_close ()
void	_open (const String &fname, const String &mode)
bool	_opened ()
size_t	_read (void *_data, size_t __bytes)
size_t	_write (const void *_data, size_t __bytes)
void	_seek (FileOffsetT _pos, UInt32 _from)
Protected Attributes
bool	handles_timeouts
int	timeout_msecs
std::string	__cls_name
FILE *	_fptr
FileSizeT	_fsize
Friends
std::ostream &	operator<< (std::ostream &stream, const Object &s)

---

Constructor & Destructor Documentation

xvr2::StdioInputFile::StdioInputFile

(

)

xvr2::StdioInputFile::StdioInputFile

(

const String &

fname

)

xvr2::StdioInputFile::StdioInputFile

(

FILE *

__f

)

virtual xvr2::StdioInputFile::~StdioInputFile

(

)

[virtual]

---

Member Function Documentation

void xvr2::StdioInputFile::open

(

const String &

path

)

[virtual]

Implements xvr2::StreamInterface.

void xvr2::StdioInputFile::close

(

)

[virtual]

Implements xvr2::StreamInterface.

bool xvr2::StdioInputFile::opened

(

)

[virtual]

Implements xvr2::StreamInterface.

UInt32 xvr2::StdioInputFile::read	(	void *	data,
		UInt32	size
	)			[virtual]

Implements xvr2::ReadableStream.

UInt32 xvr2::StdioInputFile::read	(	Buffer &	data,
		UInt32	size
	)			[virtual]

Reimplemented from xvr2::ReadableStream.

StdioInputFile& xvr2::StdioInputFile::read

(

Buffer &

b

)

[virtual]

Reads all data starting from the current position to the end of the file and returns it in a Buffer object.

Reimplemented from xvr2::ReadableStream.

StdioInputFile& xvr2::StdioInputFile::readAll

(

Buffer &

b

)

[virtual]

Loads the full contents and returns it in a Buffer.

Reimplemented from xvr2::ReadableStream.

void xvr2::StdioInputFile::flush

(

)

[virtual]

Reimplemented from xvr2::StdioInterface.

virtual ReadableStream& xvr2::ReadableStream::operator>>

(

UInt32

n

)

[virtual, inherited]

virtual ReadableStream& xvr2::ReadableStream::operator>>

(

double

n

)

[virtual, inherited]

virtual ReadableStream& xvr2::ReadableStream::operator>>

(

UInt64

n

)

[virtual, inherited]

UInt32 xvr2::ReadableStream::read

(

UInt32

n

)

[inherited]

UInt32 xvr2::ReadableStream::read

(

double

n

)

[inherited]

UInt32 xvr2::ReadableStream::read

(

UInt64

n

)

[inherited]

virtual void xvr2::ReadableStream::setTimeout

(

int

millisecs

)

[inline, virtual, inherited]

Definition at line 79 of file StreamInterface.h.

References xvr2::ReadableStream::timeout_msecs.

virtual FileSizeT xvr2::StreamInterface::size

(

)

[pure virtual, inherited]

Implemented in xvr2::RawOutputStream, xvr2::RawStreamInterface, xvr2::StdioInterface, and xvr2::Net::RawSocketOutputStream.

virtual FileOffsetT xvr2::StreamInterface::tell

(

)

[pure virtual, inherited]

Implemented in xvr2::RawStreamInterface, and xvr2::StdioInterface.

virtual void xvr2::StreamInterface::seek

(

FileOffsetT

_pos

)

[pure virtual, inherited]

Implemented in xvr2::RawInputStream, xvr2::StdioInterface, xvr2::StdioOutputFile, xvr2::WriteableStream, and xvr2::Net::RawSocketInputStream.

virtual void xvr2::StreamInterface::seekEnd

(

)

[pure virtual, inherited]

Implemented in xvr2::RawInputStream, xvr2::StdioInterface, xvr2::StdioOutputFile, xvr2::WriteableStream, and xvr2::Net::RawSocketInputStream.

virtual void xvr2::StreamInterface::seekBegin

(

)

[pure virtual, inherited]

Implemented in xvr2::RawInputStream, xvr2::StdioInterface, xvr2::StdioOutputFile, xvr2::WriteableStream, and xvr2::Net::RawSocketInputStream.

virtual void xvr2::StreamInterface::seekStep

(

FileOffsetT

_step

)

[pure virtual, inherited]

Implemented in xvr2::RawInputStream, xvr2::StdioInterface, xvr2::StdioOutputFile, xvr2::WriteableStream, and xvr2::Net::RawSocketInputStream.

virtual bool xvr2::StreamInterface::eof

(

)

[pure virtual, inherited]

Implemented in xvr2::RawInputStream, xvr2::RawOutputStream, xvr2::StdioInterface, xvr2::StdioOutputFile, xvr2::Net::RawSocketInputStream, and xvr2::Net::RawSocketOutputStream.

virtual const char* xvr2::Object::getClassName

(

)

[virtual, inherited]

Returns the name of the current class.

static void xvr2::Object::debugmsg	(	Object *	obj,
		const char *	msg,
		int	linenumber = __LINE__,
		const char *	srcfile = __FILE__
	)			[static, inherited]

Will print a debug message to the screen.

static void xvr2::Object::debugmsgln	(	Object *	obj,
		const char *	msg,
		int	linenumber = __LINE__,
		const char *	srcfile = __FILE__
	)			[static, inherited]

virtual std::string xvr2::Object::toString

(

)

[virtual, inherited]

Reimplemented in xvr2::Buffer, xvr2::Byte, xvr2::Exception, xvr2::Date, xvr2::Group, xvr2::String, xvr2::User, xvr2::Vector< _Tp, _Alloc >, xvr2::Text::MD5Hash, xvr2::Net::IPv4Address, xvr2::Net::OldTCPSocket, xvr2::Net::URI, xvr2::Platform::CPU, and xvr2::Vector< xvr2::PipelineFilter * >.

void xvr2::StdioInterface::_close

(

)

[protected, inherited]

void xvr2::StdioInterface::_open	(	const String &	fname,
		const String &	mode
	)			[protected, inherited]

bool xvr2::StdioInterface::_opened

(

)

[protected, inherited]

size_t xvr2::StdioInterface::_read	(	void *	_data,
		size_t	__bytes
	)			[protected, inherited]

size_t xvr2::StdioInterface::_write	(	const void *	_data,
		size_t	__bytes
	)			[protected, inherited]

void xvr2::StdioInterface::_seek	(	FileOffsetT	_pos,
		UInt32	_from
	)			[protected, inherited]

FILE* xvr2::StdioInterface::cFILE

(

)

const [inline, inherited]

Definition at line 40 of file StdioInterface.h.

References xvr2::StdioInterface::_fptr.

virtual FileSizeT xvr2::StdioInterface::size

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

virtual FileOffsetT xvr2::StdioInterface::tell

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

void xvr2::StdioInterface::seek

(

FileOffsetT

_pos

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

void xvr2::StdioInterface::seekBegin

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

void xvr2::StdioInterface::seekEnd

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

void xvr2::StdioInterface::seekStep

(

FileOffsetT

step

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

bool xvr2::StdioInterface::eof

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	stream,
		const Object &	s
	)			[friend, inherited]

---

Member Data Documentation

bool xvr2::ReadableStream::handles_timeouts [protected, inherited]

Definition at line 58 of file StreamInterface.h.

Referenced by xvr2::ReadableStream::ReadableStream().

int xvr2::ReadableStream::timeout_msecs [protected, inherited]

Definition at line 59 of file StreamInterface.h.

Referenced by xvr2::ReadableStream::ReadableStream(), and xvr2::ReadableStream::setTimeout().

std::string xvr2::Object::__cls_name [protected, inherited]

Definition at line 30 of file Object.h.

FILE* xvr2::StdioInterface::_fptr [protected, inherited]

Definition at line 27 of file StdioInterface.h.

Referenced by xvr2::StdioInterface::cFILE(), and xvr2::StdioInterface::StdioInterface().

FileSizeT xvr2::StdioInterface::_fsize [protected, inherited]

Definition at line 34 of file StdioInterface.h.

Referenced by xvr2::StdioInterface::StdioInterface().

---

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

• /home/coredumped/X-VR2_Trunk/Core/xvr2/StdioInputFile.h