Class: TTimeSourceSurrogate

Declaration: Clock.h

Taxonomy Categories:

Member Functions:

~TTimeSourceSurrogate
Now
TTimeSourceSurrogate
operator=
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TDrivenTimeSourceSurrogate

Purpose:

Provides a fast way for TSyncableClocks to determine what their TimeSource's time is.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derived classes must implement ::Now compatible to the time source ::Now.

Concurrency:

Multithread safe.

Resource Use:

No special requirements. The object can be deleted after it has been used to initialize the TTimeSource.

Member Function: TTimeSourceSurrogate::~TTimeSourceSurrogate

virtual ~ TTimeSourceSurrogate ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeSourceSurrogate::Now

virtual void Now (TTime & theTime) const

Interface Category:

API.

Purpose:

Gets the current time of the TimeSource.

Calling Context:

Called polymorphically by TSyncableClock clock framework.

Parameters:

TTime & theTime -Set to the time source's time.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeSourceSurrogate::TTimeSourceSurrogate

TTimeSourceSurrogate ()
TTimeSourceSurrogate (const TTimeSourceSurrogate &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TTimeSourceSurrogate & -The surrogate to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

An abstract base class.

Member Function: TTimeSourceSurrogate::operator=

TTimeSourceSurrogate & operator =(const TTimeSourceSurrogate &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTimeSourceSurrogate & -The surrogate to be assigned.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeSourceSurrogate::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:

Multithread safe.

Other Considerations:

None.

Member Function: TTimeSourceSurrogate::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:

Multithread safe.

Other Considerations:

None.

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