Class: TTransactionEventTargetter

Declaration: Input.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TEventReceiverTargetter

Inherited By:

None.

Purpose:

Derived from TEventReceiverTargetter, this class implements an event targeter. The event targeter sends a series of events to the event receiver specified by the substrate targeter. Therefore, if there are five events, such as event-1, event-2, and so on, and they all use a TTransactionEventTargetter, then event 1 is targeted using the substrate targeter. Events 2 through 5 go to the same receiver as event 1.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

It is not intended that classes be derived from TSimpleEventTargetter. Instead, derive directly from TEventReceiverTargetter.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTransactionEventTargetter::TTransactionEventTargetter

TTransactionEventTargetter (TEventReceiverTargetter * setTargetter)
TTransactionEventTargetter (const TTransactionEventTargetter & copy)
TTransactionEventTargetter ()

Interface Category:

API.

Purpose:

Creates a new TTransactionEventTargetter and sets its substrate targeter to the one specified.
Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

TEventReceiverTargetter * setTargetter -The substrate targeter for the new object.
const TTransactionEventTargetter & copy -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransactionEventTargetter::~TTransactionEventTargetter

virtual ~ TTransactionEventTargetter ()

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: TTransactionEventTargetter::operator=

TTransactionEventTargetter & operator =(const TTransactionEventTargetter & assign)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TTransactionEventTargetter & assign -The object to be copied.

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: TTransactionEventTargetter::operator>>=

virtual TStream & operator >>=(TStream & writeTo) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & writeTo -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: TTransactionEventTargetter::operator<<=

virtual TStream & operator <<= (TStream & readFrom)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & readFrom -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: TTransactionEventTargetter::GetEventReceiverTarget

virtual bool GetEventReceiverTarget (TEventReceiverSurrogate & target)

Interface Category:

API.

Purpose:

Determines and returns the event receiver. This function delegates to the substrate's GetEventReceiverTarget function.

Calling Context:

Called by the Input system framework.

Parameters:

TEventReceiverSurrogate & target -The event receiver as returned by this function.

Return Value:

Returns true if the substrate's GetEventReceiverTarget function returned true.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransactionEventTargetter::ResetTransaction

virtual void ResetTransaction (TEventReceiverTargetter * setNewTargetter)

Interface Category:

API.

Purpose:

Establishes a new substrate targeter for this object.

Calling Context:

Called by the Input system framework.

Parameters:

TEventReceiverTargetter * setNewTargetter -The new substrate targeter for this object.

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.