RWInputStreamImp Class Reference

Abstract base class for all the input stream implementation classes. More...

#include <rw/stream/RWInputStreamImp.h>

Inheritance diagram for RWInputStreamImp:

Public Member Functions
virtual	~RWInputStreamImp ()
virtual RWSize	available () const =0
virtual bool	isEof () const =0
virtual RWSize	skip (RWSize numUnits)=0
Public Member Functions inherited from RWStreamImp
virtual	~RWStreamImp ()
virtual void	close ()=0
virtual bool	isBad () const =0
virtual bool	isFail () const =0
virtual bool	isGood () const =0

Protected Member Functions
	RWInputStreamImp ()
Protected Member Functions inherited from RWStreamImp
	RWStreamImp ()
Protected Member Functions inherited from RWBodyBase
	RWBodyBase (void)
	RWBodyBase (RWStaticCtor)
	RWBodyBase (const RWBodyBase &second)
virtual	~RWBodyBase (void)
RWBodyBase &	operator= (const RWBodyBase &second)
Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
	~RWTCountingBody (void)
unsigned	addReference (void)
unsigned	references (void) const
unsigned	removeReference (void)
	RWTCountingBody (unsigned initCount=0)
	RWTCountingBody (RWStaticCtor)
	RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
RWTCountingBody< RWMutexLock > &	operator= (const RWTCountingBody< RWMutexLock > &second)

Additional Inherited Members

Detailed Description

Abstract base class for all the input stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWInputStreamImp::~RWInputStreamImp ( )

inlinevirtual

Destructor.

RWInputStreamImp::RWInputStreamImp ( )

inlineprotected

Constructor.

Member Function Documentation

virtual RWSize RWInputStreamImp::available ( ) const

pure virtual

Returns the number of available elements that can be read from the stream without blocking. The type of the elements read is specified by derived classes and can be one of the following: RWByte, char, RWUChar, or wchar_t. Throws no exceptions.

Implemented in RWFilteredDataInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWCharFromStreambufInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWByteFromStreambufInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWDataFromVirtualInputStreamImp, RWUCharFromByteInputStreamImp, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWFilteredUCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredWCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWDataFromByteInputStreamImp, and RWDataFromCharInputStreamImp.

virtual bool RWInputStreamImp::isEof ( ) const

pure virtual

Returns true to indicate that an input operation reached the end of an input sequence. Throws no exceptions.

Implemented in RWDataFromVirtualInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWUCharFromUTF8ByteInputStreamImp, RWUCharFromByteInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWByteFromStreambufInputStreamImp, RWDataFromByteInputStreamImp, RWDataFromCharInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWCharFromStreambufInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, and RWFilteredDataInputStreamImp.

virtual RWSize RWInputStreamImp::skip ( RWSize  numUnits )

pure virtual

Skips numUnits elements from the input sequence if possible. The function returns the actual number of elements skipped, which can be any value between 0 and numUnits. The type of the elements skipped is specified by derived classes and can be one of the following: RWByte, char, RWUChar, or wchar_t.

Parameters

numUnits

The number of elements to be skipped.

Implemented in RWFilteredDataInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWCharFromStreambufInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWDataFromVirtualInputStreamImp, RWByteFromStreambufInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWUCharFromByteInputStreamImp, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >, RWFilteredUCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredWCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWDataFromByteInputStreamImp, and RWDataFromCharInputStreamImp.