SourcePro® API Reference Guide

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

Abstract base class for all the wide character output stream implementation classes. More...

#include <rw/stream/RWWCharOutputStreamImp.h>

Inheritance diagram for RWWCharOutputStreamImp:
RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWFilteredWCharOutputStreamImp RWWCharArrayOutputStreamImp RWWCharToWStreambufOutputStreamImp RWChainedWCharArrayOutputStreamImp

Public Member Functions

virtual ~RWWCharOutputStreamImp ()
 
virtual RWWCharOutputStream acquire ()
 
virtual void release ()
 
virtual void write (wchar_t wcharValue)=0
 
virtual void write (const wchar_t *wcharArray, RWSize numWchars)=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

 RWWCharOutputStreamImp ()
 
- 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 wide character output stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWWCharOutputStreamImp::~RWWCharOutputStreamImp ( )
inlinevirtual

Destructor.

RWWCharOutputStreamImp::RWWCharOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

virtual RWWCharOutputStream RWWCharOutputStreamImp::acquire ( )
virtual

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

virtual void RWWCharOutputStreamImp::release ( void  )
inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

virtual void RWWCharOutputStreamImp::write ( wchar_t  wcharValue)
pure virtual

Writes a single wide character to the stream.

Parameters
wcharValueThe wide character to be written to the stream.

Implemented in RWChainedWCharArrayOutputStreamImp, RWWCharToWStreambufOutputStreamImp, and RWFilteredWCharOutputStreamImp.

virtual void RWWCharOutputStreamImp::write ( const wchar_t *  wcharArray,
RWSize  numWchars 
)
pure virtual

Writes an array of wide characters to the stream.

Parameters
wcharArrayA pointer to the first element of the array.
numWcharsThe number of wide characters to be written to the stream.

Implemented in RWChainedWCharArrayOutputStreamImp, RWWCharToWStreambufOutputStreamImp, and RWFilteredWCharOutputStreamImp.

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