SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWFilteredUCharOutputStreamImp Class Reference

Abstract base class for all the filtered UTF-16 output stream implementation classes. More...

#include <rw/stream/RWFilteredUCharOutputStreamImp.h>

Inheritance diagram for RWFilteredUCharOutputStreamImp:
RWUCharOutputStreamImp RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock >

Public Member Functions

virtual ~RWFilteredUCharOutputStreamImp ()
 
virtual void close ()
 
virtual void flush ()
 
virtual bool isBad () const
 
virtual bool isFail () const
 
virtual bool isGood () const
 
virtual void write (const RWUChar *unicodeArray, RWSize numUChars)
 
virtual void write (RWUChar unicodeValue)
 
- Public Member Functions inherited from RWUCharOutputStreamImp
virtual ~RWUCharOutputStreamImp ()
 
virtual RWUCharOutputStream acquire ()
 
virtual void release ()
 
- Public Member Functions inherited from RWOutputStreamImp
virtual ~RWOutputStreamImp ()
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 

Protected Member Functions

 RWFilteredUCharOutputStreamImp (const RWUCharOutputStream &sinkStream)
 
RWUCharOutputStreamgetSinkStream ()
 
const RWUCharOutputStreamgetSinkStream () const
 
- Protected Member Functions inherited from RWUCharOutputStreamImp
 RWUCharOutputStreamImp ()
 
- Protected Member Functions inherited from RWOutputStreamImp
 RWOutputStreamImp ()
 
- Protected Member Functions inherited from RWStreamImp
 RWStreamImp ()
 
- Protected Member Functions inherited from RWBodyBase
 RWBodyBase (const RWBodyBase &second)
 
 RWBodyBase (RWStaticCtor)
 
 RWBodyBase (void)
 
virtual ~RWBodyBase (void)
 
RWBodyBaseoperator= (const RWBodyBase &second)
 
- Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
 RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
 
 RWTCountingBody (RWStaticCtor)
 
 RWTCountingBody (unsigned initCount=0)
 
RWTCountingBody< RWMutexLock > & operator= (const RWTCountingBody< RWMutexLock > &second)
 
 ~RWTCountingBody (void)
 
unsigned addReference (void)
 
unsigned references (void) const
 
unsigned removeReference (void)
 
- Protected Member Functions inherited from RWTMonitor< RWMutexLock >
 RWTMonitor (const RWTMonitor< RWMutexLock > &second)
 
 RWTMonitor (RWStaticCtor)
 
 RWTMonitor (void)
 
 ~RWTMonitor (void)
 
void acquire (void)
 
bool isAcquired (void) const
 
RWTMonitor< RWMutexLock > & monitor (void) const
 
RWMutexLockmutex (void)
 
RWTMonitor< RWMutexLock > & operator= (const RWTMonitor< RWMutexLock > &)
 
void release (void)
 
bool tryAcquire (void)
 

Additional Inherited Members

- Protected Types inherited from RWTCountingBody< RWMutexLock >
typedef RWTLockGuard< RWTMonitor< RWMutexLock > > LockGuard
 
typedef RWTTryLockGuard< RWTMonitor< RWMutexLock > > TryLockGuard
 
typedef RWTUnlockGuard< RWTMonitor< RWMutexLock > > UnlockGuard
 
- Protected Types inherited from RWTMonitor< RWMutexLock >
typedef RWTLockGuard< RWTMonitor< RWMutexLock > > LockGuard
 
typedef RWTTryLockGuard< RWTMonitor< RWMutexLock > > TryLockGuard
 
typedef RWTUnlockGuard< RWTMonitor< RWMutexLock > > UnlockGuard
 

Detailed Description

Abstract base class for all the filtered UTF-16 output stream implementation classes. A filtered output stream is a stream that process elements and then forwards the result to another stream for further processing. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

◆ ~RWFilteredUCharOutputStreamImp()

virtual RWFilteredUCharOutputStreamImp::~RWFilteredUCharOutputStreamImp ( )
virtual

Destructor.

◆ RWFilteredUCharOutputStreamImp()

RWFilteredUCharOutputStreamImp::RWFilteredUCharOutputStreamImp ( const RWUCharOutputStream & sinkStream)
inlineprotected

Used by derived classes to initialize the next processing stream.

Parameters
sinkStreamA handle to the next processing stream.

Member Function Documentation

◆ close()

virtual void RWFilteredUCharOutputStreamImp::close ( )
virtual

Forwards the close() request to the next processing stream.

Reimplemented from RWOutputStreamImp.

◆ flush()

virtual void RWFilteredUCharOutputStreamImp::flush ( )
virtual

Forwards the flush() request to the next processing stream.

Implements RWOutputStreamImp.

◆ getSinkStream() [1/2]

RWUCharOutputStream & RWFilteredUCharOutputStreamImp::getSinkStream ( )
inlineprotected

Returns a handle to the next processing stream. Throws no exceptions.

◆ getSinkStream() [2/2]

const RWUCharOutputStream & RWFilteredUCharOutputStreamImp::getSinkStream ( ) const
inlineprotected

Returns a handle to the next processing stream. Throws no exceptions.

◆ isBad()

virtual bool RWFilteredUCharOutputStreamImp::isBad ( ) const
virtual

Forwards the isBad() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

◆ isFail()

virtual bool RWFilteredUCharOutputStreamImp::isFail ( ) const
virtual

Forwards the isFail() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

◆ isGood()

virtual bool RWFilteredUCharOutputStreamImp::isGood ( ) const
virtual

Forwards the isGood() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

◆ write() [1/2]

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

Forwards the writing of an array of UTF-16 characters to the next processing stream.

Parameters
unicodeArrayA pointer to the first element of the array.
numUCharsThe number of unicode character(s) to be written to the stream.

Implements RWUCharOutputStreamImp.

◆ write() [2/2]

virtual void RWFilteredUCharOutputStreamImp::write ( RWUChar unicodeValue)
virtual

Forwards the writing of a single UTF-16 character to the next processing stream.

Parameters
unicodeValueThe unicode character to be written.

Implements RWUCharOutputStreamImp.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.