Class: TAbstractStreamer

Declaration: Streamer.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TStreamer

Purpose:

Abstract class that implements the protocol for streaming operations in a streamer object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive classes from TAbstractStreamer.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAbstractStreamer::TAbstractStreamer

TAbstractStreamer ()
TAbstractStreamer (const TAbstractStreamer &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Call this function directly anytime that creation of a TAbstractStreamer is desired.
Call this function directly to copy 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: TAbstractStreamer::~TAbstractStreamer

virtual ~ TAbstractStreamer ()

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: TAbstractStreamer::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call this function directly to stream out data.

Parameters:

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

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractStreamer::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Call this function directly to stream in data.

Parameters:

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

Return Value:

Returns 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: TAbstractStreamer::TypeSafeStreamOut

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

Interface Category:

API.

Purpose:

Pure virtual operation for polymorphically stream out an object.

Calling Context:

Call this function directly to stream out an object.

Parameters:

void * obj -Object to be streamed out.
TStream & stream -The stream where the object is streamed out.

Return Value:

A reference to the stream.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Derived classes need to override this operation.

Member Function: TAbstractStreamer::TypeSafeStreamIn

virtual void * TypeSafeStreamIn (TStream & stream) const

Interface Category:

API.

Purpose:

Pure virtual operation for polymorphically stream out an object.

Calling Context:

Call this function directly to stream in an object.

Parameters:

TStream & stream -The stream where the object is streamed out.

Return Value:

A reference to the stream.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Derived classes need to override this operation.

Member Function: TAbstractStreamer::operator=

const TAbstractStreamer & operator =(const TAbstractStreamer &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TAbstractStreamer & -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.