SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Protected Member Functions
RWCharArrayOutputStreamImp Class Referenceabstract

Abstract base class for narrow character output streams that allow retrieval of their inserted data as a character array. More...

#include <rw/stream/RWCharArrayOutputStreamImp.h>

Inheritance diagram for RWCharArrayOutputStreamImp:
RWCharOutputStreamImp RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWChainedCharArrayOutputStreamImp

Public Member Functions

virtual ~RWCharArrayOutputStreamImp ()
 
virtual void clear ()=0
 
virtual char * getCharacterArray ()=0
 
virtual RWSize getCharacterArraySize () const =0
 
virtual RWCString getString ()=0
 
- Public Member Functions inherited from RWCharOutputStreamImp
virtual ~RWCharOutputStreamImp ()
 
virtual RWCharOutputStream acquire ()
 
virtual void release ()
 
virtual void write (char charValue)=0
 
virtual void write (const char *charArray, RWSize numChars)=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

 RWCharArrayOutputStreamImp ()
 
- Protected Member Functions inherited from RWCharOutputStreamImp
 RWCharOutputStreamImp ()
 
- 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 narrow character output streams that support an extended interface that allows retrieval of their inserted data as a character array. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWCharArrayOutputStreamImp::~RWCharArrayOutputStreamImp ( )
inlinevirtual

Destructor.

RWCharArrayOutputStreamImp::RWCharArrayOutputStreamImp ( )
inlineprotected

Constructor.

Member Function Documentation

virtual void RWCharArrayOutputStreamImp::clear ( )
pure virtual

Resets the underlying buffer.

Implemented in RWChainedCharArrayOutputStreamImp.

virtual char* RWCharArrayOutputStreamImp::getCharacterArray ( )
pure virtual

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

virtual RWSize RWCharArrayOutputStreamImp::getCharacterArraySize ( ) const
pure virtual

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

Implemented in RWChainedCharArrayOutputStreamImp.

virtual RWCString RWCharArrayOutputStreamImp::getString ( )
pure virtual

Returns a narrow character string object containing the characters inserted into the stream since its creation.

Implemented in RWChainedCharArrayOutputStreamImp.

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