RWpistream Class Reference

Specializes the abstract base class RWvistream to restore variables stored in a portable US-ASCII format by RWpostream. More...

#include <rw/pstream.h>

Inheritance diagram for RWpistream:

Public Member Functions
	RWpistream (std::istream &str)
	RWpistream (std::streambuf *sb)
virtual	~RWpistream ()
virtual int	bad ()
virtual void	clear (int v=0)
virtual int	eof ()
virtual int	fail ()
virtual int	get ()
virtual RWvistream &	get (char &c)
virtual RWvistream &	get (signed char &c)
virtual RWvistream &	get (unsigned char &c)
virtual RWvistream &	get (wchar_t &wc)
virtual RWvistream &	get (bool &b)
virtual RWvistream &	get (short &i)
virtual RWvistream &	get (unsigned short &i)
virtual RWvistream &	get (int &i)
virtual RWvistream &	get (unsigned int &i)
virtual RWvistream &	get (long &i)
virtual RWvistream &	get (unsigned long &i)
virtual RWvistream &	get (long long &i)
virtual RWvistream &	get (unsigned long long &i)
virtual RWvistream &	get (float &f)
virtual RWvistream &	get (double &d)
virtual RWvistream &	get (long double &d)
virtual RWvistream &	get (char *v, size_t n)
virtual RWvistream &	get (signed char *v, size_t n)
virtual RWvistream &	get (unsigned char *v, size_t n)
virtual RWvistream &	get (wchar_t *v, size_t n)
virtual RWvistream &	get (bool *, size_t n)
virtual RWvistream &	get (short *v, size_t n)
virtual RWvistream &	get (unsigned short *v, size_t n)
virtual RWvistream &	get (int *v, size_t n)
virtual RWvistream &	get (unsigned int *v, size_t n)
virtual RWvistream &	get (long *v, size_t n)
virtual RWvistream &	get (unsigned long *v, size_t n)
virtual RWvistream &	get (long long *v, size_t n)
virtual RWvistream &	get (unsigned long long *v, size_t n)
virtual RWvistream &	get (float *v, size_t n)
virtual RWvistream &	get (double *v, size_t n)
virtual RWvistream &	get (long double *v, size_t n)
virtual RWvistream &	getChar (char &c)
virtual RWvistream &	getChar (signed char &c)
virtual RWvistream &	getChar (unsigned char &c)
virtual RWvistream &	getChar (wchar_t &wc)
virtual RWvistream &	getChars (char *s, size_t n)
virtual RWvistream &	getSizeT (size_t &sz)
virtual RWvistream &	getString (char *s, size_t n)
virtual int	good ()
virtual int	rdstate ()
std::istream &	std ()
const std::istream &	std () const
Public Member Functions inherited from RWvistream
virtual	~RWvistream ()
void	version (unsigned v)
unsigned	version () const
Public Member Functions inherited from RWvios
	operator void * ()

Additional Inherited Members
Related Functions inherited from RWvistream
RWvistream &	operator>> (RWvistream &is, char &c)
RWvistream &	operator>> (RWvistream &is, signed char &c)
RWvistream &	operator>> (RWvistream &is, unsigned char &c)
RWvistream &	operator>> (RWvistream &is, wchar_t &wc)
RWvistream &	operator>> (RWvistream &is, bool &b)
RWvistream &	operator>> (RWvistream &is, short &i)
RWvistream &	operator>> (RWvistream &is, unsigned short &i)
RWvistream &	operator>> (RWvistream &is, int &i)
RWvistream &	operator>> (RWvistream &is, unsigned int &i)
RWvistream &	operator>> (RWvistream &is, long &i)
RWvistream &	operator>> (RWvistream &is, unsigned long &i)
RWvistream &	operator>> (RWvistream &is, long long &i)
RWvistream &	operator>> (RWvistream &is, unsigned long long &i)
RWvistream &	operator>> (RWvistream &is, float &f)
RWvistream &	operator>> (RWvistream &is, double &d)
RWvistream &	operator>> (RWvistream &is, long double &d)

Detailed Description

Class RWpistream specializes the abstract base class RWvistream to restore variables stored in a portable US-ASCII format by RWpostream.

You can think of RWpistream and RWpostream as an US-ASCII veneer over an associated std::streambuf which are responsible for formatting variables and escaping characters such that the results can be interchanged between any machines. As such, they are slower than their binary counterparts RWbistream and RWbostream which are more machine dependent. Because RWpistream and RWpostream retain no information about the state of their associated std::streambuf, their use can be freely exchanged with other users of the std::streambuf (such as std::istream or std::ifstream).

RWpistream can be interrogated as to the stream state using member functions good(), bad(), eof(), and so forth.

Synopsis

#include <rw/pstream.h>
RWpistream pstr(cin);   // Construct a RWpistream using cin's streambuf

Persistence

None

Example

#include <iostream>
#include <fstream>

#include <rw/pstream.h>

int main()
{
    // Open an input file
    std::ifstream fstr("data.dat");

    // Construct RWpistream from it
    RWpistream pstr(fstr);

    int i;
    float f;
    double d;

    // Restore an int that was stored in binary
    if(!(pstr >> i))
    {
        std::cout << "Run postream.exe first!\n";
    }
    else
    {
        // Restore a float & double
        pstr >> f >> d;

        std::cout << "The integer: " << i << std::endl;
        std::cout << "The float: " << f << std::endl;
        std::cout << "The double: " << d << std::endl;
    }

    return 0;
}

Constructor & Destructor Documentation

RWpistream::RWpistream

(

std::istream &

str

)

Initializes an RWpistream using the std::streambuf associated with the std::istream str.

RWpistream::RWpistream

(

std::streambuf *

sb

)

Initializes an RWpistream from the std::streambuf sb.

virtual RWpistream::~RWpistream ( )

virtual

Empty destructor.

Member Function Documentation

virtual int RWpistream::bad ( )

inlinevirtual

Returns a nonzero integer if the bad bit has been set. Normally this indicates that a severe error has occurred from which recovery is probably impossible.

Implements RWvistream.

virtual void RWpistream::clear ( int  v = 0 )

inlinevirtual

Sets the current error state to v. If v is zero, then this clears the error state.

Implements RWvistream.

virtual int RWpistream::eof ( )

inlinevirtual

Returns a nonzero integer if an EOF is encountered.

Implements RWvistream.

virtual int RWpistream::fail ( )

inlinevirtual

Returns a nonzero integer if the failed or bad bit has been set. Normally, this indicates that some storage or retrieval has failed, but that the stream is still in a usable state.

Implements RWvistream.

virtual int RWpistream::get ( )

virtual

Gets and returns the next byte from the input stream, returning its value. Returns EOF if end of file is encountered.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( char &  c )

virtual

Gets the next char from the input stream, returning its value in c.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( signed char &  c )

virtual

Gets the next signed char from the input stream, returning its value in c.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned char &  c )

virtual

Gets the next unsigned char from the input stream, returning its value in c.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( wchar_t &  wc )

virtual

Gets the next wchar_t from the input stream, returning its value in wc.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( bool &  b )

virtual

Gets the next bool from the input stream, returning its value in b.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( short &  i )

virtual

Gets the next short from the input stream, returning its value in i.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned short &  i )

virtual

Gets the next unsigned short from the input stream, returning its value in i.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( int &  i )

virtual

Gets the next int from the input stream, returning its value in i.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned int &  i )

virtual

Gets the next unsigned int from the input stream, returning its value in i.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( long &  i )

virtual

Gets the next long from the input stream, returning its value in i.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned long &  i )

virtual

Gets the next unsigned long from the input stream, returning its value in i.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( long long &  i )

virtual

Gets the next long long from the input stream, returning its value in i.

Note

This operator function is available only if your compiler supports the long long type.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned long long &  i )

virtual

Gets the next unsigned long long from the input stream, returning its value in i.

Note

This operator function is available only if your compiler supports the unsigned long long type.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( float &  f )

virtual

Gets the next float from the input stream, returning its value in f.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( double &  d )

virtual

Gets the next double from the input stream, returning its value in d.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( long double &  d )

virtual

Gets the next long double from the input stream, returning its value in d.

Note

This operator function is available only if your compiler supports the long double type.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( char *  v, size_t  n  )

virtual

Gets a vector of char and stores it in the array beginning at v. If the restore operation stops prematurely because there is 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 method preserves US-ASCII numerical codes, not their corresponding character values. If you wish to restore a character string, use the function getString().

Implements RWvistream.

virtual RWvistream& RWpistream::get ( signed char *  v, size_t  n  )

virtual

Gets a vector of n signed char and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned char *  v, size_t  n  )

virtual

Gets a vector of n unsigned char and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( wchar_t *  v, size_t  n  )

virtual

Gets a vector of n wchar_t and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Note

This method retrieves raw characters and does not perform any conversions on special characters such as L'\n'.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( bool *  v, size_t  n  )

virtual

Gets a vector of n bool and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( short *  v, size_t  n  )

virtual

Gets a vector of n short and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned short *  v, size_t  n  )

virtual

Gets a vector of n unsigned short and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( int *  v, size_t  n  )

virtual

Gets a vector of n int and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned int *  v, size_t  n  )

virtual

Gets a vector of n unsigned int and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( long *  v, size_t  n  )

virtual

Gets a vector of n long and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned long *  v, size_t  n  )

virtual

Gets a vector of n unsigned long and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( long long *  v, size_t  n  )

virtual

Gets a vector of n long long and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Note

This operator function is available only if your compiler supports the long long type.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( unsigned long long *  v, size_t  n  )

virtual

Gets a vector of n unsigned long long and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Note

This operator function is available only if your compiler supports the unsigned long long type.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( float *  v, size_t  n  )

virtual

Gets a vector of n float and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( double *  v, size_t  n  )

virtual

Gets a vector of n double and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Implements RWvistream.

virtual RWvistream& RWpistream::get ( long double *  v, size_t  n  )

virtual

Gets a vector of n long double and stores them in the array beginning at v. If the restore operation stops prematurely because there is no more data available on the stream, because an exception is thrown, or for some other reason, stores what has already been retrieved from the stream into v, and sets the failbit.

Note

This operator function is available only if your compiler supports the long double type.

Implements RWvistream.

virtual RWvistream& RWpistream::getChar ( char &  c )

virtual

Gets the next char from the input stream, returning its value in c. c is treated as a character.

Implements RWvistream.

virtual RWvistream& RWpistream::getChar ( signed char &  c )

virtual

Gets the next signed char from the input stream, returning its value in c. c is treated as a character.

Implements RWvistream.

virtual RWvistream& RWpistream::getChar ( unsigned char &  c )

virtual

Gets the next unsigned char from the input stream, returning its value in c. c is treated as a character.

Implements RWvistream.

virtual RWvistream& RWpistream::getChar ( wchar_t &  wc )

virtual

Gets the next wchar_t from the input stream, returning its value in wc. wc is treated as a character.

Implements RWvistream.

virtual RWvistream& RWpistream::getChars ( char *  s, size_t  n  )

virtual

Restores n char from the input stream into the array beginning at s. The function stops reading after n characters. The resulting buffer is not null terminated.

Reimplemented from RWvistream.

virtual RWvistream& RWpistream::getSizeT ( size_t &  sz )

virtual

Gets the next size_t value from the input stream, returning its value in sz.

Implements RWvistream.

virtual RWvistream& RWpistream::getString ( char *  s, size_t  n  )

virtual

Restores a character string from the input stream that was stored to the output stream with RWpostream::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 n ^th character is not the string terminator, then the failbit of the stream is set. In either case, the string is terminated with a null byte.

Implements RWvistream.

virtual int RWpistream::good ( )

inlinevirtual

Returns a nonzero integer if no error bits have been set.

Implements RWvistream.

virtual int RWpistream::rdstate ( )

inlinevirtual

Returns the current error state.

Implements RWvistream.

std::istream& RWpistream::std

(

)

Returns a reference to the underlying C++ Standard Library input stream.

const std::istream& RWpistream::std ( ) const

inline

Returns a reference to the underlying C++ Standard Library input stream.