zeus::TAbstractOutputStream Class Reference

#include <AbstractOutputStream.h>

Inheritance diagram for zeus::TAbstractOutputStream:

List of all members.

Public Member Functions
	TAbstractOutputStream ()
bool MQUALIFIER	available () const
virtual Retval MQUALIFIER	write (const char *pBuffer, Int iBufferSize)=0
virtual Retval MQUALIFIER	writeInt8 (char cData)=0
virtual void MQUALIFIER	close ()=0
virtual void MQUALIFIER	flush ()=0
virtual Retval MQUALIFIER	writeInt16 (Int16 sData)
virtual Retval MQUALIFIER	writeInt32 (Int32 lData)
virtual Retval MQUALIFIER	writeInt64 (const Int64 &rldData)
virtual Retval MQUALIFIER	writeUint8 (Uint8 ucData)
virtual Retval MQUALIFIER	writeUint16 (Uint16 usData)
virtual Retval MQUALIFIER	writeUint32 (Uint32 ulData)
virtual Retval MQUALIFIER	writeUint64 (const Uint64 &ruldData)
virtual Retval MQUALIFIER	writeFloat32 (Float32 fData)
virtual Retval MQUALIFIER	writeFloat64 (const Float64 &rdData)
virtual Retval MQUALIFIER	writeBool (bool bData)
virtual Retval MQUALIFIER	writeArray (const IByteArray &rData)
virtual Retval MQUALIFIER	writeString (const IString &rData)
virtual Retval MQUALIFIER	askForInterface (Uint uiInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
Protected Member Functions
virtual	~TAbstractOutputStream ()
Protected Attributes
bool	m_bOpen
	flag to check if stream is open
bool	m_bAvailable
	flag to check if stream is valid

---

Detailed Description

This class implements an abstract output stream class

---

Constructor & Destructor Documentation

TAbstractOutputStream::TAbstractOutputStream

(

)

Creates an abstract output stream

TAbstractOutputStream::~TAbstractOutputStream

(

)

[protected, virtual]

Destroys the output stream

---

Member Function Documentation

bool MQUALIFIER zeus::TAbstractOutputStream::available

(

)

const [inline]

See also:

IOutputStream::available

virtual Retval MQUALIFIER zeus::TAbstractOutputStream::write	(	const char *	pBuffer,
		Int	iBufferSize
	)			[pure virtual]

Writes to a stream out of a buffer

Parameters:

	pBuffer	: Char Array
	iBufferSize	: Size of the Array

Return values:

	RET_NOERROR	: Writing was successful
	RET_REQUEST_FAILED	: Could not write to stream

Implements zeus::IOutputStream.

Implemented in zeus::TCryptedOutputStream, zeus::TBase64OutputStream, zeus::TByteArrayOutputStream, zeus::TFileOutputStream, zeus::TFilterOutputStream, zeus::TTextOutputStream, and zeus::TZippedOutputStream.

virtual Retval MQUALIFIER zeus::TAbstractOutputStream::writeInt8

(

char

cData

)

[pure virtual]

Writes an int8 value to a stream

Parameters:

cData

: int8 value

Return values:

	RET_NOERROR	: Writing was successful
	RET_REQUEST_FAILED	: Could not write to stream

Implements zeus::IOutputStream.

Implemented in zeus::TCryptedOutputStream, zeus::TBase64OutputStream, zeus::TByteArrayOutputStream, zeus::TFileOutputStream, zeus::TFilterOutputStream, zeus::TTextOutputStream, and zeus::TZippedOutputStream.

virtual void MQUALIFIER zeus::TAbstractOutputStream::close

(

)

[pure virtual]

Closes the output stream

Implements zeus::IOutputStream.

Implemented in zeus::TByteArrayOutputStream, zeus::TFileOutputStream, zeus::TFilterOutputStream, and zeus::TZippedOutputStream.

virtual void MQUALIFIER zeus::TAbstractOutputStream::flush

(

)

[pure virtual]

Flush the output stream. This will send the buffer to the destination.

Implements zeus::IOutputStream.

Implemented in zeus::TCryptedOutputStream, zeus::TBase64OutputStream, zeus::TByteArrayOutputStream, zeus::TFileOutputStream, zeus::TFilterOutputStream, zeus::TTextOutputStream, and zeus::TZippedOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeInt16

(

Int16

sData

)

[virtual]

See also:

IOutputStream::writeInt16

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeInt32

(

Int32

lData

)

[virtual]

See also:

IOutputStream::writeInt32

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeInt64

(

const Int64 &

rldData

)

[virtual]

See also:

IOutputStream::writeInt64

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER zeus::TAbstractOutputStream::writeUint8

(

Uint8

ucData

)

[inline, virtual]

See also:

IOutputStream::writeUint8

Implements zeus::IOutputStream.

Retval MQUALIFIER zeus::TAbstractOutputStream::writeUint16

(

Uint16

usData

)

[inline, virtual]

See also:

IOutputStream::writeUint16

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER zeus::TAbstractOutputStream::writeUint32

(

Uint32

ulData

)

[inline, virtual]

See also:

IOutputStream::writeUint32

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER zeus::TAbstractOutputStream::writeUint64

(

const Uint64 &

ruldData

)

[inline, virtual]

See also:

IOutputStream::writeUint64

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeFloat32

(

Float32

fData

)

[virtual]

See also:

IOutputStream::writeFloat32

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeFloat64

(

const Float64 &

rdData

)

[virtual]

See also:

IOutputStream::writeFloat64

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeBool

(

bool

bData

)

[virtual]

See IOutputStream

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeArray

(

const IByteArray &

rData

)

[virtual]

See IOutputStream

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

Retval MQUALIFIER TAbstractOutputStream::writeString

(

const IString &

rData

)

[virtual]

See IOutputStream

Implements zeus::IOutputStream.

Reimplemented in zeus::TTextOutputStream.

virtual Retval MQUALIFIER zeus::TAbstractOutputStream::askForInterface	(	Uint	uiInterfaceID,
		IZUnknown *&	rpIface
	)			[virtual]

Reimplemented from zeus::TZObject.

virtual void MQUALIFIER zeus::TAbstractOutputStream::addRef

(

)

const [virtual]

See also:

IZUnknown::addRef

Reimplemented from zeus::TZObject.

virtual void MQUALIFIER zeus::TAbstractOutputStream::release

(

)

const [virtual]

See also:

IZUnknown::release

Reimplemented from zeus::TZObject.

---

Member Data Documentation

bool zeus::TAbstractOutputStream::m_bOpen [protected]

flag to check if stream is open

bool zeus::TAbstractOutputStream::m_bAvailable [protected]

flag to check if stream is valid

---

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

• AbstractOutputStream.h
• AbstractOutputStream.cpp