SourcePro® API Reference Guide

Product Documentation:
   SourcePro
Documentation Home
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
RWChainedWCharArrayOutputStreamImp Class Reference

Concrete class implementing the wide character array output stream interface. More...

#include <rw/stream/RWChainedWCharArrayOutputStreamImp.h>

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

Public Member Functions

virtual ~RWChainedWCharArrayOutputStreamImp ()
 
virtual void clear ()
 
virtual void close ()
 
virtual void flush ()
 
virtual wchar_t * getWCharacterArray ()
 
virtual RWSize getWCharacterArraySize () const
 
virtual bool isBad () const
 
virtual bool isFail () const
 
virtual bool isGood () const
 
virtual void write (wchar_t wcharValue)
 
virtual void write (const wchar_t *wcharArray, RWSize numWChars)
 
- Public Member Functions inherited from RWWCharArrayOutputStreamImp
virtual ~RWWCharArrayOutputStreamImp ()
 
- Public Member Functions inherited from RWWCharOutputStreamImp
virtual ~RWWCharOutputStreamImp ()
 
virtual RWWCharOutputStream acquire ()
 
virtual void release ()
 
- Public Member Functions inherited from RWOutputStreamImp
virtual ~RWOutputStreamImp ()
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 

Static Public Member Functions

static RWWCharArrayOutputStream make ()
 

Protected Member Functions

 RWChainedWCharArrayOutputStreamImp ()
 
RWChainedMemoryStreambufgetSinkBuff ()
 
const RWChainedMemoryStreambufgetSinkBuff () const
 
- Protected Member Functions inherited from RWWCharArrayOutputStreamImp
 RWWCharArrayOutputStreamImp ()
 
- Protected Member Functions inherited from RWWCharOutputStreamImp
 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

Concrete class implementing the wide character array output stream interface. Wide character inserted into an instance of class RWChainedWCharArrayOutputStreamImp are stored in memory using an instance of class RWChainedMemoryStreambuf. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWChainedWCharArrayOutputStreamImp::~RWChainedWCharArrayOutputStreamImp ( )
virtual

Destructor.

RWChainedWCharArrayOutputStreamImp::RWChainedWCharArrayOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

virtual void RWChainedWCharArrayOutputStreamImp::clear ( )
virtual

Reset the underlying buffer.

Implements RWWCharArrayOutputStreamImp.

virtual void RWChainedWCharArrayOutputStreamImp::close ( )
virtual

This function calls flush().

Reimplemented from RWOutputStreamImp.

virtual void RWChainedWCharArrayOutputStreamImp::flush ( )
virtual

Forward the flush request to the internal RWChainedMemoryStreambuf object.

Implements RWOutputStreamImp.

RWChainedMemoryStreambuf& RWChainedWCharArrayOutputStreamImp::getSinkBuff ( )
inlineprotected

Returns a reference to the RWChainedMemoryStreambuf, which is used as the sink of wide characters.

const RWChainedMemoryStreambuf& RWChainedWCharArrayOutputStreamImp::getSinkBuff ( ) const
inlineprotected

Returns a reference to the RWChainedMemoryStreambuf, which is used as the sink of wide characters.

virtual wchar_t* RWChainedWCharArrayOutputStreamImp::getWCharacterArray ( )
virtual

Returns a pointer to an array of wide characters containing the wide characters inserted into the stream since its creation, or since the last invocation of function getWCharacterArray(), or function clear(). Users are responsible for freeing the memory associated with the array returned by this function, by using operator delete[].

Implements RWWCharArrayOutputStreamImp.

virtual RWSize RWChainedWCharArrayOutputStreamImp::getWCharacterArraySize ( ) const
virtual

Returns the size of the wide character array that would be returned by a call to function getWCharacterArray().

Implements RWWCharArrayOutputStreamImp.

virtual bool RWChainedWCharArrayOutputStreamImp::isBad ( ) const
virtual

Return true if the last operation performed on the internal RWChainedMemoryStreambuf object failed.

Implements RWStreamImp.

virtual bool RWChainedWCharArrayOutputStreamImp::isFail ( ) const
virtual

Return true if the last operation performed on the internal RWChainedMemoryStreambuf object failed.

Implements RWStreamImp.

virtual bool RWChainedWCharArrayOutputStreamImp::isGood ( ) const
virtual

Returns true if the last operation performed on the internal RWChainedMemoryStreambuf object succeeded.

Implements RWStreamImp.

static RWWCharArrayOutputStream RWChainedWCharArrayOutputStreamImp::make ( void  )
inlinestatic

Constructs an RWChainedWCharArrayOutputStreamImp instance that uses an instance of class RWChainedMemoryStreambuf to store wide characters. The function returns a handle to the implementation class.

virtual void RWChainedWCharArrayOutputStreamImp::write ( wchar_t  wcharValue)
virtual

Writes a single wide character to the stream. Throws exception RWIncompleteStreamOperation.

Parameters
wcharValueThe wide character to be written.

Implements RWWCharOutputStreamImp.

virtual void RWChainedWCharArrayOutputStreamImp::write ( const wchar_t *  wcharArray,
RWSize  numWChars 
)
virtual

Writes an array of wide characters to the stream. Throws exception RWIncompleteStreamOperation.

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

Implements RWWCharOutputStreamImp.

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