rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWDataOutputStream Class Reference
[Streams]

Handle class for all the data output stream implementation classes. More...

#include <rw/stream/RWDataOutputStream.h>

Inheritance diagram for RWDataOutputStream:
RWHandleBase RWObjectOutputStream

List of all members.

Public Member Functions

 RWDataOutputStream (RWDataOutputStreamImp *ptr)
 RWDataOutputStream (const RWDataOutputStream &handle)
RWDataOutputStreamoperator= (const RWDataOutputStream &handle)
RWDataOutputStreamoperator<< (RWDataOutputStream &(*pf)(RWDataOutputStream &))
RWDataOutputStream operator<< (RWDataOutputStream(*pf)(RWDataOutputStream &))
void close ()
void flush ()
bool isBad () const
bool isFail () const
bool isGood () const
RWDataOutputStreamoperator<< (bool value)
RWDataOutputStreamoperator<< (char value)
RWDataOutputStreamoperator<< (unsigned char value)
RWDataOutputStreamoperator<< (signed char value)
RWDataOutputStreamoperator<< (short value)
RWDataOutputStreamoperator<< (unsigned short value)
RWDataOutputStreamoperator<< (int value)
RWDataOutputStreamoperator<< (unsigned int value)
RWDataOutputStreamoperator<< (long value)
RWDataOutputStreamoperator<< (unsigned long value)
RWDataOutputStreamoperator<< (float value)
RWDataOutputStreamoperator<< (double value)
RWDataOutputStreamoperator<< (wchar_t value)
RWDataOutputStreamoperator<< (long long value)
RWDataOutputStreamoperator<< (long double value)
void putBool (bool value)
void putChar (char value)
void putUnsignedChar (unsigned char value)
void putSignedChar (signed char value)
void putShort (short value)
void putUnsignedShort (unsigned short value)
void putInt (int value)
void putUnsignedInt (unsigned int value)
void putLong (long value)
void putUnsignedLong (unsigned long value)
void putFloat (float value)
void putDouble (double value)
void putWchar_t (wchar_t value)
void putLongLong (long long value)
void putLongDouble (long double value)
virtual void putCharacter (char value)
virtual void putWCharacter (wchar_t value)
virtual void putUCharacter (RWUChar value)
virtual void putSizeT (size_t value)
void putBools (const bool *arrayPt, RWSize count)
void putChars (const char *arrayPt, RWSize count)
void putUnsignedChars (const unsigned char *arrayPt, RWSize count)
void putSignedChars (const signed char *arrayPt, RWSize count)
void putShorts (const short *arrayPt, RWSize count)
void putUnsignedShorts (const unsigned short *arrayPt, RWSize count)
void putInts (const int *arrayPt, RWSize count)
void putUnsignedInts (const unsigned int *arrayPt, RWSize count)
void putLongs (const long *arrayPt, RWSize count)
void putUnsignedLongs (const unsigned long *arrayPt, RWSize count)
void putFloats (const float *arrayPt, RWSize count)
void putDoubles (const double *arrayPt, RWSize count)
void putWchar_ts (const wchar_t *arrayPt, RWSize count)
void putLongLongs (const long long *arrayPt, RWSize count)
void putLongDoubles (const long double *arrayPt, RWSize count)
void putString (const char *string, RWSize count)
void putWString (const wchar_t *wstring, RWSize count)
void putUString (const RWUChar *ustring, RWSize count)

Related Functions

(Note that these are not member functions.)



RWDataOutputStreamrwFlush (RWDataOutputStream &stream)
RWDataOutputStreamrwEndl (RWDataOutputStream &stream)
RWDataOutputStreamrwEnds (RWDataOutputStream &stream)
RWDataOutputStreamrwWEndl (RWDataOutputStream &stream)
RWDataOutputStreamrwWEnds (RWDataOutputStream &stream)

Detailed Description

Handle class for all the data output stream implementation classes. Implements the handle idiom from the handle-body pattern.


Constructor & Destructor Documentation

RWDataOutputStream::RWDataOutputStream ( RWDataOutputStreamImp ptr  )  [inline, explicit]

Constructor.

RWDataOutputStream::RWDataOutputStream ( const RWDataOutputStream handle  )  [inline]

Copy constructor. Throws no exceptions.

Parameters:
handle A data stream handle used to initialize this handle.

Member Function Documentation

void RWDataOutputStream::close ( void   )  [inline]

Closes the stream.

void RWDataOutputStream::flush ( void   )  [inline]

Flushes the stream.

bool RWDataOutputStream::isBad (  )  const [inline]

Returns true to indicate a loss of integrity resulting from an output operation. Throws no exceptions.

bool RWDataOutputStream::isFail (  )  const [inline]

Returns true to indicate that an output operation failed to generate the desired data. Throws no exceptions.

bool RWDataOutputStream::isGood (  )  const [inline]

Returns true to indicate a stream in a valid state. Throws no exceptions.

RWDataOutputStream& RWDataOutputStream::operator<< ( long double  value  )  [inline]

Writes a long double value to the stream.

Parameters:
value The long double value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( long long  value  )  [inline]

Writes a long long value to the stream.

Parameters:
value The long long value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( wchar_t  value  )  [inline]

Writes a wchar_t value to the stream.

Parameters:
value The wchar_t value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( double  value  )  [inline]

Writes a double value to the stream.

Parameters:
value The double value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( float  value  )  [inline]

Writes a float value to the stream.

Parameters:
value The float value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( unsigned long  value  )  [inline]

Writes an unsigned long value to the stream.

Parameters:
value The unsigned long value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( long  value  )  [inline]

Writes a long value to the stream.

Parameters:
value The long value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( unsigned int  value  )  [inline]

Writes an unsigned int value to the stream.

Parameters:
value The unsigned int value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( int  value  )  [inline]

Writes an int value to the stream.

Parameters:
value The int value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( unsigned short  value  )  [inline]

Writes an unsigned short value to the stream.

Parameters:
value The unsigned short to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( short  value  )  [inline]

Writes a short value to the stream.

Parameters:
value The short to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( signed char  value  )  [inline]

Writes a signed char value to the stream.

Parameters:
value The signed char value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( unsigned char  value  )  [inline]

Writes an unsigned char value to the stream.

Parameters:
value The unsigned char value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( char  value  )  [inline]

Writes a char value to the stream.

Parameters:
value The char value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream& RWDataOutputStream::operator<< ( bool  value  )  [inline]

Writes a bool value to the stream.

Parameters:
value The bool value to be written to the stream.

Reimplemented in RWObjectOutputStream.

RWDataOutputStream RWDataOutputStream::operator<< ( RWDataOutputStream(*)(RWDataOutputStream &)  pf  )  [inline]

Insertor executing a manipulator function. Throws no exceptions.

Parameters:
pf The manipulator's function pointer.
RWDataOutputStream& RWDataOutputStream::operator<< ( RWDataOutputStream &(*)(RWDataOutputStream &)  pf  )  [inline]

Insertor executing a manipulator function. Throws no exceptions.

Parameters:
pf The manipulator's function pointer.
RWDataOutputStream& RWDataOutputStream::operator= ( const RWDataOutputStream handle  )  [inline]

Assignment operator. Throws no exceptions.

Parameters:
handle A data stream handle used to initialize this handle.
void RWDataOutputStream::putBool ( bool  value  )  [inline]

Writes a bool value to the stream.

Parameters:
value The bool value to be written to the stream.
void RWDataOutputStream::putBools ( const bool *  arrayPt,
RWSize  count 
) [inline]

Writes an array of bool value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putChar ( char  value  )  [inline]

Writes a char value to the stream.

Parameters:
value The char value to be written to the stream.
virtual void RWDataOutputStream::putCharacter ( char  value  )  [inline, virtual]

Writes a narrow character to the stream.

Parameters:
value The narrow character to be written to the stream.
void RWDataOutputStream::putChars ( const char *  arrayPt,
RWSize  count 
) [inline]

Writes an array of char value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putDouble ( double  value  )  [inline]

Writes a double value to the stream.

Parameters:
value The double value to be written to the stream.
void RWDataOutputStream::putDoubles ( const double *  arrayPt,
RWSize  count 
) [inline]

Writes an array of double value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putFloat ( float  value  )  [inline]

Writes a float value to the stream.

Parameters:
value The float value to be written to the stream.
void RWDataOutputStream::putFloats ( const float *  arrayPt,
RWSize  count 
) [inline]

Writes an array of float value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putInt ( int  value  )  [inline]

Writes an int value to the stream.

Parameters:
value The int value to be written to the stream.
void RWDataOutputStream::putInts ( const int *  arrayPt,
RWSize  count 
) [inline]

Writes an array of int value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putLong ( long  value  )  [inline]

Writes a long value to the stream.

Parameters:
value The long value to be written to the stream.
void RWDataOutputStream::putLongDouble ( long double  value  )  [inline]

Writes a long double value to the stream.

Parameters:
value The long double value to be written to the stream.
void RWDataOutputStream::putLongDoubles ( const long double *  arrayPt,
RWSize  count 
) [inline]

Writes an array of long double value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putLongLong ( long long  value  )  [inline]

Writes a long long value to the stream.

Parameters:
value The long long value to be written to the stream.
void RWDataOutputStream::putLongLongs ( const long long *  arrayPt,
RWSize  count 
) [inline]

Writes an array of long long value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putLongs ( const long *  arrayPt,
RWSize  count 
) [inline]

Writes an array of long value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putShort ( short  value  )  [inline]

Writes a short value to the stream.

Parameters:
value The short value to be written to the stream.
void RWDataOutputStream::putShorts ( const short *  arrayPt,
RWSize  count 
) [inline]

Writes an array of short value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putSignedChar ( signed char  value  )  [inline]

Writes a signed char value to the stream.

Parameters:
value The signed char value to be written to the stream.
void RWDataOutputStream::putSignedChars ( const signed char *  arrayPt,
RWSize  count 
) [inline]

Writes an array of signed char value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
virtual void RWDataOutputStream::putSizeT ( size_t  value  )  [inline, virtual]

Writes a size_t value to the stream.

Parameters:
value The size_t value to be written to the stream.
void RWDataOutputStream::putString ( const char *  string,
RWSize  count 
) [inline]

Writes a narrow character string, including embedded nulls, starting at string to the stream.

Parameters:
string A pointer to the string's first narrow character.
count The number of narrow characters to be written to the stream.
virtual void RWDataOutputStream::putUCharacter ( RWUChar  value  )  [inline, virtual]

Writes a UTF-16 character to the stream.

Parameters:
value The UTF-16 character to be written to the stream.
void RWDataOutputStream::putUnsignedChar ( unsigned char  value  )  [inline]

Writes an unsigned char value to the stream.

Parameters:
value The unsigned char value to be written to the stream.
void RWDataOutputStream::putUnsignedChars ( const unsigned char *  arrayPt,
RWSize  count 
) [inline]

Writes an array of unsigned char value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putUnsignedInt ( unsigned int  value  )  [inline]

Writes an unsigned int value to the stream.

Parameters:
value The unsigned int value to be written to the stream.
void RWDataOutputStream::putUnsignedInts ( const unsigned int *  arrayPt,
RWSize  count 
) [inline]

Writes an array of unsigned int value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putUnsignedLong ( unsigned long  value  )  [inline]

Writes an unsigned long value to the stream.

Parameters:
value The unsigned long value to be written to the stream.
void RWDataOutputStream::putUnsignedLongs ( const unsigned long *  arrayPt,
RWSize  count 
) [inline]

Writes an array of unsigned long value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putUnsignedShort ( unsigned short  value  )  [inline]

Writes an unsigned short value to the stream.

Parameters:
value The unsigned short value to be written to the stream.
void RWDataOutputStream::putUnsignedShorts ( const unsigned short *  arrayPt,
RWSize  count 
) [inline]

Writes an array of unsigned short value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
void RWDataOutputStream::putUString ( const RWUChar ustring,
RWSize  count 
) [inline]

Writes a UTF-16 character string, including embedded nulls, starting at ustring to the stream.

Parameters:
ustring A pointer to the string's first UTF-16 character.
count The number of UTF-16 characters to be written to the stream.
void RWDataOutputStream::putWchar_t ( wchar_t  value  )  [inline]

Writes a wchar_t value to the stream.

Parameters:
value The wchar_t value to be written to the stream.
void RWDataOutputStream::putWchar_ts ( const wchar_t *  arrayPt,
RWSize  count 
) [inline]

Writes an array of wchar_t value(s) to the stream.

Parameters:
arrayPt A pointer to the array's first element.
count The number of element(s) to be written to the stream.
virtual void RWDataOutputStream::putWCharacter ( wchar_t  value  )  [inline, virtual]

Writes a wide character to the stream.

Parameters:
value The wide character to be written to the stream.
void RWDataOutputStream::putWString ( const wchar_t *  wstring,
RWSize  count 
) [inline]

Writes a wide character string, including embedded nulls, starting at wstring to the stream.

Parameters:
wstring A pointer to the string's first narrow character.
count The number of wide characters to be written to the stream.

Friends And Related Function Documentation

RWDataOutputStream & rwEndl ( RWDataOutputStream stream  )  [related]

Manipulator that writes a narrow end-of-line control character to the stream.

Parameters:
stream The data stream to which the manipulator applies.
RWDataOutputStream & rwEnds ( RWDataOutputStream stream  )  [related]

Manipulator that writes a narrow end of string character to the stream. to the stream.

Parameters:
stream The data stream to which the manipulator applies.
RWDataOutputStream & rwFlush ( RWDataOutputStream stream  )  [related]

Manipulator that flushes a data output stream.

Parameters:
stream The data stream to be flushed.
RWDataOutputStream & rwWEndl ( RWDataOutputStream stream  )  [related]

Manipulator that writes a wide end-of-line control character to the stream.

Parameters:
stream The data stream to which the manipulator applies.
RWDataOutputStream & rwWEnds ( RWDataOutputStream stream  )  [related]

Manipulator that writes a wide end of string character to the stream. to the stream.

Parameters:
stream The data stream to which the manipulator applies.
 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.