Class: TAdoptLinkCommand

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

Adopts a new link into an anchor in a model. The link must be a link out of an anchor on the target model. This command supports undo and redo of the operation. The GetLink member functions support access to the link to be adopted.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Invariants:

Assert (GetLink != NIL)

Member Function: TAdoptLinkCommand::TAdoptLinkCommand

TAdoptLinkCommand (TModelLink * linkToAdopt)
TAdoptLinkCommand (const TAdoptLinkCommand &)
TAdoptLinkCommand ()

Interface Category:

API.

Purpose:

Constructs a command with a link to adopt into a model anchor.
Copy constructor.
Default constructor.

Calling Context:

Called to create new command.
Called to copy command.
Called by the stream-in operators and derived classes.

Parameters:

TModelLink * anchorToAdopt -The link to be adopted into model.
const TAdoptLinkCommand & -The command to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Postconditions:

Assert (GetLink() != NIL)

Member Function: TAdoptLinkCommand::operator=

TAdoptLinkCommand

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual ~ TAdoptLinkCommand ()

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: TAdoptLinkCommand::GetLink

virtual TModelLink * GetLink ()

Interface Category:

API.

Purpose:

Provides access to the link to be adopted into the model.

Calling Context:

No special requirements.

Parameters:

Takes no parameters.

Return Value:

Returns the link to be adopted to be adopted into the model.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAdoptLinkCommand::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: TAdoptLinkCommand::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: TAdoptLinkCommand::HandleDoBegin

virtual void HandleDoBegin (TModelSelection &)

Interface Category:

API.

Purpose:

Does the command. The link is adopted into the target anchor in the target model.

Calling Context:

Called only by TCommand.

Parameters:

TModelSelection & -The selection on model into which the link will be adopted.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAdoptLinkCommand::HandleUndo

virtual void HandleUndo (TModelSelection &)

Interface Category:

API.

Purpose:

Orphans out the previously adopted link of the model.

Calling Context:

Called only by TCommandOn.

Parameters:

TModelSelection & -The selection on the model from which the link will be orphaned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAdoptLinkCommand::HandleRedo

virtual void HandleRedo (TModelSelection &)

Interface Category:

API.

Purpose:

Redoes the command: Same as HandleDo.

Calling Context:

Called only by TCommandOn.

Parameters:

TModelSelection & -The selection on the model into which the link will be adopted.

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.