Class: TPlaceReference

Declaration: BasicPlaces.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

The TPlaceReference class provides an address-space independent means of referring to Places on a system.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPlaceReference::TPlaceReference

TPlaceReference (const TPlaceReference & copy)
TPlaceReference ()

Interface Category:

API.

Purpose:

Copy constructor.
Default constructor.

Calling Context:

Called to copy an object.
Called by the stream-in operators.

Parameters:

const TPlaceReference & copy -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPlaceReference::~TPlaceReference

virtual ~ TPlaceReference ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called 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: TPlaceReference::GetDefaultPlace

static TPlaceReference GetDefaultPlace ()

Interface Category:

API.

Purpose:

Returns a reference to the default place to use.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the default place to use.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPlaceReference::IsDefined

bool IsDefined () const

Interface Category:

API.

Purpose:

Determines whether or not this place reference is defined. A place is defined if it ever referred to a valid Place.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if this place is defined.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPlaceReference::operator=

TPlaceReference & operator =(const TPlaceReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TPlaceReference & -The object to be copied.

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPlaceReference::operator==

bool operator ==(const TPlaceReference &) const

Interface Category:

API.

Purpose:

Tests whether the two objects on either side of the ==symbol are equal.

Calling Context:

Call this function by using the operator in an expression.

Parameters:

const TPlaceReference & -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: TPlaceReference::operator!=

bool operator != (const TPlaceReference &) const

Interface Category:

API.

Purpose:

Tests whether the two objects on either side of the != symbol are equal.

Calling Context:

Call this function by using the operator in an expression.

Parameters:

const TPlaceReference & -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: TPlaceReference::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 to which the object streams itself out.

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: TPlaceReference::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 from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPlaceReference::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this object.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value for this 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.