Handle class for all the object output stream implementation classes. More...

#include <rw/serial/RWObjectOutputStream.h>

Inheritance diagram for RWObjectOutputStream:

Public Member Functions
	RWObjectOutputStream (const RWObjectOutputStream &handle)

	RWObjectOutputStream (RWObjectOutputStreamImp *body)

void	closeContext (bool writeContext=true)

void	endAssoc ()

void	endBlock ()

void	endElement ()

void	endMap ()

void	endMember (const RWSymbol &memberName)

void	endParent ()

void	endSequence ()

bool	needToWrite (const void *obj)

void	newObjectMarker ()

void	openContext (bool writeContext=true)

RWObjectOutputStream &	operator= (const RWObjectOutputStream &handle)

void	putString (const RWCString &str)

void	putString (const std::string &str)

void	putSymbol (const RWSymbol &sym)

void	putUString (const RWBasicUString &str)

void	putWString (const RWWString &str)

void	rememberObject (const void *obj)

void	setNameForNextObject (const RWCString &instanceName)

void	startAssocKey ()

void	startAssocValue ()

void	startBlock (const RWSymbol &typeInfo)

void	startElement (int position)

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

void	startParent (const RWSymbol &typeInfo)

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

void	writeMemberInfo (const RWSymbol &memberName, RWStreamType memberType)

void	writeNullPtr ()

void	writeTypeInfo (const RWSymbol &typeInfo)

Public Member Functions inherited from RWDataOutputStream
	RWDataOutputStream (const RWDataOutputStream &handle)

	RWDataOutputStream (RWDataOutputStreamImp *ptr)

void	close ()

void	flush ()

bool	isBad () const

bool	isFail () const

bool	isGood () const

RWDataOutputStream &	operator<< (bool value)

RWDataOutputStream &	operator<< (char value)

RWDataOutputStream &	operator<< (double value)

RWDataOutputStream &	operator<< (float value)

RWDataOutputStream &	operator<< (int value)

RWDataOutputStream &	operator<< (long double value)

RWDataOutputStream &	operator<< (long long value)

RWDataOutputStream &	operator<< (long value)

RWDataOutputStream &	operator<< (RWDataOutputStream &(*pf)(RWDataOutputStream &))

RWDataOutputStream	operator<< (RWDataOutputStream(*pf)(RWDataOutputStream &))

RWDataOutputStream &	operator<< (short value)

RWDataOutputStream &	operator<< (signed char value)

RWDataOutputStream &	operator<< (unsigned char value)

RWDataOutputStream &	operator<< (unsigned int value)

RWDataOutputStream &	operator<< (unsigned long value)

RWDataOutputStream &	operator<< (unsigned short value)

RWDataOutputStream &	operator<< (wchar_t value)

RWDataOutputStream &	operator= (const RWDataOutputStream &handle)

void	putBool (bool value)

void	putBools (const bool *arrayPt, RWSize count)

void	putChar (char value)

virtual void	putCharacter (char value)

void	putChars (const char *arrayPt, RWSize count)

void	putDouble (double value)

void	putDoubles (const double *arrayPt, RWSize count)

void	putFloat (float value)

void	putFloats (const float *arrayPt, RWSize count)

void	putInt (int value)

void	putInts (const int *arrayPt, RWSize count)

void	putLong (long value)

void	putLongDouble (long double value)

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

void	putLongLong (long long value)

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

void	putLongs (const long *arrayPt, RWSize count)

void	putShort (short value)

void	putShorts (const short *arrayPt, RWSize count)

void	putSignedChar (signed char value)

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

virtual void	putSizeT (size_t value)

void	putString (const char *string, RWSize count)

virtual void	putUCharacter (RWUChar value)

void	putUnsignedChar (unsigned char value)

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

void	putUnsignedInt (unsigned int value)

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

void	putUnsignedLong (unsigned long value)

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

void	putUnsignedShort (unsigned short value)

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

void	putUString (const RWUChar *ustring, RWSize count)

void	putWchar_t (wchar_t value)

void	putWchar_ts (const wchar_t *arrayPt, RWSize count)

virtual void	putWCharacter (wchar_t value)

void	putWString (const wchar_t *wstring, RWSize count)

Public Member Functions inherited from RWHandleBase
bool	isValid (void) const

bool	operator!= (const RWHandleBase &second) const

bool	operator== (const RWHandleBase &second) const

Additional Inherited Members
Protected Member Functions inherited from RWHandleBase
	RWHandleBase (const RWHandleBase &second)

	RWHandleBase (RWBodyBase *body)

	RWHandleBase (RWStaticCtor)

	RWHandleBase (void)

	~RWHandleBase (void)

RWBodyBase &	body (void) const

RWHandleBase &	operator= (const RWHandleBase &second)

Related Symbols inherited from RWDataOutputStream
RWDataOutputStream &	rwEndl (RWDataOutputStream &stream)

RWDataOutputStream &	rwEnds (RWDataOutputStream &stream)

RWDataOutputStream &	rwFlush (RWDataOutputStream &stream)

RWDataOutputStream	rwGuard (RWDataOutputStream &stream)

RWDataOutputStream &	rwWEndl (RWDataOutputStream &stream)

RWDataOutputStream &	rwWEnds (RWDataOutputStream &stream)

Detailed Description

Handle class for all the object output stream implementation classes. Implements the handle idiom from the handle/body pattern. With the exception of constructors and assignment operators, all member functions forward directly to the implementation associated with this handle during construction.

Constructor & Destructor Documentation

◆ RWObjectOutputStream() [1/2]

RWObjectOutputStream::RWObjectOutputStream ( RWObjectOutputStreamImp * body )

inlineexplicit

Constructor.

Parameters

body	The stream implementation to associate with this handle.

◆ RWObjectOutputStream() [2/2]

RWObjectOutputStream::RWObjectOutputStream ( const RWObjectOutputStream & handle )

inline

Copy constructor. Throws no exceptions.

Parameters

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

Member Function Documentation

◆ closeContext()

void RWObjectOutputStream::closeContext ( bool writeContext = true )

inline

Called by RWWithObjectOutputContext dtor to close an open context.

◆ endAssoc()

void RWObjectOutputStream::endAssoc ( )

inline

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

◆ endBlock()

void RWObjectOutputStream::endBlock ( )

inline

Outputs tokens that identify the end of an object.

◆ endElement()

void RWObjectOutputStream::endElement ( )

inline

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

◆ endMap()

void RWObjectOutputStream::endMap ( )

inline

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

◆ endMember()

void RWObjectOutputStream::endMember ( const RWSymbol & memberName )

inline

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

Parameters

memberName Identifies the name of the member.

◆ endParent()

void RWObjectOutputStream::endParent ( )

inline

Outputs tokens that identify the end of an parent class.

◆ endSequence()

void RWObjectOutputStream::endSequence ( )

inline

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

◆ needToWrite()

bool RWObjectOutputStream::needToWrite ( const void * obj )

inline

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

◆ newObjectMarker()

void RWObjectOutputStream::newObjectMarker ( )

inline

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

◆ openContext()

void RWObjectOutputStream::openContext ( bool writeContext = true )

inline

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

◆ operator=()

RWObjectOutputStream & RWObjectOutputStream::operator= ( const RWObjectOutputStream & handle )

inline

Assignment operator. Throws no exceptions.

Parameters

handle A data stream handle used to initialize this handle.

◆ putString() [1/2]

void RWObjectOutputStream::putString ( const RWCString & str )

inline

Writes an RWCString to the stream.

◆ putString() [2/2]

void RWObjectOutputStream::putString ( const std::string & str )

inline

Writes a std::string to the stream.

◆ putSymbol()

void RWObjectOutputStream::putSymbol ( const RWSymbol & sym )

inline

Writes an RWSymbol to the stream.

◆ putUString()

void RWObjectOutputStream::putUString ( const RWBasicUString & str )

inline

Writes an RWBasicUString to the stream.

◆ putWString()

void RWObjectOutputStream::putWString ( const RWWString & str )

inline

Writes an RWWString to the stream.

◆ rememberObject()

void RWObjectOutputStream::rememberObject ( const void * obj )

inline

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.

◆ setNameForNextObject()

void RWObjectOutputStream::setNameForNextObject ( const RWCString & instanceName )

inline

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

◆ startAssocKey()

void RWObjectOutputStream::startAssocKey ( )

inline

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

◆ startAssocValue()

void RWObjectOutputStream::startAssocValue ( )

inline

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

◆ startBlock()

void RWObjectOutputStream::startBlock ( const RWSymbol & typeInfo )

inline

Outputs tokens that identify the start of a new object.

Parameters

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

◆ startElement()

void RWObjectOutputStream::startElement ( int position )

inline

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

Parameters

position Contains the position of the element.

◆ startMap()

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

inline

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.

◆ startParent()

void RWObjectOutputStream::startParent ( const RWSymbol & typeInfo )

inline

Outputs tokens that identify the start of a parent class.

Parameters

typeInfo Identifies the type of the parent class, if such information is available.

◆ startSequence()

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

inline

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.

◆ writeMemberInfo()

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

inline

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 returns false.

Parameters

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

◆ writeNullPtr()

void RWObjectOutputStream::writeNullPtr ( )

inline

Output is a token representing a null pointer.

◆ writeTypeInfo()

void RWObjectOutputStream::writeTypeInfo ( const RWSymbol & typeInfo )

inline

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.

SourcePro® API Reference Guide

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RWObjectOutputStream() [1/2]

◆ RWObjectOutputStream() [2/2]

Member Function Documentation

◆ closeContext()

◆ endAssoc()

◆ endBlock()

◆ endElement()

◆ endMap()

◆ endMember()

◆ endParent()

◆ endSequence()

◆ needToWrite()

◆ newObjectMarker()

◆ openContext()

◆ operator=()

◆ putString() [1/2]

◆ putString() [2/2]

◆ putSymbol()

◆ putUString()

◆ putWString()

◆ rememberObject()

◆ setNameForNextObject()

◆ startAssocKey()

◆ startAssocValue()

◆ startBlock()

◆ startElement()

◆ startMap()

◆ startParent()

◆ startSequence()

◆ writeMemberInfo()

◆ writeNullPtr()

◆ writeTypeInfo()