Class: TPolymorphicStreamer

Declaration: PolymorphicStreamer.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStreamer

Inherited By:

None.

Purpose:

Provides operators for the streaming of 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: TPolymorphicStreamer::TPolymorphicStreamer

TPolymorphicStreamer ()
TPolymorphicStreamer (const TPolymorphicStreamer < AType > &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TPolymorphicStreamer < 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: TPolymorphicStreamer::~TPolymorphicStreamer

virtual ~ TPolymorphicStreamer ()

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: TPolymorphicStreamer::StreamOut

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

Interface Category:

API.

Purpose:

Polymorphically streams out an MCollectible object.

Calling Context:

Call this function directly to stream out an MCollectible object.

Parameters:

AType * obj -The object to be streamed out.
TStream & stream -The stream to which the object streams itself out.

Return Value:

A reference to the stream to which the object streams itself out.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPolymorphicStreamer::StreamIn

virtual AType * StreamIn (TStream & stream) const

Interface Category:

API.

Purpose:

Resurrects an MCollectible object from a stream.

Calling Context:

Call this function directly stream in an MCollectible object from a stream.

Parameters:

TStream & stream -The stream from which the object streams itself in.

Return Value:

A reference to the object streamed in.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPolymorphicStreamer::operator=

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

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TPolymorphicStreamer < 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.