Class: TReadOnlyModelFunctorOn

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractModelFunctor

Inherited By:

None.

Purpose:

The TReadOnlyModelFunctorOn class is the base class for functors that apply to the model object for read-only access. Derive from this class and override HandleDo to perform a specific function. The model is locked and passed in.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Any functor requiring read access from a model should derive from this class. Derived classes must override the pure virtual function HandleDo.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

Invariants: Functors do not maintain state.

Member Function: TReadOnlyModelFunctorOn::~TReadOnlyModelFunctorOn

virtual ~ TReadOnlyModelFunctorOn ()

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

TReadOnlyModelFunctorOn ()
TReadOnlyModelFunctorOn ( const TModelReference & )
TReadOnlyModelFunctorOn ( const TReadOnlyModelFunctorOn<AModel> & )

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 TReadOnlyModelFunctorOn<AModel> & -The functor to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TReadOnlyModelFunctorOn::HandleDo

virtual void HandleDo ( const AModel & )

Interface Category:

API.

Purpose:

Executes the functor on the model.

Calling Context:

Call only by TReadOnlyModelFunctorOn. Derived classes override this member function to perform their action on the model. Its actions are limited to read only.

Parameters:

const AModel & -The target model.

Return Value:

None.

Exceptions:

Throws no exceptions. All exceptions are passed through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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