Class: TAbstractKeyValuePair

Declaration: AbstractKeyValuePair.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TKeyValuePair.

Purpose:

TAbstractKeyValuePair is the abstract base class of TKeyValuePair. The derived class is used to manipulate pairs of objects pointers.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is used internally by collections. This class is not intended to be derived outside of collections. Do not derive.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TAbstractKeyValuePair::TAbstractKeyValuePair

TAbstractKeyValuePair ()
TAbstractKeyValuePair (const TTuple & tuple)
TAbstractKeyValuePair (const TAbstractKeyValuePair & that)

Interface Category:

API.

Purpose:

Default constructor.
Creates an object and sets its pointers and hash value as contained in the TTuple argument.
Copy constructor.

Calling Context:

Call this function directly.
Call this function directly to create an object and sets its pointers as contained in the TTuple argument.
Call this function directly to copy an object.

Parameters:

Takes no parameters.
const TTuple & tuple -The object to be used to extract the objects pointers.
const TAbstractKeyValuePair & that -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractKeyValuePair::~TAbstractKeyValuePair

virtual ~ TAbstractKeyValuePair ()

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

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

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.

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