IRIX Base Documentation 2001 May/SGI IRIX Base Documentation 2001 May.iso/usr/share/catman/p_man/cat3/librw/RWeostream.z/RWeostream

Text File | 1998-10-30 | 15.5 KB | 397 lines

RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



NNNNaaaammmmeeee
     RWeostream - Rogue Wave library class

SSSSyyyynnnnooooppppssssiiiissss
              #include <rw/estream.h>



              // Construct an RWeostream that uses cout's streambuf,
          //   and writes out values in little-endian format:
          RWeostream estr(cout, RWeostream::LittleEndian);




DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
     Class RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm specializes the base class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm to store values in
     a portable binary format.  The results can be restored via its
     counterpart, RRRRWWWWeeeeiiiissssttttrrrreeeeaaaammmm.  See the entry for RRRRWWWWeeeeiiiissssttttrrrreeeeaaaammmm for a general
     description of the endian stream classes.

PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
     None.

EEEExxxxaaaammmmpppplllleeee
     See RRRRWWWWeeeeiiiissssttttrrrreeeeaaaammmm for an example of how the file "ddddaaaattttaaaa....ddddaaaatttt" might be read.

EEEEnnnnuuuummmmeeeerrrraaaattttiiiioooonnnn
              eeeennnnuuuummmm RWeostream::Endian { LittleEndian,
                                    BigEndian,
                                    HostEndian }


     Used to specify the format that RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmms should use to represent
     numeric values in the stream.  HHHHoooossssttttEEEEnnnnddddiiiiaaaannnn means to use the native format
     of the current environment.

PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm(streambuf* s, Endian fmt = HostEndian);


     Construct an RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm from the ssssttttrrrreeeeaaaammmmbbbbuuuuffff ssss.  Values placed into the
     stream will have an endian format given by ffffmmmmtttt.  For DOS, the ssssttttrrrreeeeaaaammmmbbbbuuuuffff
     must have been created in binary mode.  Throw exception RRRRWWWWSSSSttttrrrreeeeaaaammmmEEEErrrrrrrr if
     ssssttttrrrreeeeaaaammmmbbbbuuuuffff ssss is not empty.

              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm(ostream& str, Endian fmt = HostEndian);


     Construct an RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm from the ssssttttrrrreeeeaaaammmmbbbbuuuuffff associated with the output
     stream ssssttttrrrr.  Values placed into the stream will have an endian format
     given by ffffmmmmtttt.  For DOS, the ssssttttrrrr must have been opened in binary mode.



                                                                        PPPPaaaaggggeeee 1111






RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



     Throw exception RRRRWWWWSSSSttttrrrreeeeaaaammmmEEEErrrrrrrr if ssssttttrrrreeeeaaaammmmbbbbuuuuffff ssss is not empty.

PPPPuuuubbbblllliiiicccc DDDDeeeessssttttrrrruuuuccccttttoooorrrr
              virtual ~~~~RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm();






     This virtual destructor allows specializing classes to deallocate any
     resources that they may have allocated.





PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
              virtual RWvostream&
          fffflllluuuusssshhhh();


     Send the contents of the stream buffer to output immediately.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(const char* s);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the character string starting at
     ssss to the output stream.  The character string is expected to be null
     terminated.  Note that the elements of s are treated as characters, not
     as numbers.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(char c);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the cccchhhhaaaarrrr cccc to the output stream.
     Note that cccc is treated as a character, not a number.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(wchar_t wc);


     Redefined from class RWbostream.  Store the wwwwcccchhhhaaaarrrr____tttt wwwwcccc to the output
     stream in binary, using the appropriate endian representation.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned char c);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrr cccc to the output



                                                                        PPPPaaaaggggeeee 2222






RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



     stream.  Note that cccc is treated as a character, not a number.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(double d);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the ddddoooouuuubbbblllleeee dddd to the output stream
     in binary, using the appropriate endian representation.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(float f);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the ffffllllooooaaaatttt ffff to the output stream
     in binary, using the appropriate endian representation.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(int i);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the iiiinnnntttt iiii to the output stream in
     binary, using the appropriate endian representation.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned int i);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt iiii to the output
     stream in binary, using the appropriate endian representation.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(long l);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the lllloooonnnngggg llll to the output stream
     in binary, using the appropriate endian representation.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned long l);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg llll to the output
     stream in binary, using the appropriate endian representation.

              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(short s);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the sssshhhhoooorrrrtttt ssss to the output stream
     in binary, using the appropriate endian representation.





                                                                        PPPPaaaaggggeeee 3333






RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



              virtual RWvostream&
          ooooppppeeeerrrraaaattttoooorrrr<<<<<<<<(unsigned short s);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the uuuunnnnssssiiiiggggnnnneeeedddd sssshhhhoooorrrrtttt ssss to the
     output stream in binary, using the appropriate endian representation.

              virtual RWvostream&
          ppppuuuutttt(char c);
          virtual RWvostream&
          ppppuuuutttt(unsigned char c);
          virtual RWvostream&
          ppppuuuutttt(const char* p, size_t N);


     Inherited from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.

              virtual RWvostream&
          ppppuuuutttt(wchar_t wc);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the wcccchhhhaaaarrrr____tttt wwwwcccc to the output
     stream in binary, using the appropriate endian representation.

              virtual RWvostream&
          ppppuuuutttt(const wchar_t* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of wwwwcccchhhhaaaarrrr____tttts starting
     at pppp to the output stream in binary, using the appropriate endian
     representation.

              virtual RWvostream&
          ppppuuuutttt(const unsigned char* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of uuuunnnnssssiiiiggggnnnneeeedddd cccchhhhaaaarrrrs
     starting at pppp to the output stream in binary, using the appropriate
     endian representation.

              virtual RWvostream&
          ppppuuuutttt(const short* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of sssshhhhoooorrrrtttts starting at
     pppp to the output stream in binary, using the appropriate endian
     representation.

              virtual RWvostream&
          ppppuuuutttt(const unsigned short* p, size_t N);





                                                                        PPPPaaaaggggeeee 4444






RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of uuuunnnnssssiiiiggggnnnneeeedddd sssshhhhoooorrrrtttts
     starting at pppp to the output stream in binary, using the appropriate
     endian representation.

              virtual RWvostream&
          ppppuuuutttt(const int* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of iiiinnnntttts starting at pppp
     to the output stream in binary, using the appropriate endian
     representation.

              virtual RWvostream&
          ppppuuuutttt(const unsigned int* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttts
     starting at pppp to the output stream in binary, using the appropriate
     endian representation.

              virtual RWvostream&
          ppppuuuutttt(const long* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of lllloooonnnnggggs starting at pppp
     to the output stream in binary, using the appropriate endian
     representation.

              virtual RWvostream&
          ppppuuuutttt(const unsigned long* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnnggggs
     starting at pppp to the output stream in binary, using the appropriate
     endian representation.

              virtual RWvostream&
          ppppuuuutttt(const float* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of ffffllllooooaaaatttts starting at
     pppp to the output stream in binary, using the appropriate endian
     representation.

              virtual RWvostream&
          ppppuuuutttt(const double* p, size_t N);


     Redefined from class RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm.  Store the vector of ddddoooouuuubbbblllleeees starting at
     pppp to the output stream in binary, using the appropriate endian
     representation.




                                                                        PPPPaaaaggggeeee 5555






RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))                                              RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm((((3333CCCC++++++++))))



              virtual RWvostream&
          ppppuuuuttttSSSSttttrrrriiiinnnngggg(const char*s, size_t N);


     Store the character string, iiiinnnncccclllluuuuddddiiiinnnngggg eeeemmmmbbbbeeeeddddddddeeeedddd nnnnuuuullllllllssss, starting at s to
     the output string.

















































                                                                        PPPPaaaaggggeeee 6666