Class: TPolymorphicPairStreamer

Declaration: PolymorphicStreamer.h

Taxonomy Categories:

Member Functions:

TPolymorphicPairStreamer
~TPolymorphicPairStreamer
StreamOut
StreamIn
TypeSafeStreamIn
operator=

Interface Category:

API.

Inherits From:

TStreamer

Inherited By:

None.

Purpose:

Provides operators for the streaming of key-value pair objects using the CommonPoint polymorphic streaming calls FlattenPointer and Resurrect.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TPolymorphicStreamer.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPolymorphicPairStreamer::TPolymorphicPairStreamer

TPolymorphicPairStreamer ()
TPolymorphicPairStreamer (const TPolymorphicPairStreamer < AType > &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Call this function directly anywhere the creation of a TPolymorphicPairStreamer is desired.
Call this function directly to copy an object.

Parameters:

Takes no parameters.
const TPolymorphicPairStreamer < AType > & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPolymorphicPairStreamer::~TPolymorphicPairStreamer

virtual ~ TPolymorphicPairStreamer ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Call this function directly to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPolymorphicPairStreamer::StreamOut

virtual TStream & StreamOut (AType * obj, TStream & stream) const

Interface Category:

API.

Purpose:

Polymorphically streams out key and value objects after extracting them from their association object.

Calling Context:

Call this function directly to stream out a pair of objects.

Parameters:

AType * obj -The object containing the key-value pair.
TStream & stream -The stream to which the pair are streamed.

Return Value:

A reference to the stream to which the pair are streamed.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPolymorphicPairStreamer::StreamIn

virtual AType * StreamIn (TStream & stream) const

Interface Category:

API.

Purpose:

Resurrects a key-value pair from a stream.

Calling Context:

Call this function directly to stream in a key-value pair.

Parameters:

TStream & stream -The stream from which the pair is resurrected.

Return Value:

A reference to the resurrected object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPolymorphicPairStreamer::TypeSafeStreamIn

virtual void * TypeSafeStreamIn (TStream & stream) const

Interface Category:

API.

Purpose:

Resurrects a key-value pair from a stream and returns it to the nontemplatized implementation.

Calling Context:

Call this function directly to stream in a key-value pair from the nontemplatized implementation.

Parameters:

TStream & stream -The stream from which to stream in the values.

Return Value:

A void pointer to the resurrected object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPolymorphicPairStreamer::operator=

const TPolymorphicPairStreamer < AType > & operator =(const TPolymorphicPairStreamer < AType > &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly when an object is assigned to another compatible object.

Parameters:

const TPolymorphicPairStreamer < AType > & -The object to be assigned.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.