SourcePro C++ 12.0
SourcePro® C++ API Reference Guide
SourcePro C++
Documentation Home
SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Adaptor class that adapts the Rogue Wave virtual stream interface to the Rogue Wave data input stream interface. More...
#include <rw/stream/RWvistreamFromDataInputStream.h>
Public Member Functions | |
| RWvistreamFromDataInputStream (const RWDataInputStream &sourceStream) | |
| virtual | ~RWvistreamFromDataInputStream () |
| virtual int | eof () |
| virtual int | fail () |
| virtual int | bad () |
| virtual int | good () |
| virtual int | rdstate () |
| virtual void | clear (int v=0) |
| virtual int | get () |
| virtual RWvistream & | get (char &value) |
| virtual RWvistream & | get (wchar_t &value) |
| virtual RWvistream & | get (unsigned char &value) |
| virtual RWvistream & | get (bool &value) |
| virtual RWvistream & | get (bool *arrayPt, size_t count) |
| virtual RWvistream & | get (char *arrayPt, size_t count) |
| virtual RWvistream & | get (double *arrayPt, size_t count) |
| virtual RWvistream & | get (float *arrayPt, size_t count) |
| virtual RWvistream & | get (int *arrayPt, size_t count) |
| virtual RWvistream & | get (long *arrayPt, size_t count) |
| virtual RWvistream & | get (short *arrayPt, size_t count) |
| virtual RWvistream & | get (wchar_t *arrayPt, size_t count) |
| virtual RWvistream & | get (unsigned char *arrayPt, size_t count) |
| virtual RWvistream & | get (unsigned short *arrayPt, size_t count) |
| virtual RWvistream & | get (unsigned int *arrayPt, size_t count) |
| virtual RWvistream & | get (unsigned long *arrayPt, size_t count) |
| virtual RWvistream & | get (long double *arrayPt, size_t count) |
| virtual RWvistream & | get (long long *arrayPt, size_t count) |
| virtual RWvistream & | get (unsigned long long *arrayPt, size_t count) |
| virtual RWvistream & | getString (char *string, size_t count) |
| virtual RWvistream & | operator>> (char &value) |
| virtual RWvistream & | operator>> (double &value) |
| virtual RWvistream & | operator>> (float &value) |
| virtual RWvistream & | operator>> (int &value) |
| virtual RWvistream & | operator>> (long &value) |
| virtual RWvistream & | operator>> (short &value) |
| virtual RWvistream & | operator>> (wchar_t &value) |
| virtual RWvistream & | operator>> (unsigned char &value) |
| virtual RWvistream & | operator>> (unsigned short &value) |
| virtual RWvistream & | operator>> (unsigned int &value) |
| virtual RWvistream & | operator>> (unsigned long &value) |
| virtual RWvistream & | operator>> (long double &value) |
| virtual RWvistream & | operator>> (long long &value) |
| virtual RWvistream & | operator>> (unsigned long long &value) |
| virtual RWvistream & | getSizeT (size_t &value) |
Protected Member Functions | |
| RWDataInputStream & | getSourceStream () |
| const RWDataInputStream & | getSourceStream () const |
The class RWvistreamFromDataInputStream is an adaptor class that adapts the Rogue Wave virtual stream interface to the new Rogue Wave Data Input Stream interface. Requests made through the Rogue Wave virtual input stream interface are forwarded to the embedded RWDataInputStream handle.
| RWvistreamFromDataInputStream::RWvistreamFromDataInputStream | ( | const RWDataInputStream & | sourceStream | ) | [inline] |
Initializes the reference to the data stream that will be used as the source of data.
| sourceStream | The data stream that will serve as the source of data. |
| virtual RWvistreamFromDataInputStream::~RWvistreamFromDataInputStream | ( | ) | [virtual] |
Destructor.
| virtual int RWvistreamFromDataInputStream::bad | ( | ) | [virtual] |
Forward to the isBad() function of the embedded data stream. Throws no exceptions.
Implements RWvistream.
| virtual void RWvistreamFromDataInputStream::clear | ( | int | v = 0 |
) | [virtual] |
Not meaningful for data input stream. This function does nothing. Throws no exceptions.
Implements RWvistream.
| virtual int RWvistreamFromDataInputStream::eof | ( | ) | [virtual] |
Forward to the isEof() function of the embedded data stream. Throws no exceptions.
Implements RWvistream.
| virtual int RWvistreamFromDataInputStream::fail | ( | ) | [virtual] |
Forward to the isFail() function of the embedded data stream. Throws no exceptions.
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | unsigned long long * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | long long * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | long double * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | unsigned long * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | unsigned int * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | unsigned short * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | unsigned char * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | wchar_t * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | short * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | long * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | int * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | float * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | double * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | char * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | bool * | arrayPt, | |
| size_t | count | |||
| ) | [virtual] |
Read an array of values from the stream. The array must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | bool & | value | ) | [virtual] |
Gets the next specified value from the input stream.
| value | A reference to the variable receiving the value ead from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | unsigned char & | value | ) | [virtual] |
Gets the next specified value from the input stream.
| value | A reference to the variable receiving the value ead from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | wchar_t & | value | ) | [virtual] |
Gets the next specified value from the input stream.
| value | A reference to the variable receiving the value ead from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::get | ( | char & | value | ) | [virtual] |
Gets the next specified value from the input stream.
| value | A reference to the variable receiving the value ead from the stream. |
Implements RWvistream.
| virtual int RWvistreamFromDataInputStream::get | ( | ) | [virtual] |
Gets and returns the next byte from the input stream, returning its value. Returns EOF if the end of the input sequence is encountered. Throws no exceptions.
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::getSizeT | ( | size_t & | sz | ) | [virtual] |
Gets the next size_t value from the input stream, returning its value in sz.
Implements RWvistream.
| const RWDataInputStream& RWvistreamFromDataInputStream::getSourceStream | ( | ) | const [inline, protected] |
Returns a handle to the embedded Data Input Stream that is used as the source of data. Throws no exceptions.
| RWDataInputStream& RWvistreamFromDataInputStream::getSourceStream | ( | ) | [inline, protected] |
Returns a handle to the embedded Data Input Stream that is used as the source of data. Throws no exceptions.
| virtual RWvistream& RWvistreamFromDataInputStream::getString | ( | char * | string, | |
| size_t | count | |||
| ) | [virtual] |
Reads a narrow character string from the stream. The string must have been pre-allocated to contain at least count elements. The function returns 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. |
Implements RWvistream.
| virtual int RWvistreamFromDataInputStream::good | ( | ) | [virtual] |
Forward to the isGood() function of the embedded data stream. Throws no exceptions.
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | unsigned long long & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | long long & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | long double & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | unsigned long & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | unsigned int & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | unsigned short & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | unsigned char & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | wchar_t & | value | ) | [virtual] |
Reads a wide character from the stream.
| value | The wide character to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | short & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | long & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | int & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | float & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | double & | value | ) | [virtual] |
Reads the specified type from the stream.
| value | The value to be read from the stream. |
Implements RWvistream.
| virtual RWvistream& RWvistreamFromDataInputStream::operator>> | ( | char & | value | ) | [virtual] |
Reads a narrow character from the stream.
| value | The narrow character to be read from the stream. |
Implements RWvistream.
| virtual int RWvistreamFromDataInputStream::rdstate | ( | ) | [virtual] |
Returns the value of the stream state variable as defined in iostreams. Throws no exceptions.
Implements RWvistream.
© 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.
