RWFilteredByteOutputStreamImp Class Reference

Abstract base class for all the filtered binary output stream implementation classes. More...

#include <rw/stream/RWFilteredByteOutputStreamImp.h>

Inheritance diagram for RWFilteredByteOutputStreamImp:

Public Member Functions
virtual	~RWFilteredByteOutputStreamImp ()
virtual void	close ()
virtual void	flush ()
virtual bool	isBad () const
virtual bool	isFail () const
virtual bool	isGood () const
virtual void	write (const RWByte *byteArray, RWSize numBytes)
virtual void	write (RWByte byteValue)
Public Member Functions inherited from RWByteOutputStreamImp
virtual	~RWByteOutputStreamImp ()
virtual RWByteOutputStream	acquire ()
virtual void	release ()
Public Member Functions inherited from RWOutputStreamImp
virtual	~RWOutputStreamImp ()
Public Member Functions inherited from RWStreamImp
virtual	~RWStreamImp ()

Protected Member Functions
	RWFilteredByteOutputStreamImp (const RWByteOutputStream &sinkStream)
RWByteOutputStream &	getSinkStream ()
const RWByteOutputStream &	getSinkStream () const
Protected Member Functions inherited from RWByteOutputStreamImp
	RWByteOutputStreamImp ()
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)
RWBodyBase &	operator= (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
RWMutexLock &	mutex (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 all the filtered binary output stream implementation classes. A filtered output stream is a stream that process elements and then forwards the result to another stream for further processing. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

~RWFilteredByteOutputStreamImp()

virtual RWFilteredByteOutputStreamImp::~RWFilteredByteOutputStreamImp ( )

virtual

Destructor. Throws no exceptions.

RWFilteredByteOutputStreamImp()

RWFilteredByteOutputStreamImp::RWFilteredByteOutputStreamImp ( const RWByteOutputStream & sinkStream )

inlineprotected

Used by derived classes to initialize the next processing stream.

Parameters

sinkStream

A handle to the next processing stream.

Member Function Documentation

close()

virtual void RWFilteredByteOutputStreamImp::close ( )

virtual

Forwards the close() request to the next processing stream.

Reimplemented from RWOutputStreamImp.

flush()

virtual void RWFilteredByteOutputStreamImp::flush ( )

virtual

Forwards the flush() request to the next processing stream.

Implements RWOutputStreamImp.

getSinkStream() [1/2]

RWByteOutputStream & RWFilteredByteOutputStreamImp::getSinkStream ( )

inlineprotected

Return a handle to the next processing stream. Throws no exceptions.

getSinkStream() [2/2]

const RWByteOutputStream & RWFilteredByteOutputStreamImp::getSinkStream ( ) const

inlineprotected

Return a handle to the next processing stream. Throws no exceptions.

isBad()

virtual bool RWFilteredByteOutputStreamImp::isBad ( ) const

virtual

Forwards the isBad() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

isFail()

virtual bool RWFilteredByteOutputStreamImp::isFail ( ) const

virtual

Forwards the isFail() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

isGood()

virtual bool RWFilteredByteOutputStreamImp::isGood ( ) const

virtual

Forwards the isGood() request to the next processing stream. Throws no exceptions.

Implements RWStreamImp.

write() [1/2]

virtual void RWFilteredByteOutputStreamImp::write ( const RWByte * byteArray, RWSize numBytes )

virtual

Forwards the writing of an array of bytes to the next processing stream.

Parameters

byteArray	A pointer to the first element of the array.
numBytes	The number of byte(s) to be written to the stream.

Implements RWByteOutputStreamImp.

write() [2/2]

virtual void RWFilteredByteOutputStreamImp::write ( RWByte byteValue )

virtual

Forwards the writing of a single byte to the next processing stream.

Parameters

byteValue

The byte to be written.

Implements RWByteOutputStreamImp.