#include <TextOutputStream.h>

Inheritance diagram for zeus::TTextOutputStream:

Public Types
enum	EEncodingType { etISO_8859_1 = 1, etUTF_16 = 2, etUTF_16be = 3 }
Public Member Functions
	TTextOutputStream (IOutputStream &rParentStream, EEncodingType eEncoding=etUTF_16, bool bUseCarrigeReturn=DEFAULT_USE_CARRIGERETURN)
	TTextOutputStream (const IString &rFileName, bool bAppend, EEncodingType eEncoding=etUTF_16, bool bUseCarrigeReturn=DEFAULT_USE_CARRIGERETURN)
EEncodingType	getEncodingType () const
Retval	writeLine (const IString &rLine)
Retval	writeText (const IString &rText)
virtual Retval MQUALIFIER	write (const char *pBuffer, Int iBufferSize)
virtual Retval MQUALIFIER	writeInt8 (Int8 cData)
virtual void MQUALIFIER	flush ()
Protected Member Functions
virtual	~TTextOutputStream ()
virtual Retval MQUALIFIER	writeInt16 (Int16)
virtual Retval MQUALIFIER	writeInt32 (Int32)
virtual Retval MQUALIFIER	writeInt64 (const Int64 &)
virtual Retval MQUALIFIER	writeUint16 (Uint16)
virtual Retval MQUALIFIER	writeUint32 (Uint32)
virtual Retval MQUALIFIER	writeUint64 (const Uint64 &)
virtual Retval MQUALIFIER	writeFloat32 (Float32)
virtual Retval MQUALIFIER	writeFloat64 (const Float64 &)
virtual Retval MQUALIFIER	writeBool (bool)
virtual Retval MQUALIFIER	writeArray (const IByteArray &)
virtual Retval MQUALIFIER	writeString (const IString &)

Detailed Description

This is a special output stream filter to write text informations. The text can be written to any input stream or directly to a file. Following encodings are valid:

ISO-8859-1: ISO Latin Alphabet No. 1
UTF-16 : Sixteen-bit UCS Transformation Format, little endian byte order.
UTF-16 be : Sixteen-bit UCS Transformation Format, big endian byte order.

Member Enumeration Documentation

enum zeus::TTextOutputStream::EEncodingType

Text encoding type

Enumerator:

etISO_8859_1
etUTF_16
etUTF_16be

Constructor & Destructor Documentation

TTextOutputStream::TTextOutputStream	(	IOutputStream &	rParentStream,
		EEncodingType	eEncoding = `etUTF_16`,
		bool	bUseCarrigeReturn = `DEFAULT_USE_CARRIGERETURN`
	)

Creates a text out put stream filter

Parameters:

rParentStream	: Parent stream
eEncoding	: Encoding of the text
bUseCarrigeReturn	: flag if the carrige return sign is used. Default for windows is true, for linux is false.

TTextOutputStream::TTextOutputStream	(	const IString &	rFileName,
		bool	bAppend,
		EEncodingType	eEncoding = `etUTF_16`,
		bool	bUseCarrigeReturn = `DEFAULT_USE_CARRIGERETURN`
	)

Creates a text out put stream filter

Parameters:

rFileName	: File name
bAppend	: Append
eEncoding	: Encoding of the text
bUseCarrigeReturn	: flag if the carrige return sign is used. Default for windows is true, for linux is false.

TTextOutputStream::~TTextOutputStream ( ) [protected, virtual]

Destroys the text output stream

Member Function Documentation

void MQUALIFIER TTextOutputStream::flush ( ) [virtual]

See also:: IOutputStream::write

Reimplemented from zeus::TFilterOutputStream.

TTextOutputStream::EEncodingType zeus::TTextOutputStream::getEncodingType ( ) const [inline]

returns the encoding type

Retval MQUALIFIER TTextOutputStream::write	(	const char *	pBuffer,
		Int	iBufferSize
	)		`[virtual]`

See also:: IOutputStream::write

Reimplemented from zeus::TFilterOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeArray ( const IByteArray & rData ) [inline, protected, virtual]

See IOutputStream

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeBool ( bool bData ) [inline, protected, virtual]

See IOutputStream

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeFloat32 ( Float32 fData ) [inline, protected, virtual]

See also:: IOutputStream::writeFloat32

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeFloat64 ( const Float64 & rdData ) [inline, protected, virtual]

See also:: IOutputStream::writeFloat64

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeInt16 ( Int16 sData ) [inline, protected, virtual]

See also:: IOutputStream::writeInt16

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeInt32 ( Int32 lData ) [inline, protected, virtual]

See also:: IOutputStream::writeInt32

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeInt64 ( const Int64 & rldData ) [inline, protected, virtual]

See also:: IOutputStream::writeInt64

Reimplemented from zeus::TAbstractOutputStream.

Retval MQUALIFIER TTextOutputStream::writeInt8 ( Int8 cData ) [virtual]

See also:: IOutputStream::write

Reimplemented from zeus::TFilterOutputStream.

Retval TTextOutputStream::writeLine ( const IString & rLine )

Writes a text line to the text file stream

Parameters:

rLine : Textline to write

Return values:

RET_NOERROR	: Text writed
RET_REQUEST_FAILED	: Could not write the text. Bad stream or convertion problems from Unicode string to ISO 8859-1

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeString ( const IString & rData ) [inline, protected, virtual]

See IOutputStream

Reimplemented from zeus::TAbstractOutputStream.

Retval TTextOutputStream::writeText ( const IString & rText )

Writes a text to the text file stream. This will not change the carrige returns according to the m_bUseCarrigeReturn flag.

Parameters:

rText : Text to write

Return values:

RET_NOERROR	: Text writed
RET_REQUEST_FAILED	: Could not write the text. Bad stream or convertion problems from Unicode string to ISO 8859-1

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeUint16 ( Uint16 usData ) [inline, protected, virtual]

See also:: IOutputStream::writeUint16

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeUint32 ( Uint32 ulData ) [inline, protected, virtual]

See also:: IOutputStream::writeUint32

Reimplemented from zeus::TAbstractOutputStream.

virtual Retval MQUALIFIER zeus::TTextOutputStream::writeUint64 ( const Uint64 & ruldData ) [inline, protected, virtual]

See also:: IOutputStream::writeUint64

Reimplemented from zeus::TAbstractOutputStream.

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

zeus::TTextOutputStream Class Reference

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation