Class: TDrivenTimeSource

Declaration: Clock.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTimeSource

Inherited By:

None.

Purpose:

Provides a time source that is continually updated with the current time. SetTime sets now time and calls TickleWakeUps. Provides its own TimeSourceSurrogate.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TDrivenTimeSource::~TDrivenTimeSource

virtual ~ TDrivenTimeSource ()

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: TDrivenTimeSource::Now

virtual void Now (TTime & theTime) const

Interface Category:

API.

Purpose:

Gets the current time.

Calling Context:

Call this function directly.

Parameters:

TTime & theTime -Set to the current time.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDrivenTimeSource::SetTime

virtual void SetTime (const TTime & newTime)

Interface Category:

API.

Purpose:

Sets the time of the time source. This is like ticking it.

Calling Context:

Called directly to update the time that the time source represents.

Parameters:

const TTime & newTime -The newTime for the time source's current time.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDrivenTimeSource::SetTimeRelative

virtual void SetTimeRelative (const TTime & deltaTime)

Interface Category:

API.

Purpose:

Sets the time of time source relatively. This is like ticking it.

Calling Context:

Called directly to update the time that the time source represents.

Parameters:

const TTime & deltaTime -The time source's current time is incremented by deltaTime.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDrivenTimeSource::GetNextTime

virtual void GetNextTime (TTime & nextTime)

Interface Category:

API.

Purpose:

Overridden to do nothing, because it is a driven time source.

Calling Context:

Called by TSyncableClock framework.

Parameters:

TTime & nextTime -Set to the next time that work needs to be done.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Overridden to do nothing, because it is a driven time source. See inherited TTimeSource::GetNextTime.

Member Function: TDrivenTimeSource::TDrivenTimeSource

TDrivenTimeSource (const TLocalObjectInstance & instance)

Interface Category:

API.

Purpose:

Creates a time source with the name theTimeSourceName.

Calling Context:

Called directly or by server startup file.

Parameters:

const TLocalObjectInstance & instance -The name of the time source.

Return Value:

None.

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.