SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Abstract base class for all the filtered data input stream implementation classes. More...
#include <rw/stream/RWFilteredDataInputStreamImp.h>
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 () |
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 |
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.
|
virtual |
Destructor. Throws no exceptions.
|
inlineprotected |
Used by derived classes to initialize the attached source stream. Throws no exceptions.
sourceStream | A handle to the attached source stream. |
|
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 |
Forward the close() request to the attached source stream.
Implements RWStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single bool
value from the attached source stream.
value | The value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
Forward the reading of an array of bool
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single char
value from the attached source stream.
value | The char value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of a narrow character from the attached source stream.
value | The narrow character to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
Forward the reading of an array of char
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
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.
string | A pointer to the string receiving the narrow character(s) extracted from the stream. |
maxCount | The maximum number of narrow character(s) to be read. |
delim | The narrow character used as a delimiter. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
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.
ustring | A pointer to the string receiving the unicode character(s) extracted from the stream. |
maxCount | The maximum number of unicode character(s) to be read. |
delim | The unicode character used as a delimiter. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
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.
wstring | A pointer to the string receiving the wide character(s) extracted from the stream. |
maxCount | The maximum number of wide character(s) to be read. |
delim | The wide character used as a delimiter. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single double
value from the attached source stream.
value | The double value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
Forward the reading of an array of double
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single float
value from the attached source stream.
value | The float value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
Forward the reading of an array of float
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single int
value from the attached source stream.
value | The int value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
Forward the reading of an array of int
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single long
value from the attached source stream.
value | The long value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single long double
value from the attached source stream.
value | The long double value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of long double
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single long long
value from the attached source stream.
value | The long long value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of long long
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
Forward the reading of an array of long
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single short
value from the attached source stream.
value | The short value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
Forward the reading of an array of short
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single signed char
value from the attached source stream.
value | The signed char value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of signed char
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Reads a size_t
value from the stream.
value | The size_t value to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
inlineprotected |
Returns a handle to the attached source stream. Throws no exceptions.
|
inlineprotected |
Returns a handle to the attached source stream. Throws no exceptions.
Forward the reading of a string of narrow characters from the attached source stream. The function returns the number of narrow characters read.
string | A pointer to the first element of the string. The string must have been pre-allocated to contain at least count narrow characters. |
count | The number of narrow character(s) to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.
|
virtual |
Forward the reading of a UTF-16 character from the attached source stream.
value | The unicode character to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single unsigned char
value from the attached source stream.
value | The unsigned char value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of unsigned char
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single unsigned int
value from the attached source stream.
value | The unsigned int value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of unsigned int
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single unsigned long
value from the attached source stream.
value | The unsigned long value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single unsigned long long
value from the attached source stream.
value | The unsigned long long value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
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.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of unsigned long
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward reading of a single unsigned short
value from the attached source stream.
value | The unsigned short value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of unsigned short
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
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.
ustring | A pointer to the first element of the string. The string must have been pre-allocated to contain at least count unicode characters. |
count | The number of unicode character(s) to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.
|
virtual |
Forward reading of a single wchar_t
value from the attached source stream.
value | The wchar_t value to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of an array of wchar_t
elements from the attached source stream. The function returns the number of elements read.
arrayPt | A pointer to the first element of the array. The array must have been pre-allocated to contain at least count elements. |
count | The number of elements to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the reading of a wide character from the attached source stream.
value | The wide character to be read from the attached source stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWSynchronizedDataInputStreamImp.
Forward the reading of a string of wide characters from the attached source stream. The function returns the number of wide characters read.
wstring | A pointer to the first element of the string. The string must have been pre-allocated to contain at least count wide characters. |
count | The number of wide character(s) to be read from the stream. |
Implements RWDataInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.
|
virtual |
Forward the isBad() request to the attached source stream. Throws no exceptions.
Implements RWStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the isEof() request to the attached source stream. Throws no exceptions.
Implements RWInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the isFail() request to the attached source stream. Throws no exceptions.
Implements RWStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
|
virtual |
Forward the isGood() request to the attached source stream. Throws no exceptions.
Implements RWStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
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.
numUnits | The number of element(s) to be skipped. |
Implements RWInputStreamImp.
Reimplemented in RWSynchronizedDataInputStreamImp.
Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |