xvr2::StdioOutputFile Class Reference

#include <StdioOutputFile.h>

Inheritance diagram for xvr2::StdioOutputFile:

[legend]

List of all members.

---

Detailed Description

Todo:

Document the StdioOutputFile class please

Definition at line 25 of file StdioOutputFile.h.

Public Member Functions
	StdioOutputFile ()
	StdioOutputFile (const String &fname, bool for_append=false)
	StdioOutputFile (FILE *__f)
void	open (const String &path)
void	open (const String &path, bool for_append=false)
void	close ()
bool	opened ()
virtual	~StdioOutputFile ()
virtual StdioOutputFile &	operator<< (const Buffer &b)
virtual StdioOutputFile &	operator<< (const String &s)
virtual StdioOutputFile &	write (void *data, UInt32 size)
virtual StdioOutputFile &	write (const Buffer &data)
virtual StdioOutputFile &	write (const String &s)
void	seek (FileOffsetT _pos)
void	seekEnd ()
void	seekBegin ()
void	seekStep (FileOffsetT _step)
bool	eof ()
virtual FileSizeT	size ()=0
virtual FileOffsetT	tell ()=0
virtual void	flush ()=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	flush ()
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
std::string	__cls_name
FILE *	_fptr
FileSizeT	_fsize
Friends
std::ostream &	operator<< (std::ostream &stream, const Object &s)

---

Constructor & Destructor Documentation

xvr2::StdioOutputFile::StdioOutputFile

(

)

xvr2::StdioOutputFile::StdioOutputFile	(	const String &	fname,
		bool	for_append = false
	)

xvr2::StdioOutputFile::StdioOutputFile

(

FILE *

__f

)

virtual xvr2::StdioOutputFile::~StdioOutputFile

(

)

[virtual]

---

Member Function Documentation

void xvr2::StdioOutputFile::open

(

const String &

path

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Log.

void xvr2::StdioOutputFile::open	(	const String &	path,
		bool	for_append = false
	)

void xvr2::StdioOutputFile::close

(

)

[virtual]

Implements xvr2::StreamInterface.

Reimplemented in xvr2::Log.

bool xvr2::StdioOutputFile::opened

(

)

[virtual]

Implements xvr2::StreamInterface.

virtual StdioOutputFile& xvr2::StdioOutputFile::operator<<

(

const Buffer &

b

)

[virtual]

Reimplemented from xvr2::WriteableStream.

virtual StdioOutputFile& xvr2::StdioOutputFile::operator<<

(

const String &

s

)

[virtual]

Reimplemented from xvr2::WriteableStream.

Reimplemented in xvr2::Log.

virtual StdioOutputFile& xvr2::StdioOutputFile::write	(	void *	data,
		UInt32	size
	)			[virtual]

Implements xvr2::WriteableStream.

virtual StdioOutputFile& xvr2::StdioOutputFile::write

(

const Buffer &

data

)

[virtual]

Reimplemented from xvr2::WriteableStream.

virtual StdioOutputFile& xvr2::StdioOutputFile::write

(

const String &

s

)

[virtual]

Reimplemented from xvr2::WriteableStream.

void xvr2::StdioOutputFile::seek

(

FileOffsetT

_pos

)

[virtual]

Reimplemented from xvr2::StdioInterface.

void xvr2::StdioOutputFile::seekEnd

(

)

[virtual]

Reimplemented from xvr2::StdioInterface.

void xvr2::StdioOutputFile::seekBegin

(

)

[virtual]

Reimplemented from xvr2::StdioInterface.

void xvr2::StdioOutputFile::seekStep

(

FileOffsetT

_step

)

[virtual]

Reimplemented from xvr2::StdioInterface.

bool xvr2::StdioOutputFile::eof

(

)

[virtual]

Reimplemented from xvr2::StdioInterface.

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::flush

(

)

[pure virtual, inherited]

Implemented in xvr2::Log, xvr2::RawOutputStream, xvr2::StdioInputFile, xvr2::StdioInterface, xvr2::ReadableStream, 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::flush

(

)

[virtual, inherited]

Implements xvr2::StreamInterface.

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

---

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.

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