Class: TCommandRequiringDataFixup

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

TCommandRequiringDataFixup
operator=
~TCommandRequiringDataFixup
FixupDataBeforeDo
operator>>=
operator<<=
AdoptModel
OrphanModel
GetModel
HandleCommitUndone

Interface Category:

API.

Inherits From:

TCommandOn, MCommandRequiringDataFixup

Inherited By:

TAbsorbDataCommand TReplaceDataCommand

Purpose:

This command is a base class for commands that use model data that must be fixed up prior to passing the data to a target selection. The Document Frameworks guarantee 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:

Allocate on the heap or the stack.

Deriving Classes:

Derive commands from this class that require fixup to be performed on a TModel before Do.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Invariants:

Assert (GetModel() != NIL)

Member Function: TCommandRequiringDataFixup::TCommandRequiringDataFixup

TCommandRequiringDataFixup (TModel * modelToAdopt)
TCommandRequiringDataFixup (const TCommandRequiringDataFixup &)
TCommandRequiringDataFixup ()

Interface Category:

API.

Purpose:

Constructs a command with a model to be fixed up.
Copy constructor.
Default constructor.

Calling Context:

Called by derived class to provide data to be fixed up.
Called to copy an object.
Called by the stream-in operators.

Parameters:

TModel * modelToAdopt -The model to be adopted and fixed up.
const TCommandRequiringDataFixup & -The command 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: TCommandRequiringDataFixup::operator=

TCommandRequiringDataFixup & operator =(const TCommandRequiringDataFixup &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCommandRequiringDataFixup & -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: TCommandRequiringDataFixup::~TCommandRequiringDataFixup

virtual ~ TCommandRequiringDataFixup ()

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

None.

Member Function: TCommandRequiringDataFixup::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: TCommandRequiringDataFixup::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: TCommandRequiringDataFixup::AdoptModel

void AdoptModel (TModel *)

Interface Category:

API.

Purpose:

Adopts the model that must be fixed up.

Calling Context:

Called by derived classes.

Parameters:

TModel * -The model to be fixed up.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandRequiringDataFixup::OrphanModel

TModel * OrphanModel ()

Interface Category:

API.

Purpose:

Orphans the model to be fixed up.

Calling Context:

Called by derived classes.

Parameters:

Takes no parameters.

Return Value:

Returns the orphaned model.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandRequiringDataFixup::GetModel

TModel * GetModel ()

Interface Category:

API.

Purpose:

Gets the model to be fixed up.

Calling Context:

Called by derived classes.

Parameters:

Takes no parameters.

Return Value:

Returns the model to be fixed up.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandRequiringDataFixup::HandleCommitUndone

virtual void HandleCommitUndone ()

Interface Category:

API.

Purpose:

Undoes the effect of committing the command.

Calling Context:

Called by derived classes.

Parameters:

Takes no parameters.

Return Value:

None.

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.