Class: TModelInterest

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

TModelInterest
~TModelInterest
operator=
operator>>=
operator<<=
Hash
GetModelReference

Interface Category:

API.

Inherits From:

TInterest

Inherited By:

None.

Purpose:

Specifies interest in notifications from a specific model.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TModelInterest::TModelInterest

TModelInterest (const TModelReference & theModel, const TToken & theName)
TModelInterest (const TModelInterest &)
TModelInterest ()

Interface Category:

API.

Purpose:

Constructs an interest in a notification from a specific model.
Copy constructor. Only for internal use by Resurrect. Developers should treat as protected.
Default constructor. This is only for internal use by Resurrect. This function is protected.

Calling Context:

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

Parameters:

const TModelReference & theModel -The model.
const TToken & theName -The notification name.
const TModelInterest & -The interest 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: TModelInterest::~TModelInterest

virtual ~ TModelInterest ()

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

const TModelInterest & operator =(const TModelInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -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: TModelInterest::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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: TModelInterest::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Speeds comparison.

Calling Context:

Called by collections when comparing objects.

Parameters:

Takes no parameters.

Return Value:

Returns the integer hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelInterest::GetModelReference

virtual TModelReference GetModelReference () const

Interface Category:

API.

Purpose:

Provides access to the model this interest specifies interest in.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the model for this interest.

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.