SourcePro® C++ API Reference Guide

Product Documentation:
   SourcePro C++
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
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 (RWUChar unicodeValue)=0
 
virtual void write (const RWUChar *unicodeArray, RWSize numUChars)=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 (void)
 
 RWBodyBase (RWStaticCtor)
 
 RWBodyBase (const RWBodyBase &second)
 
virtual ~RWBodyBase (void)
 
RWBodyBaseoperator= (const RWBodyBase &second)
 
- Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
 RWTCountingBody (unsigned initCount=0)
 
 RWTCountingBody (RWStaticCtor)
 
 RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
 
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 ()
 
 RWTMonitor (RWStaticCtor)
 
 RWTMonitor (const RWTMonitor< RWMutexLock > &second)
 
 ~RWTMonitor ()
 
void acquire ()
 
bool isAcquired () const
 
RWTMonitor< RWMutexLock > & monitor () const
 
RWMutexLockmutex ()
 
RWTMonitor< RWMutexLock > & operator= (const RWTMonitor< RWMutexLock > &)
 
void release ()
 
bool tryAcquire ()
 

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

virtual RWUCharOutputStreamImp::~RWUCharOutputStreamImp ( )
inlinevirtual

Destructor.

RWUCharOutputStreamImp::RWUCharOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

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.

virtual void RWUCharOutputStreamImp::release ( void  )
inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

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, RWUCharToUTF8ByteOutputStreamImp, RWUCharToByteOutputStreamImp, and RWFilteredUCharOutputStreamImp.

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, RWUCharToUTF8ByteOutputStreamImp, RWUCharToByteOutputStreamImp, and RWFilteredUCharOutputStreamImp.

Copyright © 2016 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.