RWCharOutputStream Class Reference
[Streams]

Handle class for all narrow character output stream implementation classes. More...

#include <rw/stream/RWCharOutputStream.h>

Inheritance diagram for RWCharOutputStream:

List of all members.

Public Member Functions
	RWCharOutputStream (RWCharOutputStreamImp *ptr)
	RWCharOutputStream (const RWCharOutputStream &handle)
RWCharOutputStream &	operator= (const RWCharOutputStream &handle)
RWCharOutputStream &	operator<< (RWCharOutputStream &(*pf)(RWCharOutputStream &))
RWCharOutputStream	operator<< (RWCharOutputStream(*pf)(RWCharOutputStream &))
RWCharOutputStream &	operator<< (char charValue)
RWCharOutputStream &	operator<< (const RWCString &string)
void	write (char charValue)
void	write (const char *charArray, RWSize numChars)
void	write (const RWCString &string)
void	close ()
void	flush ()
bool	isBad () const
bool	isFail () const
bool	isGood () const
Related Functions
(Note that these are not member functions.)
RWCharOutputStream &	rwFlush (RWCharOutputStream &stream)
RWCharOutputStream &	rwEndl (RWCharOutputStream &stream)
RWCharOutputStream &	rwEnds (RWCharOutputStream &stream)

---

Detailed Description

Handle class for all the narrow character output stream implementation classes. Implements the handle idiom from the handle-body pattern.

---

Constructor & Destructor Documentation

RWCharOutputStream::RWCharOutputStream

(

RWCharOutputStreamImp *

ptr

)

[inline, explicit]

Constructor.

RWCharOutputStream::RWCharOutputStream

(

const RWCharOutputStream &

handle

)

[inline]

Copy constructor.

Parameters:

handle

A narrow stream handle used to initialize the newly created handle.

---

Member Function Documentation

void RWCharOutputStream::close

(

)

[inline]

Closes the stream.

void RWCharOutputStream::flush

(

void

)

[inline]

Flushes the stream.

bool RWCharOutputStream::isBad

(

)

const [inline]

Returns true to indicate a loss of integrity resulting from an output operation.

bool RWCharOutputStream::isFail

(

)

const [inline]

Returns true to indicate that an output operation failed to generate the desired data.

bool RWCharOutputStream::isGood

(

)

const [inline]

Returns true to indicate a stream in a valid state.

RWCharOutputStream& RWCharOutputStream::operator<<

(

const RWCString &

string

)

[inline]

Writes a narrow string to the stream.

Parameters:

string

The narrow string object to be written to the stream.

RWCharOutputStream& RWCharOutputStream::operator<<

(

char

charValue

)

[inline]

Writes a single narrow character to the stream.

Parameters:

charValue

The narrow character to be written to the stream.

RWCharOutputStream RWCharOutputStream::operator<<

(

RWCharOutputStream(*)(RWCharOutputStream &)

pf

)

[inline]

Inserter executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWCharOutputStream& RWCharOutputStream::operator<<

(

RWCharOutputStream &(*)(RWCharOutputStream &)

pf

)

[inline]

Inserter executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWCharOutputStream& RWCharOutputStream::operator=

(

const RWCharOutputStream &

handle

)

[inline]

Assignment operator. Throws no exceptions.

Parameters:

handle

A narrow stream handle used to initialize this handle.

void RWCharOutputStream::write

(

const RWCString &

string

)

Writes a single narrow string to the stream.

Parameters:

string

The narrow string object to be written to the stream.

void RWCharOutputStream::write	(	const char *	charArray,
		RWSize	numChars
	)			[inline]

Writes an array of narrow characters to the stream.

Parameters:

	charArray	A pointer to the first element of the array.
	numChars	The number of narrow characters to be written to the stream.

void RWCharOutputStream::write

(

char

charValue

)

[inline]

Writes a single narrow character to the stream.

Parameters:

charValue

The narrow character to be written to the stream.

---

Friends And Related Function Documentation

RWCharOutputStream & rwEndl

(

RWCharOutputStream &

stream

)

[related]

Manipulator that writes an end of line control character to the stream.

Parameters:

stream

A narrow character output stream.

RWCharOutputStream & rwEnds

(

RWCharOutputStream &

stream

)

[related]

Manipulator that writes an end of string character to the stream.

Parameters:

stream

A narrow character output stream.

RWCharOutputStream & rwFlush

(

RWCharOutputStream &

stream

)

[related]

Manipulator that flushes a narrow character output stream.

Parameters:

stream

The narrow stream to be flushed.