Class: TCreateLinkAtSourceCommand

Declaration: LinkingCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

TCreateLinkAtSourceCommand derived from TCommandOn<MDataExchanger> and implements a command that creates a link at this command's source. Here source is another document.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None provided.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCreateLinkAtSourceCommand::TCreateLinkAtSourceCommand

TCreateLinkAtSourceCommand (TModelAnchorReference, TModelAnchorReference, bool isRefLink =false)
TCreateLinkAtSourceCommand (const TCreateLinkAtSourceCommand &)
TCreateLinkAtSourceCommand (bool isRefLink =false)

Interface Category:

API.

Purpose:

Creates a new command with the specified source and destination.
Copy constructor.
Creates a new command.

Calling Context:

Called by any client object.
Called to copy an object.
Called by any client object.

Parameters:

TModelAnchorReference -The source.
TModelAnchorReference -The destination.
bool isRefLink =false -Indicates whether or not the new command is a reference link.
const TCreateLinkAtSourceCommand & -The object to copy.
bool isRefLink =false -Indicates whether or not the new command is a reference link.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCreateLinkAtSourceCommand::~TCreateLinkAtSourceCommand

virtual ~ TCreateLinkAtSourceCommand ()

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: TCreateLinkAtSourceCommand::HandleCanDo

virtual bool HandleCanDo (const MDataExchanger &) const

Interface Category:

API.

Purpose:

Computes and returns whether or not this command can be done on the specified data exchanger.

Calling Context:

Called by TCommandOn.

Parameters:

const MDataExchanger & -The data exchanger on which to determine if this command can be done.

Return Value:

Always returns true.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

virtual void HandleDoBegin (MDataExchanger &)

Interface Category:

API.

Purpose:

Does the command on the specified data exchanger.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The data exchanger on which to do the command.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCreateLinkAtSourceCommand::HandleUndo

virtual void HandleUndo (MDataExchanger &)

Interface Category:

API.

Purpose:

Undoes the command on the specified data exchanger.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The data exchanger for which to undo the command.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCreateLinkAtSourceCommand::HandleRedo

virtual void HandleRedo (MDataExchanger &)

Interface Category:

API.

Purpose:

Redoes the command for the specified data exchanger.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The data exchanger for which to redo the command.

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.