SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Protected Member Functions
RWFilteredDataInputStreamImp Class Reference

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

#include <rw/stream/RWFilteredDataInputStreamImp.h>

Inheritance diagram for RWFilteredDataInputStreamImp:
RWDataInputStreamImp RWInputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWObjectInputStreamImp RWSynchronizedDataInputStreamImp RWCompactObjectInputStreamImp RWEnhancedXmlObjectInputStreamImp RWXmlObjectInputStreamImp RWTParsedTransformObjectInputStreamImp< Transform > RWTTransformObjectInputStreamImp< Transform >

Public Member Functions

virtual ~RWFilteredDataInputStreamImp ()
 
virtual RWSize available () const
 
virtual void close ()
 
virtual void getBool (bool &value)
 
virtual RWSize getBools (bool *arrayPt, RWSize count)
 
virtual void getChar (char &value)
 
virtual void getCharacter (char &value)
 
virtual RWSize getChars (char *arrayPt, RWSize count)
 
virtual RWSize getDelimitedString (char *string, RWSize maxCount, char delim)
 
virtual RWSize getDelimitedUString (RWUChar *ustring, RWSize maxCount, RWUChar delim)
 
virtual RWSize getDelimitedWString (wchar_t *wstring, RWSize maxCount, wchar_t delim)
 
virtual void getDouble (double &value)
 
virtual RWSize getDoubles (double *arrayPt, RWSize count)
 
virtual void getFloat (float &value)
 
virtual RWSize getFloats (float *arrayPt, RWSize count)
 
virtual void getInt (int &value)
 
virtual RWSize getInts (int *arrayPt, RWSize count)
 
virtual void getLong (long &value)
 
virtual void getLongDouble (long double &value)
 
virtual RWSize getLongDoubles (long double *arrayPt, RWSize count)
 
virtual void getLongLong (long long &value)
 
virtual RWSize getLongLongs (long long *arrayPt, RWSize count)
 
virtual RWSize getLongs (long *arrayPt, RWSize count)
 
virtual void getShort (short &value)
 
virtual RWSize getShorts (short *arrayPt, RWSize count)
 
virtual void getSignedChar (signed char &value)
 
virtual RWSize getSignedChars (signed char *arrayPt, RWSize count)
 
virtual void getSizeT (size_t &value)
 
virtual RWSize getString (char *string, RWSize count)
 
virtual void getUCharacter (RWUChar &value)
 
virtual void getUnsignedChar (unsigned char &value)
 
virtual RWSize getUnsignedChars (unsigned char *arrayPt, RWSize count)
 
virtual void getUnsignedInt (unsigned int &value)
 
virtual RWSize getUnsignedInts (unsigned int *arrayPt, RWSize count)
 
virtual void getUnsignedLong (unsigned long &value)
 
virtual void getUnsignedLongLong (unsigned long long &value)
 
virtual RWSize getUnsignedLongLongs (unsigned long long *arrayPt, RWSize count)
 
virtual RWSize getUnsignedLongs (unsigned long *arrayPt, RWSize count)
 
virtual void getUnsignedShort (unsigned short &value)
 
virtual RWSize getUnsignedShorts (unsigned short *arrayPt, RWSize count)
 
virtual RWSize getUString (RWUChar *ustring, RWSize count)
 
virtual void getWchar_t (wchar_t &value)
 
virtual RWSize getWchar_ts (wchar_t *arrayPt, RWSize count)
 
virtual void getWCharacter (wchar_t &value)
 
virtual RWSize getWString (wchar_t *wstring, RWSize count)
 
virtual bool isBad () const
 
virtual bool isEof () const
 
virtual bool isFail () const
 
virtual bool isGood () const
 
virtual RWSize skip (RWSize numUnits)
 
- Public Member Functions inherited from RWDataInputStreamImp
virtual ~RWDataInputStreamImp ()
 
- Public Member Functions inherited from RWInputStreamImp
virtual ~RWInputStreamImp ()
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 

Protected Member Functions

 RWFilteredDataInputStreamImp (const RWDataInputStream &sourceStream)
 
RWDataInputStreamgetSourceStream ()
 
const RWDataInputStreamgetSourceStream () const
 
- Protected Member Functions inherited from RWDataInputStreamImp
 RWDataInputStreamImp ()
 
- Protected Member Functions inherited from RWInputStreamImp
 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)
 
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 all the filtered data input stream implementation classes. A filtered input stream is a stream that uses its attached input stream as the source of elements to its own functions. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWFilteredDataInputStreamImp::~RWFilteredDataInputStreamImp ( )
virtual

Destructor. Throws no exceptions.

RWFilteredDataInputStreamImp::RWFilteredDataInputStreamImp ( const RWDataInputStream sourceStream)
inlineprotected

Used by derived classes to initialize the attached source stream. Throws no exceptions.

Parameters
sourceStreamA handle to the attached source stream.

Member Function Documentation

virtual RWSize RWFilteredDataInputStreamImp::available ( ) const
virtual

Returns the number of elements that can be read from the attached source stream without blocking. The elements can be of type RWByte, char, RWUChar, or wchar_t depending on the type of the attached source stream. Throws no exceptions.

Implements RWInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::close ( )
virtual

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

Implements RWStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getBool ( bool &  value)
virtual

Forward reading of a single bool value from the attached source stream.

Parameters
valueThe value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getBools ( bool *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of bool elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getChar ( char &  value)
virtual

Forward reading of a single char value from the attached source stream.

Parameters
valueThe char value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getCharacter ( char &  value)
virtual

Forward the reading of a narrow character from the attached source stream.

Parameters
valueThe narrow character to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getChars ( char *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of char elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getDelimitedString ( char *  string,
RWSize  maxCount,
char  delim 
)
virtual

Forward the reading of narrow characters from the stream until the last character read is equal to delim, or maxCount narrow characters have been read, or the end of the input sequence is reached. The narrow characters read are stored in string. The function returns the actual number of narrow characters read from the stream.

Parameters
stringA pointer to the string receiving the narrow character(s) extracted from the stream.
maxCountThe maximum number of narrow character(s) to be read.
delimThe narrow character used as a delimiter.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getDelimitedUString ( RWUChar ustring,
RWSize  maxCount,
RWUChar  delim 
)
virtual

Forward the reading of UTF-16 characters from the stream until the last character read is equal to delim, or maxCount UTF-16 characters have been read, or the end of the input sequence is reached. The UTF-16 characters read are stored in ustring. The function returns the actual number of UTF-16 characters read from the stream.

Parameters
ustringA pointer to the string receiving the unicode character(s) extracted from the stream.
maxCountThe maximum number of unicode character(s) to be read.
delimThe unicode character used as a delimiter.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getDelimitedWString ( wchar_t *  wstring,
RWSize  maxCount,
wchar_t  delim 
)
virtual

Forward the reading of wide characters from the stream until the last character read is equal to delim, or maxCount wide characters have been read, or the end of the input sequence is reached. The wide characters read are stored in wstring. The function returns the actual number of wide characters read from the stream.

Parameters
wstringA pointer to the string receiving the wide character(s) extracted from the stream.
maxCountThe maximum number of wide character(s) to be read.
delimThe wide character used as a delimiter.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getDouble ( double &  value)
virtual

Forward reading of a single double value from the attached source stream.

Parameters
valueThe double value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getDoubles ( double *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of double elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getFloat ( float &  value)
virtual

Forward reading of a single float value from the attached source stream.

Parameters
valueThe float value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getFloats ( float *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of float elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getInt ( int &  value)
virtual

Forward reading of a single int value from the attached source stream.

Parameters
valueThe int value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getInts ( int *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of int elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getLong ( long &  value)
virtual

Forward reading of a single long value from the attached source stream.

Parameters
valueThe long value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getLongDouble ( long double &  value)
virtual

Forward reading of a single long double value from the attached source stream.

Parameters
valueThe long double value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getLongDoubles ( long double *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of long double elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getLongLong ( long long &  value)
virtual

Forward reading of a single long long value from the attached source stream.

Parameters
valueThe long long value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getLongLongs ( long long *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of long long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getLongs ( long *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getShort ( short &  value)
virtual

Forward reading of a single short value from the attached source stream.

Parameters
valueThe short value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getShorts ( short *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of short elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getSignedChar ( signed char &  value)
virtual

Forward reading of a single signed char value from the attached source stream.

Parameters
valueThe signed char value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getSignedChars ( signed char *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of signed char elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getSizeT ( size_t &  value)
virtual

Reads a size_t value from the stream.

Parameters
valueThe size_t value to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

RWDataInputStream& RWFilteredDataInputStreamImp::getSourceStream ( )
inlineprotected

Returns a handle to the attached source stream. Throws no exceptions.

const RWDataInputStream& RWFilteredDataInputStreamImp::getSourceStream ( ) const
inlineprotected

Returns a handle to the attached source stream. Throws no exceptions.

virtual RWSize RWFilteredDataInputStreamImp::getString ( char *  string,
RWSize  count 
)
virtual

Forward the reading of a string of narrow characters from the attached source stream. The function returns the number of narrow characters read.

Parameters
stringA pointer to the first element of the string. The string must have been pre-allocated to contain at least count narrow characters.
countThe number of narrow character(s) to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getUCharacter ( RWUChar value)
virtual

Forward the reading of a UTF-16 character from the attached source stream.

Parameters
valueThe unicode character to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getUnsignedChar ( unsigned char &  value)
virtual

Forward reading of a single unsigned char value from the attached source stream.

Parameters
valueThe unsigned char value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getUnsignedChars ( unsigned char *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of unsigned char elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getUnsignedInt ( unsigned int &  value)
virtual

Forward reading of a single unsigned int value from the attached source stream.

Parameters
valueThe unsigned int value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getUnsignedInts ( unsigned int *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of unsigned int elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getUnsignedLong ( unsigned long &  value)
virtual

Forward reading of a single unsigned long value from the attached source stream.

Parameters
valueThe unsigned long value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getUnsignedLongLong ( unsigned long long &  value)
virtual

Forward reading of a single unsigned long long value from the attached source stream.

Parameters
valueThe unsigned long long value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getUnsignedLongLongs ( unsigned long long *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of unsigned long long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getUnsignedLongs ( unsigned long *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of unsigned long elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getUnsignedShort ( unsigned short &  value)
virtual

Forward reading of a single unsigned short value from the attached source stream.

Parameters
valueThe unsigned short value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getUnsignedShorts ( unsigned short *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of unsigned short elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getUString ( RWUChar ustring,
RWSize  count 
)
virtual

Forward the reading of a string of UTF-16 characters from the attached source stream. The function returns the number of UTF-16 characters read.

Parameters
ustringA pointer to the first element of the string. The string must have been pre-allocated to contain at least count unicode characters.
countThe number of unicode character(s) to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getWchar_t ( wchar_t &  value)
virtual

Forward reading of a single wchar_t value from the attached source stream.

Parameters
valueThe wchar_t value to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getWchar_ts ( wchar_t *  arrayPt,
RWSize  count 
)
virtual

Forward the reading of an array of wchar_t elements from the attached source stream. The function returns the number of elements read.

Parameters
arrayPtA pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements.
countThe number of elements to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWFilteredDataInputStreamImp::getWCharacter ( wchar_t &  value)
virtual

Forward the reading of a wide character from the attached source stream.

Parameters
valueThe wide character to be read from the attached source stream.

Implements RWDataInputStreamImp.

Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::getWString ( wchar_t *  wstring,
RWSize  count 
)
virtual

Forward the reading of a string of wide characters from the attached source stream. The function returns the number of wide characters read.

Parameters
wstringA pointer to the first element of the string. The string must have been pre-allocated to contain at least count wide characters.
countThe number of wide character(s) to be read from the stream.

Implements RWDataInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.

virtual bool RWFilteredDataInputStreamImp::isBad ( ) const
virtual

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

Implements RWStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual bool RWFilteredDataInputStreamImp::isEof ( ) const
virtual

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

Implements RWInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual bool RWFilteredDataInputStreamImp::isFail ( ) const
virtual

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

Implements RWStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual bool RWFilteredDataInputStreamImp::isGood ( ) const
virtual

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

Implements RWStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual RWSize RWFilteredDataInputStreamImp::skip ( RWSize  numUnits)
virtual

Skips numUnits elements from the input sequence of the attached source stream if possible. The function returns the actual number of elements skipped, which can be any value between 0 and numUnits. The elements can be of type RWByte, char, RWUChar, or wchar_t depending on the type of the attached source stream.

Parameters
numUnitsThe number of element(s) to be skipped.

Implements RWInputStreamImp.

Reimplemented in RWSynchronizedDataInputStreamImp.

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