RWInputStreamImp Class Reference
[Streams]

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

#include <rw/stream/RWInputStreamImp.h>

Inheritance diagram for RWInputStreamImp:

List of all members.

Public Member Functions
virtual	~RWInputStreamImp ()
virtual bool	isEof () const =0
virtual RWSize	available () const =0
virtual RWSize	skip (RWSize numUnits)=0
Protected Member Functions
	RWInputStreamImp ()

---

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

(

)

[inline, virtual]

Destructor.

RWInputStreamImp::RWInputStreamImp

(

)

[inline, protected]

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 RWDataFromVirtualInputStreamImp, RWByteFromStreambufInputStreamImp, RWCharFromStreambufInputStreamImp, RWDataFromByteInputStreamImp, RWDataFromCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredDataInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWUCharFromByteInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, and RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

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, RWByteFromStreambufInputStreamImp, RWCharFromStreambufInputStreamImp, RWDataFromByteInputStreamImp, RWDataFromCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredDataInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWUCharFromByteInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, and RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.

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 RWDataFromVirtualInputStreamImp, RWByteFromStreambufInputStreamImp, RWCharFromStreambufInputStreamImp, RWDataFromByteInputStreamImp, RWDataFromCharInputStreamImp, RWFilteredByteInputStreamImp, RWFilteredCharInputStreamImp, RWFilteredDataInputStreamImp, RWFilteredUCharInputStreamImp, RWFilteredWCharInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWUCharFromByteInputStreamImp, RWUCharFromUTF8ByteInputStreamImp, RWWCharFromWStreambufInputStreamImp, RWTInputStreamBufferImp< RWCharInputStream, RWFilteredCharInputStreamImp >, RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >, RWTInputStreamLockImp< RWWCharInputStream, RWFilteredWCharInputStreamImp >, RWTInputStreamLockImp< RWCharInputStream, RWFilteredCharInputStreamImp >, and RWTInputStreamLockImp< RWByteInputStream, RWFilteredByteInputStreamImp >.