![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MCollectible
Inherited By:
None.
Purpose:
Provides an address-space-independent way of identifying a model anchor. A model anchor is identified by a triplet (document ID, model ID, anchor 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.
- TModelAnchorReference (const TModelAnchor &)
- TModelAnchorReference (const TModelAnchorReference &)
- TModelAnchorReference (const TModelReference &, long hash)
- TModelAnchorReference ()
Interface Category:
API.
Purpose:
- Creates a reference to an existing model anchor.
- Copy constructor.
- Creates a new anchor reference from and existing one and preserves the hash value.
- Default constructor.
Calling Context:
- Call this function directly
- Called to copy an object.
- Called to fix up the copied anchor's references without breaking the hash.
- Called by the stream-in operators.
Parameters:
- const TModelAnchor & -The model anchor for which the new object is a reference.
- const TModelAnchorReference & -The model anchor reference to copy.
- const TModelReference & -The model anchor reference to copy.
- long hash -The hash value to be used for this reference.
- Takes no parameters.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TModelAnchorReference ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object. You can also call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
bool IsDefined () const
Interface Category:
API.
Purpose:
An anchor is defined if it has a model anchor ID. The ID cannot be the ID of a valid anchor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the reference is defined.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
bool IsReferenceFor (const TModelAnchor &) const
Interface Category:
API.
Purpose:
Tests whether or not this anchor reference refers to the specified anchor.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the reference refers to the specified anchor.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TModelAnchorReference::operatorTDocumentReference
operator TDocumentReference () const
Interface Category:
API.
Purpose:
Converts this reference to a reference to the document containing the anchor this reference refers to.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a reference to the document.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
operator TModelReference () const
Interface Category:
API.
Purpose:
Converts this reference to a reference to the model containing the anchor this reference refers to.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a reference to the model.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TModelAnchorReference & operator =(const TModelAnchorReference &)
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:
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.
bool operator ==(const TModelAnchorReference &) const
Interface Category:
API.
Purpose:
Tests two reference objects for equality. The references are equal if they refer to the same anchor. Two undefined references are not equal.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the references are for the same model.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
bool operator != (const TModelAnchorReference &) const
Interface Category:
API.
Purpose:
Tests two references for inequality. The references are not equal if they do not refer to the same anchor, or if either or both are undefined.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if the references are not to the same model.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
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.
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.
virtual long Hash () const
Interface Category:
API.
Purpose:
Generates a hash key. Used by the Collection classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a hash key.
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.
Copyright©1995 Taligent,Inc. All rights reserved.