Class: TKeyValuePair

Declaration: KeyValuePair.h

Taxonomy Categories:

Member Functions:

TKeyValuePair
~TKeyValuePair
GetKey
GetValue
SetKey
SetValue
operator>>=
operator<<=
operator=

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Manipulates objects' pointers. The protocol supports the adding and removing of objects' pointers.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TKeyValuePair::TKeyValuePair

TKeyValuePair ()
TKeyValuePair (const TKeyValuePair < AKey, AValue >&)
TKeyValuePair (AKey * k, AValue * v)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructor taking a key and value pointers.

Calling Context:

Call this function directly to create an object.
Call this function directly to copy an object.
Call this function directly to create an object and sets its key and value pointers.

Parameters:

Takes no parameters.
const TKeyValuePair < AKey, AValue >& -The object to be copied.
AKey * k -The key object pointer.
AValue * v -The value object pointer.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyValuePair::~TKeyValuePair

virtual ~ TKeyValuePair ()

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: TKeyValuePair::GetKey

AKey * GetKey () const

Interface Category:

API.

Purpose:

Returns the key object pointer.

Calling Context:

Call this function directly to return the key object pointer.

Parameters:

Takes no parameters.

Return Value:

The key object pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyValuePair::GetValue

AValue * GetValue () const

Interface Category:

API.

Purpose:

Returns the value object pointer.

Calling Context:

Call this function directly to return the value object pointer.

Parameters:

Takes no parameters.

Return Value:

The value object pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyValuePair::SetKey

void SetKey (AKey * k)

Interface Category:

API.

Purpose:

Sets the key pointer.

Calling Context:

Call this function directly to set the key pointer.

Parameters:

AKey * k -A pointer to the object used to set the key pointer.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyValuePair::SetValue

void SetValue (AValue * v)

Interface Category:

API.

Purpose:

Sets the value pointer.

Calling Context:

Call this function directly to set the value pointer.

Parameters:

AValue * v -A pointer to the object used to set the value pointer.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyValuePair::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: TKeyValuePair::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.

Member Function: TKeyValuePair::operator=

TKeyValuePair < AKey , AValue >& operator =(const TKeyValuePair < AKey, AValue

& that)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TKeyValuePair < AKey ,AValue >& that -The object to be copied.

Return Value:

A 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.