Class: TDateTimeClock

Declaration: LowLevelClock.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TClock

Inherited By:

None.

Purpose:

A clock that provides the time of day or the wall clock time. Time is counted from March 1, 2000 AD Coordinated Universal Time.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TDateTimeClock::TDateTimeClock

TDateTimeClock ()
TDateTimeClock (const TDateTimeClock & theClock)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and to create a usable DateTimeClock.
Called to copy an object.

Parameters:

Takes no parameters.
const TDateTimeClock & theClock -theClock to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDateTimeClock::~TDateTimeClock

virtual ~ TDateTimeClock ()

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

virtual void Now (TTime & theTime) const

Interface Category:

API.

Purpose:

Gets the current time.

Calling Context:

Called to get the time.

Parameters:

TTime & theTime -Filled in with the current time.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDateTimeClock::DelayUntil

virtual void DelayUntil (const TTime & pointInTime)

Interface Category:

API.

Purpose:

Delays the calling thread until the pointInTIme.

Calling Context:

Called to delay the calling thread until the pointInTime.

Parameters:

const TTime & pointInTime -The time to delay until.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDateTimeClock::GetClockSurrogate

virtual void GetClockSurrogate (TSyncableClockSurrogate & sur) const

Interface Category:

API.

Purpose:

Gets a TSyncableClockSurrogate to sync a TSyncableClock to the DateTimeTimeSource.

Calling Context:

Called to sync a TSyncableClock to the real current time of day.

Parameters:

TSyncableClockSurrogate & sur -The sur to be filled in.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDateTimeClock::operator=

TDateTimeClock & operator =(const TDateTimeClock & aClock)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDateTimeClock & aClock -The source object for the assignment.

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.

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