RWvistream
Module: Essential Tools Module Group: Virtual Stream Classes
RWvistreamRWvios
- Local Index
- Synopsis
- Description
- Persistence
- Example
- Public Destructor
- Public Operators
- Public Member Functions
- Related Global Operator
Local Index
Members
Non-Members
Synopsis
#include <rw/vstream.h>
Description
Class RWvistream is an abstract base class. It provides an interface for format-independent retrieval of fundamental types and arrays of fundamental types. Its counterpart, RWvostream, provides a complementary interface for the storage of the fundamental types.
Because the interface of RWvistream and RWvostream is independent of formatting, the user of these classes need not be concerned with how variables will actually be stored or restored. That will be up to the derived class to decide. It might be done using an operating-system independent ASCII format (classes RWpistream and RWpostream), a binary format (classes RWbistream and RWbostream), or the user could define his or her own format (such as an interface to a network). Note that because it is an abstract base class, there is no way to actually enforce these goals -- the description here is merely the model of how a class derived from RWvistream and RWvostream should act.
See class RWvostream for additional explanations and examples of format-independent stream storage.
Persistence
None
Example
// Based on vistream.cpp in the examples directory.
// Build an run the example vostream.cpp, which stores
// some data, and then run this example to restore
// the data.
#include <rw/vstream.h>
#include <rw/bstream.h>
#include <rw/pstream.h>
#include <fstream>
#include <iostream>
void restoreStuff (RWvistream& str)
{
int i;
double d;
char s [80];
str >> i; // Restore an int
str >> d; // Restore a double
// Restore a character string, up to 80 characters long:
str.getString(s, sizeof s);
if (str.fail()) {
std::cerr << "Restoration failed.\n\n";
return;
}
std::cout << "Int : " << i << "\n";
std::cout << "Double : " << d << "\n";
std::cout << "Char array : \"" << s << "\"\n";
}
int main()
{
std::ifstream vf("vfile.dat");
RWpistream ps (vf);
RWbistream bs (vf);
// Uncomment the call to storeStuff that matches your stream type
restoreStuff((RWvistream &)ps);
// restoreStuff((RWvistream &)bs);
return 0;
}
Program output:
Int : 5 Double : 22.5 Char array : "A string with tabs and a newline "
Public Destructor
virtual ~RWvistream();
Empty destructor.
Public Operators
virtual RWvistream& operator>>(char& c) = 0;
Get the next char from the input stream and store it in c.
virtual RWvistream& operator>>(wchar_t& wc) = 0;
Get the next wchar_t from the input stream and store it in wc.
virtual RWvistream& operator>>(double& d) = 0;
Get the next double from the input stream and store it in d.
virtual RWvistream& operator>>(long double& d) = 0;
Get the next long double from the input stream and store it in d. Note: This operator function is only available if your compiler supports the long double type.
virtual RWvistream& operator>>(float& f) = 0;
Get the next float from the input stream and store it in f.
virtual RWvistream& operator>>(int& i) = 0;
Get the next int from the input stream and store it in i.
virtual RWvistream& operator>>(long& l) = 0;
Get the next long from the input stream and store it in l.
virtual RWvistream& operator>>(long long& l) = 0;
Get the next long long from the input stream and store it in l. Note: This operator function is only available if your compiler supports the long long type.
virtual RWvistream& operator>>(short& s) = 0;
Get the next short from the input stream and store it in s.
virtual RWvistream& operator>>(unsigned char& c) = 0;
Get the next unsigned char from the input stream and store it in c.
virtual RWvistream& operator>>(unsigned short& s) = 0;
Get the next unsigned short from the input stream and store it in s.
virtual RWvistream& operator>>(unsigned int& i) = 0;
Get the next unsigned int from the input stream and store it in i.
virtual RWvistream& operator>>(unsigned long& l) = 0;
Get the next unsigned long from the input stream and store it in l.
virtual RWvistream& operator>>(unsigned long long& l) = 0;
Get the next unsigned long long from the input stream and store it in l. Note: This operator function is only available if your compiler supports the unsigned long long type.
operator void*();
Inherited from RWvios.
Public Member Functions
virtual int get() = 0;
Get and return the next byte from the input stream, returning its value. Returns EOF if end of file is encountered.
virtual RWvistream& get(char& c) = 0;
Get the next char from the input stream, returning its value in c.
virtual RWvistream& get(wchar_t& wc) = 0;
Get the next wchar_t from the input stream, returning its value in wc.
virtual RWvistream& get(unsigned char& c) = 0;
Get the next unsigned char from the input stream, returning its value in c.
virtual RWvistream& get(char* v, size_t N) = 0;
Get a vector of chars and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit. Note that get retrieves raw characters and does not perform any conversions on special characters such as "\n".
virtual RWvistream& get(wchar_t* v, size_t N) = 0;
Get a vector of wide characters and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit. Note that get retrieves raw characters and does not perform any conversions on special characters such as "\n".
virtual RWvistream& get(double* v, size_t N) = 0;
Get a vector of N doubles and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(long double* v, size_t N) = 0;
Get a vector of N long doubles and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit. Note: This operator function is only available if your compiler supports the long double type.
virtual RWvistream& get(float* v, size_t N) = 0;
Get a vector of N floats and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(int* v, size_t N) = 0;
Get a vector of N ints and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(long* v, size_t N) = 0;
Get a vector of N longs and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason,get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(long long* v, size_t N) = 0;
Get a vector of N long longs and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason,get stores what has already been retrieved from the stream into v, and sets the failbit. Note: This operator function is only available if your compiler supports the long long type.
virtual RWvistream& get(short* v, size_t N) = 0;
Get a vector of N shorts and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason,get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(unsigned char* v, size_t N) = 0;
Get a vector of N unsigned chars and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit. Note that this member preserves ASCII numerical codes, not their corresponding character values. If you wish to restore a character string, use the function getString(char*, size_t).
virtual RWvistream& get(unsigned short* v, size_t N) = 0;
Get a vector of N unsigned shorts and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(unsigned int* v, size_t N) = 0;
Get a vector of N unsigned ints and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(unsigned long* v, size_t N) = 0;
Get a vector of N unsigned longs and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit.
virtual RWvistream& get(unsigned long long* v, size_t N) = 0;
Get a vector of N unsigned long longs and store them in the array beginning at v. If the restore operation stops prematurely because there are no more data available on the stream, because an exception is thrown, or for some other reason, get stores what has already been retrieved from the stream into v, and sets the failbit. Note: This operator function is only available if your compiler supports the unsigned long long type.
virtual RWvistream& getSizeT(size_t& sz) = 0;
Get the next size_t value from the input stream, returning its value in sz.
virtual RWvistream& getString(char* s, size_t N) = 0;
Restores a character string from the input stream that was stored to the output stream with RWvostream::putstring and stores it in the array beginning at s. The function stops reading at the end of the string or after N-1 characters, whichever comes first. If N-1 characters have been read and the Nth character is not the string terminator, then the failbit of the stream will be set. In either case, the string will be terminated with a null byte.
virtual RWvistream& getString(wchar_t* ws, size_t N) = 0;
Restores a wide character string from the input stream that was stored to the output stream with RWvostream::putstring and stores it in the array beginning at ws. The function stops reading at the end of the string or after N-1 characters, whichever comes first. If N-1 characters have been read and the Nth character is not the string terminator, then the failbit of the stream will be set. In either case, the string will be terminated with a null byte.
Related Global Operator
RWvistream& operator>>(RWvistream&, RWCString& str);
Restores a string into str from a virtual stream or RWFile, respectively, replacing the previous contents of str.
RWvistream& operator>>(RWvistream&, RWInteger& x);
Restores an RWInteger into x from a virtual stream or RWFile, respectively, replacing the previous contents of x.
RWvistream& operator>>(RWvistream&, RWTime& t);
Restores an RWTime into t from a virtual stream or RWFile, respectively, replacing the previous contents of t.
RWvistream& operator>>(RWvistream& strm, RWTPtrDeque<T,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrDlist<T,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrHashMap<K,T,H,EQ,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrHashMultiMap<K,T,H,EQ,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrHashMultiSet<T,H,EQ,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrHashSet<T,H,EQ,A> & coll); RWvistream& operator>>(RWvistream& strm, RWTPtrMap<K,T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrMultiMap<K,T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrMultiSet<T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrOrderedVector<T,A> & coll); RWvistream& operator>>(RWvistream& strm, RWTPtrSet<T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrSlist<T,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrSortedDlist<T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTPtrSortedVector<T,C,A> & coll); RWvistream& operator>>(RWvistream& strm, RWTValDeque<T,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValDlist<T,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValHashMap<T,H,EQ>& coll); RWvistream& operator>>(RWvistream& strm, RWTValHashMultiMap<K,T,H,EQ,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValHashMultiSet<T,H,EQ,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValHashSet<T,H,EQ,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValMap<K,T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValMultiMap<T,C>& coll); RWvistream& operator>>(RWvistream& strm, RWTValMultiSet<K,T,C>& coll); RWvistream& operator>>(RWvistream& strm, RWTValOrderedVector<T,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValSet<T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValSlist<T,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValSortedDlist<T,C,A>& coll); RWvistream& operator>>(RWvistream& strm, RWTValSortedVector<T,C,A>& coll);
Restores the contents of the collection coll from the input stream strm.
RWvistream& operator>>(RWvistream& strm, RWTPtrDeque<T,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrDlist<T,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrHashMap<K,T,H,EQ,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrHashMultiMap<K,T,H,EQ,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrHashMultiSet<T,H,EQ,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrHashSet<T,H,EQ,A> *& p); RWvistream& operator>>(RWvistream& strm, RWTPtrMap<K,T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrMultiMap<K,T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrMultiSet<T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrOrderedVector<T,A> *& p); RWvistream& operator>>(RWvistream& strm, RWTPtrSet<T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrSlist<T,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrSortedDlist<T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTPtrSortedVector<T,C,A> *& p); RWvistream& operator>>(RWvistream& strm, RWTValDeque<T,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValDlist<T,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValHashMap<T,H,EQ>*& p); RWvistream& operator>>(RWvistream& strm, RWTHashMultiMap<K,T,H,EQ>*& p); RWvistream& operator>>(RWvistream& strm, RWTValHashMultiSet<T,H,EQ,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValHashSet<T,H,EQ,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValMap<K,T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValMultiMap<K,T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValMultiSet<T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValOrderedVector<T,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValSet<T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValSlist<T,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValSortedDlist<T,C,A>*& p); RWvistream& operator>>(RWvistream& strm, RWTValSortedVector<T,C,A>*& p);
Looks at the next object on the input stream strm and either creates a new collection off the heap and sets p to point to it, or sets p to point to a previously read instance. If a collection is created off the heap, then you are responsible for deleting it.
© 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.