Class: TSyncableClockSurrogate

Declaration: LowLevelClock.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

A surrogate for a TSyncableClock object. TSyncableClockSurrogate is used only for syncing two TClocks together. It is used to identify the master clock to sync to. It can be streamed, and is necessary for syncing TSyncableClocks across different tasks or address spaces.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSyncableClockSurrogate::TSyncableClockSurrogate

TSyncableClockSurrogate ()
TSyncableClockSurrogate (const TClock & theClock)
TSyncableClockSurrogate (const TText & theClockName)
TSyncableClockSurrogate (const TSyncableClockSurrogate & theClock)

Interface Category:

API.

Purpose:

Default constructor for streaming into.
The clock to stream out for syncing.
The time source's clock to stream out for syncing.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to create a surrogate for a clock to be connected to.
Called to create a surrogate for a time source to be connected to.
Called to copy an object.

Parameters:

Takes no parameters.
const TClock & theClock -Creates a surrogate for theClock.
const TText & theTimeSource -Creates a surrogate for theTimeSource's clock. The theTimeSource should be the same name used to initialize the intended TTimeSource that this is a surrogate to.
const TSyncableClockSurrogate & theClock -The surrogate to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSyncableClockSurrogate::~TSyncableClockSurrogate

virtual ~ TSyncableClockSurrogate ()

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

bool operator ==(const TSyncableClockSurrogate & theObject) const
bool operator ==(const ClockToken clock) const

Interface Category:

API.

Purpose:

Compares surrogates.
Compares a surrogate to a ClockToken.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TSyncableClockSurrogate & theObject -The object to compare with theObject.
const ClockToken clock -The object to compare with the clock.

Return Value:

Returns true if they are equal, otherwise returns false.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSyncableClockSurrogate::operator=

TSyncableClockSurrogate & operator =(const TSyncableClockSurrogate & copyThisObject)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSyncableClockSurrogate & copyThisObject -The copyThisObject to copy.

Return Value:

A non-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: TSyncableClockSurrogate::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Provides a hash number to be used by collections.

Calling Context:

Called by collection classes.

Parameters:

Takes no parameters.

Return Value:

The hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSyncableClockSurrogate::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSyncableClockSurrogate::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

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: TSyncableClockSurrogate::GetClockToken

ClockToken GetClockToken () const

Interface Category:

API. Used mostly for internal use.

Purpose:

Gets the clock token for the TSyncableClockSurrogate.

Calling Context:

Call this function directly

Parameters:

Takes no parameters.

Return Value:

ClockToken -the clock token for the TSyncableClockSurrogate.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function is probably only needed by Taligent internal use. The ==operators, should be used for comparison of TSyncableClockSurrogates.

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