Class: TSQLTime

Declaration: SQLClock.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTime

Inherited By:

None.

Purpose:

This concrete class is based on a reference time of midnight. Time is measured in seconds from the reference time. Instances of TSQLTime are intended for general use in alarms, or any other client context that demands a time based on the reference time.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLTime::TSQLTime

TSQLTime ()
TSQLTime (const TSQLTime & time)
TSQLTime (const TSQLDate & time)
TSQLTime (const TSQLTimestamp & time)
TSQLTime (double secs)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructs a time object from a date.
Constructs a time object from a time stamp.
Constructs a time object based on the elapsed seconds specified by the argument.

Calling Context:

Called by the stream-in operators and any other function that needs to construct an uninitialized object.
Called to copy an object.
Called to construct an initialized object.
Called to construct an initialized object.
Called to construct an initialized object.

Parameters:

Takes no parameters.
const TSQLTime & time -The time object to copy.
const TSQLDate & time -The date object to use in initializing this object.
const TSQLTimestamp & time -The time stamp object to use in initializing this object.
double secs -The elapsed time, in seconds.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTime::~TSQLTime

virtual ~ TSQLTime ()

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

TSQLTime & operator =(const TSQLTime &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLTime & -The object 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: TSQLTime::GetSeconds

virtual double GetSeconds () const

Interface Category:

API.

Purpose:

Returns the number of seconds elapsed since midnight.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The number of seconds elapsed since midnight.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTime::SetSeconds

virtual void SetSeconds (double)

Interface Category:

API.

Purpose:

Sets the number of seconds elapsed since midnight.

Calling Context:

Call this function directly.

Parameters:

double -The new elapsed time, in seconds.

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.