rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWWCharToWStreambufOutputStreamImp Class Reference
[Streams]

Concrete class connecting a wide character stream to an iostreams wide character buffer. More...

#include <rw/stream/RWWCharToWStreambufOutputStreamImp.h>

Inheritance diagram for RWWCharToWStreambufOutputStreamImp:
RWWCharOutputStreamImp RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock >

List of all members.

Public Member Functions

virtual ~RWWCharToWStreambufOutputStreamImp ()
virtual void close ()
virtual void flush ()
virtual bool isBad () const
virtual bool isFail () const
virtual bool isGood () const
virtual void write (wchar_t wcharValue)
virtual void write (const wchar_t *wcharArray, RWSize numWChars)

Static Public Member Functions

static RWWCharOutputStream make (std::wstreambuf &sink)

Protected Member Functions

 RWWCharToWStreambufOutputStreamImp (std::wstreambuf &sinkBuff)
std::wstreambuf & getSinkBuff ()
const std::wstreambuf & getSinkBuff () const

Detailed Description

Concrete class connecting a wide character stream to an iostreams wide character buffer. The iostreams buffer is used as the sink for the wide characters written to the wide character stream. Implements the body idiom from the handle-body pattern.


Constructor & Destructor Documentation

virtual RWWCharToWStreambufOutputStreamImp::~RWWCharToWStreambufOutputStreamImp (  )  [virtual]

Destructor.

RWWCharToWStreambufOutputStreamImp::RWWCharToWStreambufOutputStreamImp ( std::wstreambuf &  sinkBuff  )  [inline, protected]

Initializes the reference to the iostreams std::wstreambuf, that will be used as the sink of wide characters.

Parameters:
sinkBuff The iostreams std::wstreambuf that will serve as the sink of wide characters.

Member Function Documentation

virtual void RWWCharToWStreambufOutputStreamImp::close (  )  [virtual]

This function calls flush(). The user is responsible for closing the iostreams std::wstreambuf used as the sink of wide characters if necessary.

Reimplemented from RWOutputStreamImp.

virtual void RWWCharToWStreambufOutputStreamImp::flush (  )  [virtual]

Forward the flush() request to the iostreams std::wstreambuf.

Implements RWOutputStreamImp.

const std::wstreambuf& RWWCharToWStreambufOutputStreamImp::getSinkBuff (  )  const [inline, protected]

Returns a reference to the iostreams std::wstreambuf, which is used as the sink of wide characters. Throws no exceptions.

std::wstreambuf& RWWCharToWStreambufOutputStreamImp::getSinkBuff (  )  [inline, protected]

Returns a reference to the iostreams std::wstreambuf, which is used as the sink of wide characters. Throws no exceptions.

virtual bool RWWCharToWStreambufOutputStreamImp::isBad (  )  const [virtual]

Returns true if the last operation performed on the iostreams std::wstreambuf failed. Throws no exceptions.

Implements RWStreamImp.

virtual bool RWWCharToWStreambufOutputStreamImp::isFail (  )  const [virtual]

Returns true if the last operation performed on the iostreams std::wstreambuf failed. Throws no exceptions.

Implements RWStreamImp.

virtual bool RWWCharToWStreambufOutputStreamImp::isGood (  )  const [virtual]

Returns true if the last operation performed on the iostreams std::wstreambuf succeeded. Throws no exceptions.

Implements RWStreamImp.

static RWWCharOutputStream RWWCharToWStreambufOutputStreamImp::make ( std::wstreambuf &  sink  )  [inline, static]

Constructs an RWWCharToWStreambufOutputStreamImp instance that uses sink as its sink of wide characters, and returns a handle to it. Throws no exceptions.

Parameters:
sink The iostreams std::wstreambuf that is used as the sink of wide characters.
virtual void RWWCharToWStreambufOutputStreamImp::write ( const wchar_t *  wcharArray,
RWSize  numWChars 
) [virtual]

Writes an array of wide characters to the iostreams std::wstreambuf.

Parameters:
wcharArray A pointer to the first element of the array.
numWChars The number of wide characters to be written.

Implements RWWCharOutputStreamImp.

virtual void RWWCharToWStreambufOutputStreamImp::write ( wchar_t  wcharValue  )  [virtual]

Writes a single wide character to the iostreams std::wstreambuf.

Parameters:
wcharValue The wide character to be written.

Implements RWWCharOutputStreamImp.

 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.