rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWDataInputStreamImp Class Reference
[Streams]

Abstract base class from which all data input stream implementation classes must derive. More...

#include <rw/stream/RWDataInputStreamImp.h>

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

List of all members.

Public Member Functions

virtual ~RWDataInputStreamImp ()
virtual void getBool (bool &value)=0
virtual void getChar (char &value)=0
virtual void getUnsignedChar (unsigned char &value)=0
virtual void getSignedChar (signed char &value)=0
virtual void getShort (short &value)=0
virtual void getUnsignedShort (unsigned short &value)=0
virtual void getInt (int &value)=0
virtual void getUnsignedInt (unsigned int &value)=0
virtual void getLong (long &value)=0
virtual void getUnsignedLong (unsigned long &value)=0
virtual void getFloat (float &value)=0
virtual void getDouble (double &value)=0
virtual void getWchar_t (wchar_t &value)=0
virtual void getLongLong (long long &value)=0
virtual void getUnsignedLongLong (unsigned long long &value)=0
virtual void getLongDouble (long double &value)=0
virtual void getCharacter (char &value)=0
virtual void getWCharacter (wchar_t &value)=0
virtual void getUCharacter (RWUChar &value)=0
virtual void getSizeT (size_t &value)=0
virtual RWSize getBools (bool *arrayPt, RWSize count)=0
virtual RWSize getChars (char *arrayPt, RWSize count)=0
virtual RWSize getUnsignedChars (unsigned char *arrayPt, RWSize count)=0
virtual RWSize getSignedChars (signed char *arrayPt, RWSize count)=0
virtual RWSize getShorts (short *arrayPt, RWSize count)=0
virtual RWSize getUnsignedShorts (unsigned short *arrayPt, RWSize count)=0
virtual RWSize getInts (int *arrayPt, RWSize count)=0
virtual RWSize getUnsignedInts (unsigned int *arrayPt, RWSize count)=0
virtual RWSize getLongs (long *arrayPt, RWSize count)=0
virtual RWSize getUnsignedLongs (unsigned long *arrayPt, RWSize count)=0
virtual RWSize getFloats (float *arrayPt, RWSize count)=0
virtual RWSize getDoubles (double *arrayPt, RWSize count)=0
virtual RWSize getWchar_ts (wchar_t *arrayPt, RWSize count)=0
virtual RWSize getLongLongs (long long *arrayPt, RWSize count)=0
virtual RWSize getUnsignedLongLongs (unsigned long long *arrayPt, RWSize count)=0
virtual RWSize getLongDoubles (long double *arrayPt, RWSize count)=0
virtual RWSize getString (char *string, RWSize count)=0
virtual RWSize getWString (wchar_t *wstring, RWSize count)=0
virtual RWSize getUString (RWUChar *arrayPt, RWSize count)=0
virtual RWSize getDelimitedString (char *string, RWSize maxCount, char delim)=0
virtual RWSize getDelimitedWString (wchar_t *wstring, RWSize maxCount, wchar_t delim)=0
virtual RWSize getDelimitedUString (RWUChar *ustring, RWSize maxCount, RWUChar delim)=0
virtual RWDataInputStream acquire ()
virtual void release ()

Protected Member Functions

 RWDataInputStreamImp ()

Detailed Description

Abstract base class for all the data input stream implementation classes. Implements the body idiom from the handle-body pattern.


Constructor & Destructor Documentation

virtual RWDataInputStreamImp::~RWDataInputStreamImp (  )  [inline, virtual]

Destructor.

RWDataInputStreamImp::RWDataInputStreamImp (  )  [inline, protected]

Constructor. Throws no exceptions.


Member Function Documentation

virtual RWDataInputStream RWDataInputStreamImp::acquire ( void   )  [virtual]

Locks the monitor by acquiring the monitor's mutex.

Reimplemented from RWTMonitor< RWMutexLock >.

Reimplemented in RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getBool ( bool &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getBools ( bool *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getChar ( char &  value  )  [pure virtual]
virtual void RWDataInputStreamImp::getCharacter ( char &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getChars ( char *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWDataInputStreamImp::getDelimitedString ( char *  string,
RWSize  maxCount,
char  delim 
) [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.

Parameters:
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, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWDataInputStreamImp::getDelimitedUString ( RWUChar ustring,
RWSize  maxCount,
RWUChar  delim 
) [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.

Parameters:
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, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWDataInputStreamImp::getDelimitedWString ( wchar_t *  wstring,
RWSize  maxCount,
wchar_t  delim 
) [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.

Parameters:
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, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getDouble ( double &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getDoubles ( double *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getFloat ( float &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getFloats ( float *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getInt ( int &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getInts ( int *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getLong ( long &  value  )  [pure virtual]
virtual void RWDataInputStreamImp::getLongDouble ( long double &  value  )  [pure virtual]

Reads a long double value from the stream.

Parameters:
value The long double value to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual RWSize RWDataInputStreamImp::getLongDoubles ( long double *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getLongLong ( long long &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getLongLongs ( long long *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWDataInputStreamImp::getLongs ( long *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getShort ( short &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getShorts ( short *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getSignedChar ( signed char &  value  )  [pure virtual]

Reads a signed char value from the stream.

Parameters:
value The signed char value to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual RWSize RWDataInputStreamImp::getSignedChars ( signed char *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getSizeT ( size_t &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getString ( char *  string,
RWSize  count 
) [pure virtual]

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.

Parameters:
string A pointer to the string's first element.
count The number of elements to be read from the stream.

Implemented in RWCompactObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWObjectInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual void RWDataInputStreamImp::getUCharacter ( RWUChar value  )  [pure virtual]
virtual void RWDataInputStreamImp::getUnsignedChar ( unsigned char &  value  )  [pure virtual]

Reads a unsigned char value from the stream.

Parameters:
value The unsigned char value to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual RWSize RWDataInputStreamImp::getUnsignedChars ( unsigned char *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getUnsignedInt ( unsigned int &  value  )  [pure virtual]

Reads a unsigned int value from the stream.

Parameters:
value The unsigned int value to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual RWSize RWDataInputStreamImp::getUnsignedInts ( unsigned int *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getUnsignedLong ( unsigned long &  value  )  [pure virtual]

Reads a unsigned long value from the stream.

Parameters:
value The unsigned long value to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual void RWDataInputStreamImp::getUnsignedLongLong ( unsigned long long &  value  )  [pure virtual]

Reads a unsigned long long value from the stream.

Parameters:
value The unsigned long long value to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual RWSize RWDataInputStreamImp::getUnsignedLongLongs ( unsigned long long *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWDataInputStreamImp::getUnsignedLongs ( unsigned long *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getUnsignedShort ( unsigned short &  value  )  [pure virtual]

Reads a unsigned short value from the stream.

Parameters:
value The unsigned short value to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual RWSize RWDataInputStreamImp::getUnsignedShorts ( unsigned short *  arrayPt,
RWSize  count 
) [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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual RWSize RWDataInputStreamImp::getUString ( RWUChar arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the string's first element.
count The number of elements to be read from the stream.

Implemented in RWCompactObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWObjectInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual void RWDataInputStreamImp::getWchar_t ( wchar_t &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getWchar_ts ( wchar_t *  arrayPt,
RWSize  count 
) [pure virtual]

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.

Parameters:
arrayPt A pointer to the array's first element.
count The number of elements to be read from the stream.

Implemented in RWDataFromVirtualInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, and RWSynchronizedDataInputStreamImp.

virtual void RWDataInputStreamImp::getWCharacter ( wchar_t &  value  )  [pure virtual]
virtual RWSize RWDataInputStreamImp::getWString ( wchar_t *  wstring,
RWSize  count 
) [pure virtual]

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.

Parameters:
wstring A pointer to the string's first element.
count The number of elements to be read from the stream.

Implemented in RWCompactObjectInputStreamImp, RWDataFromVirtualInputStreamImp, RWObjectInputStreamImp, RWFilteredDataInputStreamImp, RWIstreamDataFromCharInputStreamImp, RWNativeDataFromByteInputStreamImp, RWSynchronizedDataInputStreamImp, RWEnhancedXmlObjectInputStreamImp, and RWXmlObjectInputStreamImp.

virtual void RWDataInputStreamImp::release ( void   )  [inline, virtual]

Unlocks the monitor by releasing the monitor's mutex.

Reimplemented from RWTMonitor< RWMutexLock >.

Reimplemented in RWSynchronizedDataInputStreamImp.

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.