RWDataFromCharInputStreamImp Class Reference
[Streams]

Abstract base class from which all input stream implementation classes that convert from data to narrow characters must derive. More...

#include <rw/stream/RWDataFromCharInputStreamImp.h>

Inheritance diagram for RWDataFromCharInputStreamImp:

List of all members.

Public Member Functions
virtual	~RWDataFromCharInputStreamImp ()
virtual void	close ()
virtual bool	isBad () const
virtual bool	isFail () const
virtual bool	isEof () const
virtual bool	isGood () const
virtual RWSize	available () const
virtual RWSize	skip (RWSize numUnits)
Protected Member Functions
	RWDataFromCharInputStreamImp (const RWCharInputStream &sourceStream)
RWCharInputStream &	getSourceStream ()
const RWCharInputStream &	getSourceStream () const

---

Detailed Description

Abstract base class for all the data from narrow character conversion input stream implementation classes. A conversion input stream, is a stream that uses an attached input stream of a different format as the source of elements to its own functions. Implements the body idiom from the handle-body pattern.

---

Constructor & Destructor Documentation

virtual RWDataFromCharInputStreamImp::~RWDataFromCharInputStreamImp

(

)

[virtual]

Destructor. Throws no exceptions.

RWDataFromCharInputStreamImp::RWDataFromCharInputStreamImp

(

const RWCharInputStream &

sourceStream

)

[inline, protected]

Used by derived classes to initialize the attached source stream.

Parameters:

sourceStream

A handle to the attached source stream.

---

Member Function Documentation

virtual RWSize RWDataFromCharInputStreamImp::available

(

)

const [virtual]

Returns the number of narrow characters that can be read from the attached source stream without blocking. Throws no exceptions

Implements RWInputStreamImp.

Reimplemented in RWIstreamDataFromCharInputStreamImp.

virtual void RWDataFromCharInputStreamImp::close

(

)

[virtual]

Forwards the close() request to the attached source stream.

Implements RWStreamImp.

Reimplemented in RWIstreamDataFromCharInputStreamImp.

const RWCharInputStream& RWDataFromCharInputStreamImp::getSourceStream

(

)

const [inline, protected]

Returns a handle to the attached source stream. They throw no exceptions.

RWCharInputStream& RWDataFromCharInputStreamImp::getSourceStream

(

)

[inline, protected]

Returns a handle to the attached source stream. They throw no exceptions.

virtual bool RWDataFromCharInputStreamImp::isBad

(

)

const [virtual]

Forwards the isBad() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWIstreamDataFromCharInputStreamImp.

virtual bool RWDataFromCharInputStreamImp::isEof

(

)

const [virtual]

Forwards the isEof() request to the attached source stream. Throws no exceptions.

Implements RWInputStreamImp.

Reimplemented in RWIstreamDataFromCharInputStreamImp.

virtual bool RWDataFromCharInputStreamImp::isFail

(

)

const [virtual]

Forwards the isFail() request to the attached source stream. Throws no exceptions

Implements RWStreamImp.

Reimplemented in RWIstreamDataFromCharInputStreamImp.

virtual bool RWDataFromCharInputStreamImp::isGood

(

)

const [virtual]

Forwards the isGood() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWIstreamDataFromCharInputStreamImp.

virtual RWSize RWDataFromCharInputStreamImp::skip

(

RWSize

numUnits

)

[virtual]

Skips numUnits narrow characters(s) from the input sequence of the attached source stream if possible. The function returns the actual number of narrow characters skipped, which can be any value between 0 and numUnits.

Parameters:

numUnits

The number of narrow characters to be skipped.

Implements RWInputStreamImp.

Reimplemented in RWIstreamDataFromCharInputStreamImp.