SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWWCharArrayOutputStreamImp Class Referenceabstract

Abstract base class for wide character output streams that support an extended interface, allowing retrieval of inserted data as a wide character array. More...

#include <rw/stream/RWWCharArrayOutputStreamImp.h>

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

Public Member Functions

virtual ~RWWCharArrayOutputStreamImp ()
 
virtual void clear ()=0
 
virtual wchar_t * getWCharacterArray ()=0
 
virtual RWSize getWCharacterArraySize () const =0
 
- Public Member Functions inherited from RWWCharOutputStreamImp
virtual ~RWWCharOutputStreamImp ()
 
virtual RWWCharOutputStream acquire ()
 
virtual void release ()
 
virtual void write (const wchar_t *wcharArray, RWSize numWchars)=0
 
virtual void write (wchar_t wcharValue)=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

 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 (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 wide character output streams that support an extended interface that allows retrieval of their inserted data as a wide character array. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

◆ ~RWWCharArrayOutputStreamImp()

virtual RWWCharArrayOutputStreamImp::~RWWCharArrayOutputStreamImp ( )
inlinevirtual

Destructor.

◆ RWWCharArrayOutputStreamImp()

RWWCharArrayOutputStreamImp::RWWCharArrayOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

◆ clear()

virtual void RWWCharArrayOutputStreamImp::clear ( )
pure virtual

Reset the underlying buffer.

Implemented in RWChainedWCharArrayOutputStreamImp.

◆ getWCharacterArray()

virtual wchar_t * RWWCharArrayOutputStreamImp::getWCharacterArray ( )
pure virtual

Returns a pointer to an array of wide characters containing the wide 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 RWChainedWCharArrayOutputStreamImp.

◆ getWCharacterArraySize()

virtual RWSize RWWCharArrayOutputStreamImp::getWCharacterArraySize ( ) const
pure virtual

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

Implemented in RWChainedWCharArrayOutputStreamImp.

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