Class: TModelLinkReference

Declaration: CompoundDocumentLinking.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

Provides an address-space-independent way of identifying a model link. A model link is identified by a quadruplet (document ID, model ID, anchor ID, link ID).

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: TModelLinkReference::TModelLinkReference

TModelLinkReference (const TModelLink &)
TModelLinkReference (const TModelLinkReference &)
TModelLinkReference (const TModelAnchorReference &)
TModelLinkReference ()

Interface Category:

API.

Purpose:

Constructs a reference to the specified model link.
Copy constructor.
Constructs a reference to the specified model anchor.
Default constructor.

Calling Context:

Call this function directly.
Called to copy an object. You can also call this function directly.
Call this function directly.
Called by the stream-in operators and directly.

Parameters:

const TModelLink & -The link to make a reference from.
const TModelLinkReference & -A reference to copy.
const TModelAnchorReference & -The anchor to make a reference from.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::~TModelLinkReference

virtual ~ TModelLinkReference ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. You can also call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::IsDefined

bool IsDefined () const

Interface Category:

API.

Purpose:

A link is defined if it has a model link ID. The ID cannot be the ID of a valid link if the reference is to a link that has been deleted.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if reference is defined.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::IsReferenceFor

bool IsReferenceFor (const TModelLink &) const

Interface Category:

API.

Purpose:

Tests whether or not this link reference refers to the specified link.

Calling Context:

Call this function directly.

Parameters:

const TModelLink & -The link to test the reference against.

Return Value:

Returns true if the reference refers to the specified link.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::operatorTDocumentReference

operator TDocumentReference () const

Interface Category:

API.

Purpose:

Converts this reference to a reference to the document containing the link this reference refers to.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the document.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::operatorTModelAnchorReference

operator TModelAnchorReference () const

Interface Category:

API.

Purpose:

Converts this reference to a reference to the anchor containing the link this reference refers to.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the anchor.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::operator=

TModelLinkReference & operator =(const TModelLinkReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. You can also call this function directly.

Parameters:

const TModelLinkReference & -The right-hand side object.

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: TModelLinkReference::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash key. Used by the Collection classes.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a hash key.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::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: TModelLinkReference::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: TModelLinkReference::operator!=

bool operator != (const TModelLinkReference &) 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 TModelLinkReference & -The object to be compared to this object.

Return Value:

Returns true if the two objects are not equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::operator==

bool operator ==(const TModelLinkReference &) 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 TModelLinkReference & -The object to be compared to this object.

Return Value:

Returns true if the two objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelLinkReference::operatorTModelReference

operator TModelReference () const

Interface Category:

API.

Purpose:

Converts this reference to a reference to the model containing the link this reference refers to.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

TModelReference -A reference to the containing model.

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.