Base class for all object output stream implementations. More...

#include <rw/serial/RWObjectOutputStreamImp.h>

Inheritance diagram for RWObjectOutputStreamImp:

Public Member Functions
virtual void	closeContext (bool writeContext=true)

virtual void	endAssoc ()

virtual void	endBlock ()=0

virtual void	endElement ()

virtual void	endMap ()

virtual void	endMember (const RWSymbol &)

virtual void	endParent ()

virtual void	endSequence ()

virtual bool	needToWrite (const void *obj)=0

virtual void	newObjectMarker ()=0

virtual void	openContext (bool writeContext=true)

virtual void	putString (const RWCString &str)=0

virtual void	putSymbol (const RWSymbol &sym)

virtual void	putUString (const RWBasicUString &str)=0

virtual void	putWString (const RWWString &str)=0

virtual void	rememberObject (const void *obj)=0

virtual void	setNameForNextObject (const RWCString &str)=0

virtual void	startAssocKey ()

virtual void	startAssocValue ()

virtual void	startBlock (const RWSymbol &typeInfo)=0

virtual void	startElement (int)

virtual void	startMap (int count, RWStreamType keyType, RWStreamType valueType, const RWSymbol &typeInfo)=0

virtual void	startParent (const RWSymbol &)

virtual void	startSequence (int count, RWStreamType elementType, const RWSymbol &typeInfo)=0

virtual void	writeMemberInfo (const RWSymbol &memberName, RWStreamType memberType)=0

virtual void	writeNullPtr ()=0

virtual void	writeTypeInfo (const RWSymbol &typeInfo)=0

Public Member Functions inherited from RWFilteredDataOutputStreamImp
virtual	~RWFilteredDataOutputStreamImp ()

virtual void	close ()

virtual void	flush ()

virtual bool	isBad () const

virtual bool	isFail () const

virtual bool	isGood () const

virtual void	putBool (bool value)

virtual void	putBools (const bool *arrayPt, RWSize count)

virtual void	putChar (char value)

virtual void	putCharacter (char value)

virtual void	putChars (const char *arrayPt, RWSize count)

virtual void	putDouble (double value)

virtual void	putDoubles (const double *arrayPt, RWSize count)

virtual void	putFloat (float value)

virtual void	putFloats (const float *arrayPt, RWSize count)

virtual void	putInt (int value)

virtual void	putInts (const int *arrayPt, RWSize count)

virtual void	putLong (long value)

virtual void	putLongDouble (long double value)

virtual void	putLongDoubles (const long double *arrayPt, RWSize count)

virtual void	putLongLong (long long value)

virtual void	putLongLongs (const long long *arrayPt, RWSize count)

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

virtual void	putShort (short value)

virtual void	putShorts (const short *arrayPt, RWSize count)

virtual void	putSignedChar (signed char value)

virtual void	putSignedChars (const signed char *arrayPt, RWSize count)

virtual void	putSizeT (size_t value)

virtual void	putUCharacter (RWUChar value)

virtual void	putUnsignedChar (unsigned char value)

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

virtual void	putUnsignedInt (unsigned int value)

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

virtual void	putUnsignedLong (unsigned long value)

virtual void	putUnsignedLongLong (unsigned long long value)

virtual void	putUnsignedLongLongs (const unsigned long long *arrayPt, RWSize count)

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

virtual void	putUnsignedShort (unsigned short value)

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

virtual void	putWchar_t (wchar_t value)

virtual void	putWchar_ts (const wchar_t *arrayPt, RWSize count)

virtual void	putWCharacter (wchar_t value)

Public Member Functions inherited from RWDataOutputStreamImp
virtual	~RWDataOutputStreamImp ()

virtual RWDataOutputStream	acquire ()

virtual void	release ()

Public Member Functions inherited from RWOutputStreamImp
virtual	~RWOutputStreamImp ()

Public Member Functions inherited from RWStreamImp
virtual	~RWStreamImp ()

Protected Member Functions
	RWObjectOutputStreamImp (const RWDataOutputStream &sinkStream)

virtual void	closeOuterContext (bool writeContext)=0

int	getContextNestingLevel ()

virtual void	openOuterContext (bool writeContext)=0

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

virtual void	putUString (const RWUChar *ustring, RWSize count)

virtual void	putWString (const wchar_t *wstring, RWSize count)

Protected Member Functions inherited from RWFilteredDataOutputStreamImp
	RWFilteredDataOutputStreamImp (const RWDataOutputStream &sinkStream)

RWDataOutputStream &	getSinkStream ()

const RWDataOutputStream &	getSinkStream () const

Protected Member Functions inherited from RWDataOutputStreamImp
	RWDataOutputStreamImp ()

Protected Member Functions inherited from RWOutputStreamImp
	RWOutputStreamImp ()

Protected Member Functions inherited from RWStreamImp
	RWStreamImp ()

Protected Member Functions inherited from RWBodyBase
	RWBodyBase (const RWBodyBase &second)

	RWBodyBase (RWStaticCtor)

	RWBodyBase (void)

virtual	~RWBodyBase (void)

RWBodyBase &	operator= (const RWBodyBase &second)

Protected Member Functions inherited from RWTCountingBody< RWMutexLock >
	RWTCountingBody (const RWTCountingBody< RWMutexLock > &second)

	RWTCountingBody (RWStaticCtor)

	RWTCountingBody (unsigned initCount=0)

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 (const RWTMonitor< RWMutexLock > &second)

	RWTMonitor (RWStaticCtor)

	RWTMonitor (void)

	~RWTMonitor (void)

void	acquire (void)

bool	isAcquired (void) const

RWTMonitor< RWMutexLock > &	monitor (void) const

RWMutexLock &	mutex (void)

RWTMonitor< RWMutexLock > &	operator= (const RWTMonitor< RWMutexLock > &)

void	release (void)

bool	tryAcquire (void)

Protected Attributes
RWCString	nameForNextObject_

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

Base class for all object output stream implementations. Inherits default operations for streaming primitives from the data output stream.

See the corresponding handle class, RWObjectOutputStream, for the description of the object output stream interface.

Constructor & Destructor Documentation

◆ RWObjectOutputStreamImp()

RWObjectOutputStreamImp::RWObjectOutputStreamImp ( const RWDataOutputStream & sinkStream )

inlineprotected

Used by derived classes to initialize the next processing stream. Throws no exceptions.

Parameters

sinkStream A handle to the next processing stream.

Member Function Documentation

◆ closeContext()

virtual void RWObjectOutputStreamImp::closeContext ( bool writeContext = true )

inlinevirtual

Called by RWWithObjectOutputContext dtor to close an open context.

◆ closeOuterContext()

virtual void RWObjectOutputStreamImp::closeOuterContext ( bool writeContext )

protectedpure virtual

Really closes an open context. This function is called when the number of closeContext() calls matches the number of openContext() calls.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ endAssoc()

virtual void RWObjectOutputStreamImp::endAssoc ( )

inlinevirtual

Called by the output operators for association types after each value.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ endBlock()

virtual void RWObjectOutputStreamImp::endBlock ( )

pure virtual

Outputs tokens that identify the end of an object.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ endElement()

virtual void RWObjectOutputStreamImp::endElement ( )

inlinevirtual

Called by the output operators for collection types after each element in a sequence.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ endMap()

virtual void RWObjectOutputStreamImp::endMap ( )

inlinevirtual

Called by the output operators for association types after all the pairs.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ endMember()

virtual void RWObjectOutputStreamImp::endMember ( const RWSymbol & )

inlinevirtual

Called by streamContents() after each data member is written.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ endParent()

virtual void RWObjectOutputStreamImp::endParent ( )

inlinevirtual

Outputs tokens that identify the end of an parent class.

◆ endSequence()

virtual void RWObjectOutputStreamImp::endSequence ( )

inlinevirtual

Called by the output operators for collection types at the end of a sequence.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ getContextNestingLevel()

int RWObjectOutputStreamImp::getContextNestingLevel ( )

inlineprotected

Returns the current context nesting level. 0 indicates no open context.

◆ needToWrite()

virtual bool RWObjectOutputStreamImp::needToWrite ( const void * obj )

pure virtual

Returns true when the referenced object has not yet been written to the stream in the current context. Otherwise, tokens are output identifying this object as having been previously streamed, and the function returns false.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ newObjectMarker()

virtual void RWObjectOutputStreamImp::newObjectMarker ( )

pure virtual

Output is a token indicating that an object will be created by the factory.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ openContext()

virtual void RWObjectOutputStreamImp::openContext ( bool writeContext = true )

inlinevirtual

Called by RWWithObjectOutputContext ctor to open a context in which multiple references to a single object are resolved.

◆ openOuterContext()

virtual void RWObjectOutputStreamImp::openOuterContext ( bool writeContext )

protectedpure virtual

Really opens a new context. This function is called by openContext() when a context is not already open.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ putString() [1/2]

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

inlineprotectedvirtual

Forwards the writing of a narrow character string, including embedded nulls, starting at string to the next processing stream.

Parameters

string	A pointer to the narrow string's first character.
count	The number of narrow character(s) to be written to the stream.

Reimplemented from RWFilteredDataOutputStreamImp.

Reimplemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ putString() [2/2]

virtual void RWObjectOutputStreamImp::putString ( const RWCString & str )

pure virtual

Writes an RWCString to the stream.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ putSymbol()

virtual void RWObjectOutputStreamImp::putSymbol ( const RWSymbol & sym )

virtual

Writes an RWSymbol to the stream.

◆ putUString() [1/2]

virtual void RWObjectOutputStreamImp::putUString ( const RWBasicUString & str )

pure virtual

Writes an RWBasicUString to the stream.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ putUString() [2/2]

virtual void RWObjectOutputStreamImp::putUString	(	const RWUChar *	ustring,
		RWSize	count )

inlineprotectedvirtual

Forwards the writing of a UTF-16 character string, including embedded nulls, starting at ustring to the next processing stream.

Parameters

ustring	A pointer to the string's first unicode character.
count	The number of unicode character(s) to be written to the stream.

Reimplemented from RWFilteredDataOutputStreamImp.

Reimplemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ putWString() [1/2]

virtual void RWObjectOutputStreamImp::putWString ( const RWWString & str )

pure virtual

Writes an RWWString to the stream.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ putWString() [2/2]

virtual void RWObjectOutputStreamImp::putWString	(	const wchar_t *	wstring,
		RWSize	count )

inlineprotectedvirtual

Forwards the writing of a wide character string, including embedded nulls, starting at wstring to the next processing stream.

Parameters

wstring	A pointer to the string's first wide character.
count	The number of wide character(s) to be written to the stream.

Reimplemented from RWFilteredDataOutputStreamImp.

Reimplemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ rememberObject()

virtual void RWObjectOutputStreamImp::rememberObject ( const void * obj )

pure virtual

Called by streaming operators to record each instance streamed out, in case it is referenced again in the same context.

Parameters

obj	Holds the address of the instance.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ setNameForNextObject()

virtual void RWObjectOutputStreamImp::setNameForNextObject ( const RWCString & str )

pure virtual

Sets up the instance name for the next object to be written out.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ startAssocKey()

virtual void RWObjectOutputStreamImp::startAssocKey ( )

inlinevirtual

Called by the output operators for association types before each key.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ startAssocValue()

virtual void RWObjectOutputStreamImp::startAssocValue ( )

inlinevirtual

Called by the output operators for association types after each key and before each value.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ startBlock()

virtual void RWObjectOutputStreamImp::startBlock ( const RWSymbol & typeInfo )

pure virtual

Outputs tokens that identify the start of a new object.

Parameters

typeInfo Identifies the type of the new object, if such information is available.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ startElement()

virtual void RWObjectOutputStreamImp::startElement ( int )

inlinevirtual

Called by the output operators for collection types before each element in a sequence.

Reimplemented in RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ startMap()

virtual void RWObjectOutputStreamImp::startMap	(	int	count,
		RWStreamType	keyType,
		RWStreamType	valueType,
		const RWSymbol &	typeInfo )

pure virtual

Called by the output operators for association types (hash tables, etc.) at the start.

Parameters

count	Contains the number of items in the association.
keyType	Contains the type of key in the association.
valueType	Contains the type of value in the association.
typeInfo	Contains the type of the association (collection) itself.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ startParent()

virtual void RWObjectOutputStreamImp::startParent ( const RWSymbol & )

inlinevirtual

Outputs tokens that identify the start of a parent class.

◆ startSequence()

virtual void RWObjectOutputStreamImp::startSequence	(	int	count,
		RWStreamType	elementType,
		const RWSymbol &	typeInfo )

pure virtual

Called by the output operators for collection types at the start of a sequence.

Parameters

count	Contains the number of items in the collection.
elementType	Contains the type of element in the collection.
typeInfo	Contains the type of the collection itself.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ writeMemberInfo()

virtual void RWObjectOutputStreamImp::writeMemberInfo	(	const RWSymbol &	memberName,
		RWStreamType	memberType )

pure virtual

Called for before each data member by the streamContents() function. Metadata about the field may or may not be written to the stream, depending on the implementation. This function returns true if data is actually written out. Otherwise, it returns false.

Parameters

memberName	Identifies the name of the member.
memberType	Identifies the type of the member.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ writeNullPtr()

virtual void RWObjectOutputStreamImp::writeNullPtr ( )

pure virtual

Output is a token representing a null pointer.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

◆ writeTypeInfo()

virtual void RWObjectOutputStreamImp::writeTypeInfo ( const RWSymbol & typeInfo )

pure virtual

Outputs the type information required to factory an object of the correct dynamic type (derived class) on input.

Parameters

typeInfo Identifies the type of the new object, if such information is available.

Implemented in RWCompactObjectOutputStreamImp, RWEnhancedXmlObjectOutputStreamImp, and RWXmlObjectOutputStreamImp.

Member Data Documentation

◆ nameForNextObject_

RWCString RWObjectOutputStreamImp::nameForNextObject_

protected

The name for the next object inserted or extracted. This name will be cleared as soon as an object has been written or read, and ignored if empty.

SourcePro® API Reference Guide

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RWObjectOutputStreamImp()

Member Function Documentation

◆ closeContext()

◆ closeOuterContext()

◆ endAssoc()

◆ endBlock()

◆ endElement()

◆ endMap()

◆ endMember()

◆ endParent()

◆ endSequence()

◆ getContextNestingLevel()

◆ needToWrite()

◆ newObjectMarker()

◆ openContext()

◆ openOuterContext()

◆ putString() [1/2]

◆ putString() [2/2]

◆ putSymbol()

◆ putUString() [1/2]

◆ putUString() [2/2]

◆ putWString() [1/2]

◆ putWString() [2/2]

◆ rememberObject()

◆ setNameForNextObject()

◆ startAssocKey()

◆ startAssocValue()

◆ startBlock()

◆ startElement()

◆ startMap()

◆ startParent()

◆ startSequence()

◆ writeMemberInfo()

◆ writeNullPtr()

◆ writeTypeInfo()

Member Data Documentation

◆ nameForNextObject_