SourcePro® API Reference Guide

 
List of all members | Public Member Functions | Protected Member Functions
RWDataOutputStreamImp Class Referenceabstract

Abstract base class from which all data output stream implementation classes must derive. More...

#include <rw/stream/RWDataOutputStreamImp.h>

Inheritance diagram for RWDataOutputStreamImp:
RWOutputStreamImp RWStreamImp RWBodyBase RWTCountingBody< RWMutexLock > RWTMonitor< RWMutexLock > RWDataToByteOutputStreamImp RWDataToCharOutputStreamImp RWDataToVirtualOutputStreamImp RWFilteredDataOutputStreamImp RWNativeDataToByteOutputStreamImp RWOstreamDataToCharOutputStreamImp RWObjectOutputStreamImp RWSynchronizedDataOutputStreamImp RWCompactObjectOutputStreamImp RWEnhancedXmlObjectOutputStreamImp RWXmlObjectOutputStreamImp RWTParsedTransformObjectOutputStreamImp< Transform > RWTTransformObjectOutputStreamImp< Transform >

Public Member Functions

virtual ~RWDataOutputStreamImp ()
 
virtual RWDataOutputStream acquire ()
 
virtual void putBool (bool value)=0
 
virtual void putBools (const bool *arrayPt, RWSize count)=0
 
virtual void putChar (char value)=0
 
virtual void putCharacter (char value)=0
 
virtual void putChars (const char *arrayPt, RWSize count)=0
 
virtual void putDouble (double value)=0
 
virtual void putDoubles (const double *arrayPt, RWSize count)=0
 
virtual void putFloat (float value)=0
 
virtual void putFloats (const float *arrayPt, RWSize count)=0
 
virtual void putInt (int value)=0
 
virtual void putInts (const int *arrayPt, RWSize count)=0
 
virtual void putLong (long value)=0
 
virtual void putLongDouble (long double value)=0
 
virtual void putLongDoubles (const long double *arrayPt, RWSize count)=0
 
virtual void putLongLong (long long value)=0
 
virtual void putLongLongs (const long long *arrayPt, RWSize count)=0
 
virtual void putLongs (const long *arrayPt, RWSize count)=0
 
virtual void putShort (short value)=0
 
virtual void putShorts (const short *arrayPt, RWSize count)=0
 
virtual void putSignedChar (signed char value)=0
 
virtual void putSignedChars (const signed char *arrayPt, RWSize count)=0
 
virtual void putString (const char *string, RWSize count)=0
 
virtual void putUCharacter (RWUChar value)=0
 
virtual void putUnsignedChar (unsigned char value)=0
 
virtual void putUnsignedChars (const unsigned char *arrayPt, RWSize count)=0
 
virtual void putUnsignedInt (unsigned int value)=0
 
virtual void putUnsignedInts (const unsigned int *arrayPt, RWSize count)=0
 
virtual void putUnsignedLong (unsigned long value)=0
 
virtual void putUnsignedLongs (const unsigned long *arrayPt, RWSize count)=0
 
virtual void putUnsignedShort (unsigned short value)=0
 
virtual void putUnsignedShorts (const unsigned short *arrayPt, RWSize count)=0
 
virtual void putUString (const RWUChar *ustring, RWSize count)=0
 
virtual void putWchar_t (wchar_t value)=0
 
virtual void putWchar_ts (const wchar_t *arrayPt, RWSize count)=0
 
virtual void putWCharacter (wchar_t value)=0
 
virtual void putWString (const wchar_t *wstring, RWSize count)=0
 
virtual void release ()
 
- Public Member Functions inherited from RWOutputStreamImp
virtual ~RWOutputStreamImp ()
 
virtual void close ()
 
virtual void flush ()=0
 
- Public Member Functions inherited from RWStreamImp
virtual ~RWStreamImp ()
 
virtual bool isBad () const =0
 
virtual bool isFail () const =0
 
virtual bool isGood () const =0
 

Protected Member Functions

 RWDataOutputStreamImp ()
 
- Protected Member Functions inherited from RWOutputStreamImp
 RWOutputStreamImp ()
 
- 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 output stream implementation classes. Implements the body idiom from the handle-body pattern.

Constructor & Destructor Documentation

virtual RWDataOutputStreamImp::~RWDataOutputStreamImp ( )
inlinevirtual

Destructor.

RWDataOutputStreamImp::RWDataOutputStreamImp ( )
inlineprotected

Constructor. Throws no exceptions.

Member Function Documentation

virtual RWDataOutputStream RWDataOutputStreamImp::acquire ( )
virtual

Acquires the synchronization mechanism provided by a stream concrete implementation. The acquire member function returns a handle to the data stream that should be used for output operation after acquiring the synchronization mechanism.

Reimplemented in RWSynchronizedDataOutputStreamImp.

virtual void RWDataOutputStreamImp::putBool ( bool  value)
pure virtual
virtual void RWDataOutputStreamImp::putBools ( const bool *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of bool values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putChar ( char  value)
pure virtual
virtual void RWDataOutputStreamImp::putCharacter ( char  value)
pure virtual
virtual void RWDataOutputStreamImp::putChars ( const char *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of char values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putDouble ( double  value)
pure virtual
virtual void RWDataOutputStreamImp::putDoubles ( const double *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of double values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putFloat ( float  value)
pure virtual
virtual void RWDataOutputStreamImp::putFloats ( const float *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of float values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putInt ( int  value)
pure virtual
virtual void RWDataOutputStreamImp::putInts ( const int *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of int values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putLong ( long  value)
pure virtual
virtual void RWDataOutputStreamImp::putLongDouble ( long double  value)
pure virtual
virtual void RWDataOutputStreamImp::putLongDoubles ( const long double *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of long double values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putLongLong ( long long  value)
pure virtual
virtual void RWDataOutputStreamImp::putLongLongs ( const long long *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of long long values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putLongs ( const long *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of long values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putShort ( short  value)
pure virtual
virtual void RWDataOutputStreamImp::putShorts ( const short *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of short values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putSignedChar ( signed char  value)
pure virtual
virtual void RWDataOutputStreamImp::putSignedChars ( const signed char *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of signed char values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putString ( const char *  string,
RWSize  count 
)
pure virtual

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

Parameters
stringA pointer to the narrow string's first character.
countThe number of narrow characters to be written to the stream.

Implemented in RWXmlObjectOutputStreamImp, RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, RWFilteredDataOutputStreamImp, RWNativeDataToByteOutputStreamImp, RWObjectOutputStreamImp, and RWCompactObjectOutputStreamImp.

virtual void RWDataOutputStreamImp::putUCharacter ( RWUChar  value)
pure virtual
virtual void RWDataOutputStreamImp::putUnsignedChar ( unsigned char  value)
pure virtual

Writes an unsigned char value to the stream.

Parameters
valueThe unsigned char value to be written to the stream.

Implemented in RWXmlObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUnsignedChars ( const unsigned char *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of unsigned char values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUnsignedInt ( unsigned int  value)
pure virtual

Writes an unsigned int value to the stream.

Parameters
valueThe unsigned int value to be written to the stream.

Implemented in RWXmlObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUnsignedInts ( const unsigned int *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of unsigned int values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUnsignedLong ( unsigned long  value)
pure virtual

Writes an unsigned long value to the stream.

Parameters
valueThe unsigned long value to be written to the stream.

Implemented in RWXmlObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUnsignedLongs ( const unsigned long *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of unsigned long values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUnsignedShort ( unsigned short  value)
pure virtual

Writes an unsigned short value to the stream.

Parameters
valueThe unsigned short value to be written to the stream.

Implemented in RWXmlObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUnsignedShorts ( const unsigned short *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of unsigned short values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putUString ( const RWUChar ustring,
RWSize  count 
)
pure virtual

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

Parameters
ustringA pointer to the string's first UTF-16 character.
countThe number of UTF-16 characters to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWXmlObjectOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, RWNativeDataToByteOutputStreamImp, RWObjectOutputStreamImp, and RWCompactObjectOutputStreamImp.

virtual void RWDataOutputStreamImp::putWchar_t ( wchar_t  value)
pure virtual
virtual void RWDataOutputStreamImp::putWchar_ts ( const wchar_t *  arrayPt,
RWSize  count 
)
pure virtual

Writes an array of wchar_t values to the stream.

Parameters
arrayPtA pointer to the array's first element.
countThe number of elements to be written to the stream.

Implemented in RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWFilteredDataOutputStreamImp, and RWNativeDataToByteOutputStreamImp.

virtual void RWDataOutputStreamImp::putWCharacter ( wchar_t  value)
pure virtual
virtual void RWDataOutputStreamImp::putWString ( const wchar_t *  wstring,
RWSize  count 
)
pure virtual

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

Parameters
wstringA pointer to the string's first wide character.
countThe number of wide characters to be written to the stream.

Implemented in RWXmlObjectOutputStreamImp, RWDataToVirtualOutputStreamImp, RWOstreamDataToCharOutputStreamImp, RWSynchronizedDataOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, RWFilteredDataOutputStreamImp, RWNativeDataToByteOutputStreamImp, RWObjectOutputStreamImp, and RWCompactObjectOutputStreamImp.

virtual void RWDataOutputStreamImp::release ( void  )
inlinevirtual

Releases the synchronization mechanism provided by a stream concrete implementation.

Reimplemented in RWSynchronizedDataOutputStreamImp.

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