RWByteOutputStream Class Reference
[Streams]

Handle class for all binary output stream implementation classes. More...

#include <rw/stream/RWByteOutputStream.h>

Inheritance diagram for RWByteOutputStream:

List of all members.

Public Member Functions
	RWByteOutputStream (RWByteOutputStreamImp *ptr)
	RWByteOutputStream (const RWByteOutputStream &handle)
RWByteOutputStream &	operator= (const RWByteOutputStream &handle)
RWByteOutputStream &	operator<< (RWByteOutputStream &(*pf)(RWByteOutputStream &))
RWByteOutputStream	operator<< (RWByteOutputStream(*pf)(RWByteOutputStream &))
RWByteOutputStream &	operator<< (RWByte byteValue)
void	write (RWByte byteValue)
void	write (const RWByte *byteArray, RWSize numBytes)
void	close ()
void	flush ()
bool	isBad () const
bool	isFail () const
bool	isGood () const
Related Functions
(Note that these are not member functions.)
RWByteOutputStream &	rwFlush (RWByteOutputStream &stream)

---

Detailed Description

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

---

Constructor & Destructor Documentation

RWByteOutputStream::RWByteOutputStream

(

RWByteOutputStreamImp *

ptr

)

[inline, explicit]

Constructor.

RWByteOutputStream::RWByteOutputStream

(

const RWByteOutputStream &

handle

)

[inline]

Copy constructor.

Parameters:

handle

A binary stream handle used to initialize the newly created handle.

Exception none.

---

Member Function Documentation

void RWByteOutputStream::close

(

)

[inline]

Closes the stream.

void RWByteOutputStream::flush

(

void

)

[inline]

Flushes the stream.

bool RWByteOutputStream::isBad

(

)

const [inline]

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

bool RWByteOutputStream::isFail

(

)

const [inline]

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

bool RWByteOutputStream::isGood

(

)

const [inline]

Returns true to indicate a stream in a valid state.

RWByteOutputStream& RWByteOutputStream::operator<<

(

RWByte

byteValue

)

[inline]

Writes a single byte to the stream.

Parameters:

byteValue

The byte to be written to the stream.

RWByteOutputStream RWByteOutputStream::operator<<

(

RWByteOutputStream(*)(RWByteOutputStream &)

pf

)

[inline]

Inserter executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWByteOutputStream& RWByteOutputStream::operator<<

(

RWByteOutputStream &(*)(RWByteOutputStream &)

pf

)

[inline]

Inserter executing a manipulator function.

Parameters:

pf

The manipulator's function pointer.

RWByteOutputStream& RWByteOutputStream::operator=

(

const RWByteOutputStream &

handle

)

[inline]

Assignment operator.

Parameters:

handle

A binary stream handle used to initialize this handle.

Exception none.

void RWByteOutputStream::write	(	const RWByte *	byteArray,
		RWSize	numBytes
	)			[inline]

Writes an array of bytes to the stream.

Parameters:

	byteArray	A pointer to the first element of the array.
	numBytes	The number of bytes to be written to the stream.

void RWByteOutputStream::write

(

RWByte

byteValue

)

[inline]

Writes a single byte to the stream.

Parameters:

byteValue

The byte to be written to the stream.

---

Friends And Related Function Documentation

RWByteOutputStream & rwFlush

(

RWByteOutputStream &

stream

)

[related]

Manipulator that flushes a binary output stream.

Parameters:

stream

The binary stream to be flushed.