Class: TStreamer

Declaration: Streamer.h

Taxonomy Categories:

Member Functions:

StreamOut
StreamIn
TStreamer
TypeSafeStreamOut
TypeSafeStreamIn
operator=

Interface Category:

API.

Inherits From:

TAbstractStreamer

Inherited By:

TMonomorphicPairStreamer TMonomorphicStreamer TPolymorphicPairStreamer TPolymorphicStreamer

Purpose:

TStreamer is an abstract class that defines a type-safe streaming protocol for the TAbstractStreamer class.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TStreamer.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TStreamer::StreamOut

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

Interface Category:

API.

Purpose:

Provides a type-aware stream-out operation.

Calling Context:

Call this function directly to stream out an object.

Parameters:

AType * obj -The object to be streamed out.
TStream & stream -The stream.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Derived classes must provide their own implementation of this operation.

Member Function: TStreamer::StreamIn

virtual AType * StreamIn (TStream & stream) const

Interface Category:

API.

Purpose:

Provides a type-aware stream-in operation.

Calling Context:

Call this function directly to stream in an object.

Parameters:

TStream & stream -The stream to which the object streams itself.

Return Value:

A reference to the stream.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Derived classes must provide their own implementation of this operation.

Member Function: TStreamer::TStreamer

TStreamer ()
TStreamer (const TStreamer < AType > &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TStreamer < 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: TStreamer::TypeSafeStreamOut

virtual TStream & TypeSafeStreamOut (void * obj, TStream & stream) const

Interface Category:

API.

Purpose:

Provides a type-safe way to stream out an object.

Calling Context:

Call this function directly to stream out an object.

Parameters:

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

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStreamer::TypeSafeStreamIn

virtual void * TypeSafeStreamIn (TStream & stream) const

Interface Category:

API.

Purpose:

Provides a type-safe way to stream in an object.

Calling Context:

Call this function directly to stream in an object.

Parameters:

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

Return Value:

A reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStreamer::operator=

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

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

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