xvr2::StreamInterface Class Reference

#include <StreamInterface.h>

Inheritance diagram for xvr2::StreamInterface:

[legend]

List of all members.

---

Detailed Description

File interface class.

Todo:

Document all classes in StreamInterface.h

Definition at line 26 of file StreamInterface.h.

Public Member Functions
	StreamInterface ()
virtual	~StreamInterface ()
virtual void	open (const String &path)=0
virtual void	close ()=0
virtual bool	opened ()=0
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 void	flush ()=0
virtual bool	eof ()=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 Attributes
std::string	__cls_name
Friends
std::ostream &	operator<< (std::ostream &stream, const Object &s)

---

Constructor & Destructor Documentation

xvr2::StreamInterface::StreamInterface

(

)

virtual xvr2::StreamInterface::~StreamInterface

(

)

[virtual]

---

Member Function Documentation

virtual void xvr2::StreamInterface::open

(

const String &

path

)

[pure virtual]

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]

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]

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

virtual FileSizeT xvr2::StreamInterface::size

(

)

[pure virtual]

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

virtual FileOffsetT xvr2::StreamInterface::tell

(

)

[pure virtual]

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

virtual void xvr2::StreamInterface::seek

(

FileOffsetT

_pos

)

[pure virtual]

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

virtual void xvr2::StreamInterface::seekEnd

(

)

[pure virtual]

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

virtual void xvr2::StreamInterface::seekBegin

(

)

[pure virtual]

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

virtual void xvr2::StreamInterface::seekStep

(

FileOffsetT

_step

)

[pure virtual]

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

virtual void xvr2::StreamInterface::flush

(

)

[pure virtual]

Implemented in xvr2::Log, xvr2::RawOutputStream, xvr2::StdioInputFile, xvr2::StdioInterface, xvr2::ReadableStream, and xvr2::Net::RawSocketOutputStream.

virtual bool xvr2::StreamInterface::eof

(

)

[pure virtual]

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

---

Friends And Related Function Documentation

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

---

Member Data Documentation

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/StreamInterface.h