Class: TAbstractModelFunctor

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

~TAbstractModelFunctor
TAbstractModelFunctor
GetModelReference
SetModelReference
operator<<=
operator>>=

Interface Category:

API.

Inherits From:

TAbstractDocumentFunctor

Inherited By:

TReadOnlyModelFunctorOn

Purpose:

The TAbstractModelFunctor class is the abstract base class for document functors that apply to the model object. A model functor is sent to a model surrogate. The functor is then sent to the corresponding real document and model instance and performed there.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Do not derive from this class, but rather a more specific class such as TReadOnlyModelFunctorOn.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Invariants:

Functors do not maintain state.

Member Function: TAbstractModelFunctor::~TAbstractModelFunctor

virtual ~ TAbstractModelFunctor ()

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

TAbstractModelFunctor ()
TAbstractModelFunctor ( const TModelReference & )
TAbstractModelFunctor ( const TAbstractModelFunctor & )

Interface Category:

API.

Purpose:

Default constructor.
Constructs a functor for a specific model.
Copy constructor.

Calling Context:

Called by the stream-in operators and derived classes.
Called by derived classes.
Called by derived classes.

Parameters:

Takes no parameters.
const TModelReference & -The model to apply the functor to.
const TAbstractModelFunctor & -The functor to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModelFunctor::GetModelReference

TModelReference GetModelReference () const

Interface Category:

API.

Purpose:

Gets a reference to the model to which this functor applies.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the model reference.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModelFunctor::SetModelReference

void SetModelReference (const TModelReference &) const

Interface Category:

API.

Purpose:

Sets a reference to the model to which this functor applies.

Calling Context:

Call this function directly.

Parameters:

const TModelReference & -The model to apply the functor to.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModelFunctor::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:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractModelFunctor::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:

Multithread safe.

Other Considerations:

None.

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