xvr2::StdioInterface Class Reference

#include <StdioInterface.h>

Inheritance diagram for xvr2::StdioInterface:

[legend]

List of all members.

---

Detailed Description

Todo:

: Document the StdioInterface class please

Definition at line 24 of file StdioInterface.h.

Public Member Functions
	StdioInterface ()
FILE *	cFILE () const
virtual FileSizeT	size ()
virtual FileOffsetT	tell ()
void	seek (FileOffsetT _pos)
void	seekBegin ()
void	seekEnd ()
void	seekStep (FileOffsetT step)
bool	eof ()
void	flush ()
virtual void	open (const String &path)=0
virtual void	close ()=0
virtual bool	opened ()=0
virtual const char *	getClassName ()
	Returns the name of the current class.
virtual std::string	toString ()
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
FILE *	_fptr
FileSizeT	_fsize
std::string	__cls_name
Friends
std::ostream &	operator<< (std::ostream &stream, const Object &s)

---

Constructor & Destructor Documentation

xvr2::StdioInterface::StdioInterface

(

)

[inline]

Definition at line 36 of file StdioInterface.h.

References _fptr, and _fsize.

---

Member Function Documentation

void xvr2::StdioInterface::_close

(

)

[protected]

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

bool xvr2::StdioInterface::_opened

(

)

[protected]

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

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

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

FILE* xvr2::StdioInterface::cFILE

(

)

const [inline]

Definition at line 40 of file StdioInterface.h.

References _fptr.

virtual FileSizeT xvr2::StdioInterface::size

(

)

[virtual]

Implements xvr2::StreamInterface.

virtual FileOffsetT xvr2::StdioInterface::tell

(

)

[virtual]

Implements xvr2::StreamInterface.

void xvr2::StdioInterface::seek

(

FileOffsetT

_pos

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

void xvr2::StdioInterface::seekBegin

(

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

void xvr2::StdioInterface::seekEnd

(

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

void xvr2::StdioInterface::seekStep

(

FileOffsetT

step

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

bool xvr2::StdioInterface::eof

(

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::StdioOutputFile.

void xvr2::StdioInterface::flush

(

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Log, and xvr2::StdioInputFile.

virtual void xvr2::StreamInterface::open

(

const String &

path

)

[pure virtual, inherited]

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

virtual void xvr2::StreamInterface::close

(

)

[pure virtual, inherited]

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

virtual bool xvr2::StreamInterface::opened

(

)

[pure virtual, inherited]

Implemented in xvr2::RawStreamInterface, xvr2::StdioInputFile, and xvr2::StdioOutputFile.

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 * >.

---

Friends And Related Function Documentation

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

---

Member Data Documentation

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

Definition at line 27 of file StdioInterface.h.

Referenced by cFILE(), and StdioInterface().

FileSizeT xvr2::StdioInterface::_fsize [protected]

Definition at line 34 of file StdioInterface.h.

Referenced by StdioInterface().

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

Definition at line 30 of file Object.h.

---

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

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