SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWUCharOutputStreamImp Class Referenceabstract

Abstract base class for the Unicode output stream implementation classes. More...

#include <rw/stream/RWUCharOutputStreamImp.h>

Inheritance diagram for RWUCharOutputStreamImp:
RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWFilteredUCharOutputStreamImp RWUCharArrayOutputStreamImp RWUCharToByteOutputStreamImp RWUCharToUTF8ByteOutputStreamImp RWChainedUCharArrayOutputStreamImp

Public Member Functions

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

Protected Member Functions

 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 Unicode output stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

◆ ~RWUCharOutputStreamImp()

virtual RWUCharOutputStreamImp::~RWUCharOutputStreamImp ( )
inlinevirtual

Destructor.

◆ RWUCharOutputStreamImp()

RWUCharOutputStreamImp::RWUCharOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

◆ acquire()

virtual RWUCharOutputStream RWUCharOutputStreamImp::acquire ( )
virtual

Acquires the synchronization mechanism provided by a stream concrete implementation. The acquire() member function returns a handle to the Unicode stream that should be used for output operation after acquiring the synchronization mechanism.

◆ release()

virtual void RWUCharOutputStreamImp::release ( void )
inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

◆ write() [1/2]

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

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

Parameters
unicodeArrayA pointer to the first element of the array.
numUCharsThe number of UTF-16 characters to be written to the stream.

Implemented in RWChainedUCharArrayOutputStreamImp, RWFilteredUCharOutputStreamImp, RWUCharToByteOutputStreamImp, and RWUCharToUTF8ByteOutputStreamImp.

◆ write() [2/2]

virtual void RWUCharOutputStreamImp::write ( RWUChar unicodeValue)
pure virtual

Writes a single UTF-16 character to the stream.

Parameters
unicodeValueThe UTF-16 character to be written to the stream.

Implemented in RWChainedUCharArrayOutputStreamImp, RWFilteredUCharOutputStreamImp, RWUCharToByteOutputStreamImp, and RWUCharToUTF8ByteOutputStreamImp.

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