Class: TAbstractModel

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

~TAbstractModel
GetReference
operator>>=
operator<<=
Hash
TAbstractModel
operator=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TModel TModelSurrogate

Purpose:

Provides the common API shared by models and surrogates.

Instantiation:

Abstract base class; do not instantiate.

Deriving Classes:

Provides a common base for TModelSurrogate and TModel. Do not derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TAbstractModel::~TAbstractModel

virtual ~ TAbstractModel ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModel::GetReference

TModelReference GetReference () const

Interface Category:

API.

Purpose:

Gets a reference to this model.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to this model.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModel::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 is streamed 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:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModel::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 is streamed 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:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModel::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Speeds comparison.

Calling Context:

Called by collection classes.

Parameters:

Takes no parameters.

Return Value:

Returns the integer hash value of the object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModel::TAbstractModel

TAbstractModel (const TDocumentReference &)
TAbstractModel ()
TAbstractModel (const TAbstractModel &)
TAbstractModel (const TModelReference &)

Interface Category:

API.

Purpose:

Create a model for a specific document.
Default constructor.
Copy constructor.
Constructs a model with a given reference.

Calling Context:

Called only by derived classes
Called by the stream-in operators and derived classes.
Called to copy an object.
Called by derived classes.

Parameters:

const TDocumentReference & -The document that will contain this model.
Takes no parameters.
const TAbstractModel & -The model to copy.
const TModelReference & -The ID for the model.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

TAbstractModel is an abstract base class--all the constructors are protected. Do not instantiate this class.

Member Function: TAbstractModel::operator=

TAbstractModel & operator =(const TAbstractModel &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TAbstractModel & -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:

Multithread safe.

Other Considerations:

TAbstractModel is an abstract base class--all the constructors are protected. Do not instantiate this class.

Click the icon to mail questions or corrections about this material to Taligent personnel.