Class: TPushDataCommand

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TReplaceDataCommand

Inherited By:

None.

Purpose:

Given a link, this command copies the data selected by the Here anchor in the link and use it to replace the data selected by the There anchor. TPushDataCommand derives from TReplaceDataCommand and has the same requirement for data fixup. 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: TPushDataCommand::TPushDataCommand

TPushDataCommand (const TModelLinkReference &)
TPushDataCommand (const TPushDataCommand &)
TPushDataCommand ()

Interface Category:

API.

Purpose:

Creates a push command on a specific link.
Copy constructor.
Default constructor.

Calling Context:

Call this function directly.
Called to copy an object.
Called by the stream-in operators.

Parameters:

const TModelLinkReference & -The link to push data on.
const TPushDataCommand & -The command to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws TCompoundDocument::kTypeNegotiationFail if the two anchors cannot exchange data.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPushDataCommand::operator=

TPushDataCommand & operator =(const TPushDataCommand &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual ~ TPushDataCommand ()

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: TPushDataCommand::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: TPushDataCommand::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.

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