SourcePro® API Reference Guide

Product Documentation:
   SourcePro
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
RWUCharArrayOutputStreamImp Class Referenceabstract

Abstract base class for Unicode character output streams that support an extended interface. More...

#include <rw/stream/RWUCharArrayOutputStreamImp.h>

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

Public Member Functions

virtual ~RWUCharArrayOutputStreamImp ()
 
virtual void clear ()=0
 
virtual RWUChargetUCharacterArray ()=0
 
virtual RWSize getUCharacterArraySize () const =0
 
- Public Member Functions inherited from RWUCharOutputStreamImp
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

 RWUCharArrayOutputStreamImp ()
 
- 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 (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 Unicode character output streams that support an extended interface. This interface allows retrieval of the output streams' inserted data as a UTF-16 character array. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWUCharArrayOutputStreamImp::~RWUCharArrayOutputStreamImp ( )
inlinevirtual

Destructor.

RWUCharArrayOutputStreamImp::RWUCharArrayOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

virtual void RWUCharArrayOutputStreamImp::clear ( )
pure virtual

Reset the underlying buffer.

Implemented in RWChainedUCharArrayOutputStreamImp.

virtual RWUChar* RWUCharArrayOutputStreamImp::getUCharacterArray ( )
pure virtual

Returns a pointer to the array of UTF-16 characters inserted into the stream since its creation. Users are responsible for freeing the memory associated with the array returned by this function using operator delete[].

Implemented in RWChainedUCharArrayOutputStreamImp.

virtual RWSize RWUCharArrayOutputStreamImp::getUCharacterArraySize ( ) const
pure virtual

Returns the size of the UTF-16 character array that would be returned by a call to function getUCharacterArray().

Implemented in RWChainedUCharArrayOutputStreamImp.

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