 SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Abstract base class from which all data input stream implementation classes must derive. More...
#include <rw/stream/RWDataInputStreamImp.h>
Public Member Functions | |
| virtual | ~RWDataInputStreamImp () |
| virtual void | getBool (bool &value)=0 |
| virtual RWSize | getBools (bool *arrayPt, RWSize count)=0 |
| virtual void | getChar (char &value)=0 |
| virtual void | getCharacter (char &value)=0 |
| virtual RWSize | getChars (char *arrayPt, RWSize count)=0 |
| virtual RWSize | getDelimitedString (char *string, RWSize maxCount, char delim)=0 |
| virtual RWSize | getDelimitedUString (RWUChar *ustring, RWSize maxCount, RWUChar delim)=0 |
| virtual RWSize | getDelimitedWString (wchar_t *wstring, RWSize maxCount, wchar_t delim)=0 |
| virtual void | getDouble (double &value)=0 |
| virtual RWSize | getDoubles (double *arrayPt, RWSize count)=0 |
| virtual void | getFloat (float &value)=0 |
| virtual RWSize | getFloats (float *arrayPt, RWSize count)=0 |
| virtual void | getInt (int &value)=0 |
| virtual RWSize | getInts (int *arrayPt, RWSize count)=0 |
| virtual void | getLong (long &value)=0 |
| virtual void | getLongDouble (long double &value)=0 |
| virtual RWSize | getLongDoubles (long double *arrayPt, RWSize count)=0 |
| virtual void | getLongLong (long long &value)=0 |
| virtual RWSize | getLongLongs (long long *arrayPt, RWSize count)=0 |
| virtual RWSize | getLongs (long *arrayPt, RWSize count)=0 |
| virtual void | getShort (short &value)=0 |
| virtual RWSize | getShorts (short *arrayPt, RWSize count)=0 |
| virtual void | getSignedChar (signed char &value)=0 |
| virtual RWSize | getSignedChars (signed char *arrayPt, RWSize count)=0 |
| virtual void | getSizeT (size_t &value)=0 |
| virtual RWSize | getString (char *string, RWSize count)=0 |
| virtual void | getUCharacter (RWUChar &value)=0 |
| virtual void | getUnsignedChar (unsigned char &value)=0 |
| virtual RWSize | getUnsignedChars (unsigned char *arrayPt, RWSize count)=0 |
| virtual void | getUnsignedInt (unsigned int &value)=0 |
| virtual RWSize | getUnsignedInts (unsigned int *arrayPt, RWSize count)=0 |
| virtual void | getUnsignedLong (unsigned long &value)=0 |
| virtual void | getUnsignedLongLong (unsigned long long &value)=0 |
| virtual RWSize | getUnsignedLongLongs (unsigned long long *arrayPt, RWSize count)=0 |
| virtual RWSize | getUnsignedLongs (unsigned long *arrayPt, RWSize count)=0 |
| virtual void | getUnsignedShort (unsigned short &value)=0 |
| virtual RWSize | getUnsignedShorts (unsigned short *arrayPt, RWSize count)=0 |
| virtual RWSize | getUString (RWUChar *arrayPt, RWSize count)=0 |
| virtual void | getWchar_t (wchar_t &value)=0 |
| virtual RWSize | getWchar_ts (wchar_t *arrayPt, RWSize count)=0 |
| virtual void | getWCharacter (wchar_t &value)=0 |
| virtual RWSize | getWString (wchar_t *wstring, RWSize count)=0 |
 Public Member Functions inherited from RWInputStreamImp | |
| 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 |
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 data input stream implementation classes. Implements the body idiom from the handle-body pattern.
|
inlinevirtual |
Destructor.
|
inlineprotected |
Constructor. Throws no exceptions.
|
pure virtual |
Reads a bool value from the stream.
| value | The bool value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of bool value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a char value from the stream.
| value | The char value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a char value from the stream.
| value | The char value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWObjectInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of char value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads 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 characters extracted from the stream. |
| maxCount | The maximum number of narrow characters to be read. |
| delim | The narrow character used as a delimiter. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads 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 UTF-16 characters extracted from the stream. |
| maxCount | The maximum number of UTF-16 characters to be read. |
| delim | The UTF-16 character used as a delimiter. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads 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 characters extracted from the stream. |
| maxCount | The maximum number of wide characters to be read. |
| delim | The wide character used as a delimiter. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a double value from the stream.
| value | The double value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of double value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a float value from the stream.
| value | The float value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of float value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a int value from the stream.
| value | The int value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of int value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a long value from the stream.
| value | The long value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a long double value from the stream.
| value | The long double value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of long double value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a long long value from the stream.
| value | The long long value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of long long value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of long value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a short value from the stream.
| value | The short value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of short value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a signed char value from the stream.
| value | The signed char value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of signed char value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a size_t value from the stream.
| value | The size_t value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads a narrow character string from the stream. The string must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| string | A pointer to the string's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.
|
pure virtual |
Reads a UTF-16 character from the stream.
| value | The UTF-16 value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a unsigned char value from the stream.
| value | The unsigned char value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of unsigned char value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a unsigned int value from the stream.
| value | The unsigned int value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of unsigned int value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a unsigned long value from the stream.
| value | The unsigned long value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a unsigned long long value from the stream.
| value | The unsigned long long value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of unsigned long long value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of unsigned long value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a unsigned short value from the stream.
| value | The unsigned short value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWFilteredDataInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads an array of unsigned short value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads a UTF-16 character string from the stream. The string must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the string's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.
|
pure virtual |
Reads a wchar_t value from the stream.
| value | The wchar_t value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads an array of wchar_t value(s) from the stream. The array must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| arrayPt | A pointer to the array's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
|
pure virtual |
Reads a wchar_t value from the stream.
| value | The wchar_t value to be read from the stream. |
Implemented in RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, and RWNativeDataFromByteInputStreamImp.
Reads a wide character string from the stream. The string must have been pre-allocated to contain at least count elements. The functions return the number of elements read.
| wstring | A pointer to the string's first element. |
| count | The number of elements to be read from the stream. |
Implemented in RWDataFromVirtualInputStreamImp, RWSynchronizedDataInputStreamImp, RWFilteredDataInputStreamImp, RWXmlObjectInputStreamImp, RWEnhancedXmlObjectInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWObjectInputStreamImp, and RWCompactObjectInputStreamImp.
|
Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |
