SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Protected Member Functions
RWDataFromByteInputStreamImp Class Reference

Abstract base class for all the data from binary conversion input stream implementation classes. More...

#include <rw/stream/RWDataFromByteInputStreamImp.h>

Inheritance diagram for RWDataFromByteInputStreamImp:
RWDataInputStreamImp RWInputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWNativeDataFromByteInputStreamImp

Public Member Functions

virtual ~RWDataFromByteInputStreamImp ()
 
virtual RWSize available () const
 
virtual void close ()
 
virtual bool isBad () const
 
virtual bool isEof () const
 
virtual bool isFail () const
 
virtual bool isGood () const
 
virtual RWSize skip (RWSize numUnits)
 
- Public Member Functions inherited from RWDataInputStreamImp
virtual ~RWDataInputStreamImp ()
 
virtual void getBool (bool &value)=0
 
virtual RWSize getBools (bool *arrayPt, RWSize count)=0
 
virtual void getChar (char &value)=0
 
virtual void getCharacter (char &value)=0
 
virtual RWSize getChars (char *arrayPt, RWSize count)=0
 
virtual RWSize getDelimitedString (char *string, RWSize maxCount, char delim)=0
 
virtual RWSize getDelimitedUString (RWUChar *ustring, RWSize maxCount, RWUChar delim)=0
 
virtual RWSize getDelimitedWString (wchar_t *wstring, RWSize maxCount, wchar_t delim)=0
 
virtual void getDouble (double &value)=0
 
virtual RWSize getDoubles (double *arrayPt, RWSize count)=0
 
virtual void getFloat (float &value)=0
 
virtual RWSize getFloats (float *arrayPt, RWSize count)=0
 
virtual void getInt (int &value)=0
 
virtual RWSize getInts (int *arrayPt, RWSize count)=0
 
virtual void getLong (long &value)=0
 
virtual void getLongDouble (long double &value)=0
 
virtual RWSize getLongDoubles (long double *arrayPt, RWSize count)=0
 
virtual void getLongLong (long long &value)=0
 
virtual RWSize getLongLongs (long long *arrayPt, RWSize count)=0
 
virtual RWSize getLongs (long *arrayPt, RWSize count)=0
 
virtual void getShort (short &value)=0
 
virtual RWSize getShorts (short *arrayPt, RWSize count)=0
 
virtual void getSignedChar (signed char &value)=0
 
virtual RWSize getSignedChars (signed char *arrayPt, RWSize count)=0
 
virtual void getSizeT (size_t &value)=0
 
virtual RWSize getString (char *string, RWSize count)=0
 
virtual void getUCharacter (RWUChar &value)=0
 
virtual void getUnsignedChar (unsigned char &value)=0
 
virtual RWSize getUnsignedChars (unsigned char *arrayPt, RWSize count)=0
 
virtual void getUnsignedInt (unsigned int &value)=0
 
virtual RWSize getUnsignedInts (unsigned int *arrayPt, RWSize count)=0
 
virtual void getUnsignedLong (unsigned long &value)=0
 
virtual void getUnsignedLongLong (unsigned long long &value)=0
 
virtual RWSize getUnsignedLongLongs (unsigned long long *arrayPt, RWSize count)=0
 
virtual RWSize getUnsignedLongs (unsigned long *arrayPt, RWSize count)=0
 
virtual void getUnsignedShort (unsigned short &value)=0
 
virtual RWSize getUnsignedShorts (unsigned short *arrayPt, RWSize count)=0
 
virtual RWSize getUString (RWUChar *arrayPt, RWSize count)=0
 
virtual void getWchar_t (wchar_t &value)=0
 
virtual RWSize getWchar_ts (wchar_t *arrayPt, RWSize count)=0
 
virtual void getWCharacter (wchar_t &value)=0
 
virtual RWSize getWString (wchar_t *wstring, RWSize count)=0
 
- Public Member Functions inherited from RWInputStreamImp
virtual ~RWInputStreamImp ()
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 

Protected Member Functions

 RWDataFromByteInputStreamImp (const RWByteInputStream &sourceStream)
 
void clearFail ()
 
RWByteInputStreamgetSourceStream ()
 
const RWByteInputStreamgetSourceStream () const
 
void setFail ()
 
- Protected Member Functions inherited from RWDataInputStreamImp
 RWDataInputStreamImp ()
 
- Protected Member Functions inherited from RWInputStreamImp
 RWInputStreamImp ()
 
- Protected Member Functions inherited from RWStreamImp
 RWStreamImp ()
 
- Protected Member Functions inherited from RWBodyBase
 RWBodyBase (void)
 
 RWBodyBase (RWStaticCtor)
 
 RWBodyBase (const RWBodyBase &second)
 
virtual ~RWBodyBase (void)
 
RWBodyBaseoperator= (const RWBodyBase &second)
 
- Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
 RWTCountingBody (unsigned initCount=0)
 
 RWTCountingBody (RWStaticCtor)
 
 RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)
 
RWTCountingBody< RWMutexLock > & operator= (const RWTCountingBody< RWMutexLock > &second)
 
 ~RWTCountingBody (void)
 
unsigned addReference (void)
 
unsigned references (void) const
 
unsigned removeReference (void)
 
- Protected Member Functions inherited from RWTMonitor< RWMutexLock >
 RWTMonitor ()
 
 RWTMonitor (RWStaticCtor)
 
 RWTMonitor (const RWTMonitor< RWMutexLock > &second)
 
 ~RWTMonitor ()
 
void acquire ()
 
bool isAcquired () const
 
RWTMonitor< RWMutexLock > & monitor () const
 
RWMutexLockmutex ()
 
RWTMonitor< RWMutexLock > & operator= (const RWTMonitor< RWMutexLock > &)
 
void release ()
 
bool tryAcquire ()
 

Additional Inherited Members

- Protected Types inherited from RWTCountingBody< RWMutexLock >
typedef RWTLockGuard< RWTMonitor< RWMutexLock > > LockGuard
 
typedef RWTTryLockGuard< RWTMonitor< RWMutexLock > > TryLockGuard
 
typedef RWTUnlockGuard< RWTMonitor< RWMutexLock > > UnlockGuard
 
- Protected Types inherited from RWTMonitor< RWMutexLock >
typedef RWTLockGuard< RWTMonitor< RWMutexLock > > LockGuard
 
typedef RWTTryLockGuard< RWTMonitor< RWMutexLock > > TryLockGuard
 
typedef RWTUnlockGuard< RWTMonitor< RWMutexLock > > UnlockGuard
 

Detailed Description

Abstract base class for all the data from the binary conversion input stream implementation classes. A conversion input stream is a stream that uses an attached input stream of a different format as the source of elements to its own functions. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWDataFromByteInputStreamImp::~RWDataFromByteInputStreamImp ( )
virtual

Destructor.

RWDataFromByteInputStreamImp::RWDataFromByteInputStreamImp ( const RWByteInputStream sourceStream)
inlineprotected

Used by the derived classes to initialize the attached source stream.

Parameters
sourceStreamA handle to the attached source stream.

Member Function Documentation

virtual RWSize RWDataFromByteInputStreamImp::available ( ) const
virtual

Returns the number of bytes that can be read from the attached source stream without blocking. Throws no exceptions.

Implements RWInputStreamImp.

void RWDataFromByteInputStreamImp::clearFail ( )
inlineprotected

Clears the data stream fail bit. Throws no exceptions.

virtual void RWDataFromByteInputStreamImp::close ( )
virtual

Forwards the close() request to the attached source stream.

Implements RWStreamImp.

RWByteInputStream& RWDataFromByteInputStreamImp::getSourceStream ( )
inlineprotected

Returns a handle to the attached source stream. They throw no exceptions.

const RWByteInputStream& RWDataFromByteInputStreamImp::getSourceStream ( ) const
inlineprotected

Returns a handle to the attached source stream. They throw no exceptions.

virtual bool RWDataFromByteInputStreamImp::isBad ( ) const
virtual

Forwards the isBad() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

virtual bool RWDataFromByteInputStreamImp::isEof ( ) const
virtual

Forwards the isEof() request to the attached source stream. Throws no exceptions.

Implements RWInputStreamImp.

virtual bool RWDataFromByteInputStreamImp::isFail ( ) const
virtual

Forwards the isFail() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

virtual bool RWDataFromByteInputStreamImp::isGood ( ) const
virtual

Forwards the isGood() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

void RWDataFromByteInputStreamImp::setFail ( )
inlineprotected

Sets the data stream fail bit. Throws no exceptions.

virtual RWSize RWDataFromByteInputStreamImp::skip ( RWSize  numUnits)
virtual

Skips numUnits bytes from the input sequence of the attached source stream, if possible. The function returns the actual number of bytes skipped, which can be any value between 0 and numUnits.

Parameters
numUnitsThe number of bytes to be skipped.

Implements RWInputStreamImp.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.