Class: TOrphanLinkCommand

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

TOrphanLinkCommand
operator=
~TOrphanLinkCommand
operator>>=
operator<<=
HandleDoBegin
HandleUndo
HandleRedo

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

Orphans an existing link from a model. This command supports undo and redo operations.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TOrphanLinkCommand::TOrphanLinkCommand

TOrphanLinkCommand (const TModelLinkReference &)
TOrphanLinkCommand (const TOrphanLinkCommand &)
TOrphanLinkCommand ()

Interface Category:

API.

Purpose:

Creates a command to orphan a specific link.
Copy constructor
Default constructor.

Calling Context:

Call this function directly.
Called to copy command.
Called by the stream-in operators and derived classes

Parameters:

const TModelLinkReference & -A reference to link to be orphaned.
const TOrphanLinkCommand & -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: TOrphanLinkCommand::operator=

TOrphanLinkCommand & operator =(const TOrphanLinkCommand &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual ~ TOrphanLinkCommand ()

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: TOrphanLinkCommand::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: TOrphanLinkCommand::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: TOrphanLinkCommand::HandleDoBegin

virtual void HandleDoBegin (TModelSelection &)

Interface Category:

API.

Purpose:

Does the command. Orphans an existing link from a model.

Calling Context:

Called only by TCommand.

Parameters:

TModelSelection & -The selection on model to orphan the link from.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TOrphanLinkCommand::HandleUndo

virtual void HandleUndo (TModelSelection &)

Interface Category:

API.

Purpose:

Undoes the command. Adopts the orphaned link back into the model.

Calling Context:

Called only by TCommandOn.

Parameters:

TModelSelection & -The selection on model to adopt the link into.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TOrphanLinkCommand::HandleRedo

virtual void HandleRedo (TModelSelection &)

Interface Category:

API.

Purpose:

Redoes the command. Same as HandleDoBegin.

Calling Context:

Called only by TCommandOn.

Parameters:

TModelSelection & -The selection on the model to orphan the link from.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

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