Class: MCommandRequiringDataFixup

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

MCommandRequiringDataFixup
~MCommandRequiringDataFixup
FixupDataBeforeDo

Interface Category:

API.

Inherits From:

None.

Inherited By:

TCommandRequiringDataFixup

Purpose:

MCommandRequiringDataFixup is a mixin class for commands that use model data that must be fixed up prior to passing the data to a target selection. The Document Frameworks guarantees that model's are fixed up prior to logging of the command for recovery, so that an IDs assigned as part of fixup are deterministic if the log is replayed.

Instantiation:

Abstract base class; do not allocate.

Deriving Classes:

Derive a command class from this mixin if it requires data fixup to be performed before Do. Derived classes must override the pure virtual function FixupDataBeforeDo.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: MCommandRequiringDataFixup::MCommandRequiringDataFixup

MCommandRequiringDataFixup ()
MCommandRequiringDataFixup (const MCommandRequiringDataFixup &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const MCommandRequiringDataFixup & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

MCommandRequiringDataFixup is an abstract base class. Do not instantiate this class.

Member Function: MCommandRequiringDataFixup::~MCommandRequiringDataFixup

virtual ~ MCommandRequiringDataFixup ()

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: MCommandRequiringDataFixup::FixupDataBeforeDo

virtual void FixupDataBeforeDo (const MDataExchanger &)

Interface Category:

API.

Purpose:

Fixes up the model before it is passed on to target selection.

Calling Context:

Called prior to logging or Doing command.

Parameters:

const MDataExchanger & -The target selection to be used for fixup.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is a pure virtual function and must be overridden by classes deriving from MCommandRequiringDataFixup.

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