Class: TCollectibleGlobalID

Declaration: GlobalID.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible, TGlobalID

Inherited By:

TCanvasGraphicID

Purpose:

TCollectibleGlobalID derives from TGlobalID and simply wraps up global IDs into an MCollectible object that can be used in collection classes. When templates arrive, this class will be obsolete.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCollectibleGlobalID::TCollectibleGlobalID

TCollectibleGlobalID ()
TCollectibleGlobalID (const TCollectibleGlobalID &)
TCollectibleGlobalID (const TGlobalID &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructs a new TCollectibleGlobalID wrapper for the specified TGlobalID.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Call this function directly.

Parameters:

Takes no parameters.
const TCollectibleGlobalID & -The object to be copied.
const TGlobalID & -The global ID for which the new object is a wrapper.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCollectibleGlobalID::operator==

bool operator ==(const TCollectibleGlobalID &) const

Interface Category:

API.

Purpose:

Tests whether the two objects are equal.

Calling Context:

Call this function by using the operator in an expression.

Parameters:

const TCollectibleGlobalID & -The object to be compared to this object.

Return Value:

Returns true if the two objects are equal; false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCollectibleGlobalID::operator!=

bool operator != (const TCollectibleGlobalID &) const

Interface Category:

API.

Purpose:

Tests whether the two objects are not equal.

Calling Context:

Call this function by using the operator in an expression.

Parameters:

const TCollectibleGlobalID & -The object to be compared to this object.

Return Value:

Returns true if the two objects are not equal; false otherwise.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCollectibleGlobalID::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this collectible global ID.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value for this collectible global ID.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCollectibleGlobalID::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

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

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

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.