RWUCharOutputStream Class Reference

Handle class for the Unicode character output stream implementation classes. More...

#include <rw/stream/RWUCharOutputStream.h>

Inheritance diagram for RWUCharOutputStream:

Public Member Functions
	RWUCharOutputStream (RWUCharOutputStreamImp *body)
	RWUCharOutputStream (const RWUCharOutputStream &handle)
void	close ()
void	flush ()
bool	isBad () const
bool	isFail () const
bool	isGood () const
RWUCharOutputStream &	operator<< (RWUCharOutputStream &(*pf)(RWUCharOutputStream &))
RWUCharOutputStream	operator<< (RWUCharOutputStream(*pf)(RWUCharOutputStream &))
RWUCharOutputStream &	operator<< (RWUChar unicodeValue)
RWUCharOutputStream &	operator= (const RWUCharOutputStream &handle)
void	write (RWUChar unicodeValue)
void	write (const RWUChar *unicodeArray, RWSize numUChars)
Public Member Functions inherited from RWHandleBase
bool	isValid (void) const
bool	operator!= (const RWHandleBase &second) const
bool	operator< (const RWHandleBase &second) const
bool	operator== (const RWHandleBase &second) const

Related Functions
(Note that these are not member functions.)
RWUCharOutputStream &	rwEndl (RWUCharOutputStream &stream)
RWUCharOutputStream &	rwEnds (RWUCharOutputStream &stream)
RWUCharOutputStream &	rwFlush (RWUCharOutputStream &stream)
RWUCharOutputStream	rwGuard (RWUCharOutputStream &stream)

Additional Inherited Members
Protected Member Functions inherited from RWHandleBase
	RWHandleBase (void)
	RWHandleBase (RWStaticCtor)
	RWHandleBase (RWBodyBase *body)
	RWHandleBase (const RWHandleBase &second)
	~RWHandleBase (void)
RWBodyBase &	body (void) const
RWHandleBase &	operator= (const RWHandleBase &second)

Detailed Description

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

Constructor & Destructor Documentation

RWUCharOutputStream::RWUCharOutputStream ( RWUCharOutputStreamImp *  body )

inlineexplicit

Constructor.

RWUCharOutputStream::RWUCharOutputStream ( const RWUCharOutputStream &  handle )

inline

Copy constructor.

Parameters

handle

A UTF-16 character stream handle used to initialize the newly created handle.

Member Function Documentation

void RWUCharOutputStream::close ( void  )

inline

Closes the stream.

void RWUCharOutputStream::flush ( void  )

inline

Flushes the stream.

bool RWUCharOutputStream::isBad ( ) const

inline

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

bool RWUCharOutputStream::isFail ( ) const

inline

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

bool RWUCharOutputStream::isGood ( ) const

inline

Returns true to indicate a stream in a valid state. Throws no exceptions.

RWUCharOutputStream& RWUCharOutputStream::operator<< ( RWUCharOutputStream &(*)(RWUCharOutputStream &)  pf )

inline

Inserter executing a manipulator function.

Parameters

pf	The manipulator's function pointer.

RWUCharOutputStream RWUCharOutputStream::operator<< ( RWUCharOutputStream(*)(RWUCharOutputStream &)  pf )

inline

Inserter executing a manipulator function.

Parameters

pf	The manipulator's function pointer.

RWUCharOutputStream& RWUCharOutputStream::operator<< ( RWUChar  unicodeValue )

inline

Writes a single UTF-16 character to the stream.

Parameters

unicodeValue

The UTF-16 character to be written to the stream.

RWUCharOutputStream& RWUCharOutputStream::operator= ( const RWUCharOutputStream &  handle )

inline

Assignment operator. Throws no exceptions.

Parameters

handle

A UTF-16 character stream handle used to initialize this handle.

void RWUCharOutputStream::write ( RWUChar  unicodeValue )

inline

Writes a single UTF-16 character to the stream.

Parameters

unicodeValue

The UTF-16 character to be written to the stream.

void RWUCharOutputStream::write ( const RWUChar *  unicodeArray, RWSize  numUChars  )

inline

Writes an array of UTF-16 characters to the stream.

Parameters

unicodeArray	A pointer to the first element of the array.
numUChars	The number of UTF-16 characters to be written to the stream.

Friends And Related Function Documentation

RWUCharOutputStream & rwEndl ( RWUCharOutputStream &  stream )

related

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

Parameters

stream

A UTF-16 character output stream.

RWUCharOutputStream & rwEnds ( RWUCharOutputStream &  stream )

related

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

Parameters

stream

A UTF-16 character output stream.

RWUCharOutputStream & rwFlush ( RWUCharOutputStream &  stream )

related

Manipulator that flushes a UTF-16 character output stream.

Parameters

stream

The UTF-16 character stream to be flushed.

RWUCharOutputStream rwGuard ( RWUCharOutputStream &  stream )

related

Header File

#include <rw/stream/RWGuardedUCharOutputStreamImp.h>

Manipulator that is used to guard a series of insertion operations.

Parameters

stream

A UTF-16 character output stream.

A rwGuard() manipulator creates a temporary guarded stream that locks the internal mutex of the preceding synchronized stream. In this way, any insertions following the manipulator within the statement will be atomic, that is, uninterrupted by any other threads. Note that if the preceding stream is not a synchronized stream, the rwGuard() manipulator has no effect.

// Lock the stream for the duration of all three insertions:
ostr << rwGuard << data1 << data2 << data3;