Class: TSQLTimestamp

Declaration: SQLClock.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSQLDate

Inherited By:

None.

Purpose:

TSQLTimestamp is a concrete class that extends TSQLDate class by adding picosecond accuracy to it. It is intended for super-accurate time measurements.

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: TSQLTimestamp::TSQLTimestamp

TSQLTimestamp ()
TSQLTimestamp (const TSQLTimestamp & time)
TSQLTimestamp (const TSQLDate & time)
TSQLTimestamp (double secs, double picoOffset =0)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructs a time stamp based on a date.
Constructs a time stamp and initializes it with specified arguments.

Calling Context:

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

Parameters:

Takes no parameters.
const TSQLTimestamp & time -The object to copy.
const TSQLDate & time -The date object to copy.
double secs -The seconds component of the time stamp.
double picoOffset =0 -The picoseconds component of the time stamp.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTimestamp::~TSQLTimestamp

virtual ~ TSQLTimestamp ()

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

TSQLTimestamp & operator =(const TSQLTimestamp &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLTimestamp & -The time stamp to be copied.

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: TSQLTimestamp::GetIntegralSeconds

virtual TDoubleLong GetIntegralSeconds () const

Interface Category:

API.

Purpose:

Returns the integral seconds portion of the total time elapsed since the reference date.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The integral seconds portion of the elapsed time since the reference date.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTimestamp::GetFractionalSeconds

virtual double GetFractionalSeconds () const

Interface Category:

API.

Purpose:

Returns the fractional seconds portion of the total time elapsed since the reference date.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The fractional seconds portion of the elapsed time since the reference date.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTimestamp::GetTotalTime

virtual TSeconds GetTotalTime () const

Interface Category:

API.

Purpose:

Returns the total number of seconds elapsed since the reference date. Negative values indicate dates preceding the reference date. The time returned includes the offset, with corresponding loss of precision resulting from adding geologic time (TSeconds) to atomic time (TPicoseconds).

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The total number of seconds elapsed since the reference date.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTimestamp::GetOffsetTime

virtual const TPicoseconds & GetOffsetTime () const

Interface Category:

API.

Purpose:

Returns the time offset relative to GetSeconds.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The time offset relative to GetSeconds.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTimestamp::IsGreaterThan

virtual bool IsGreaterThan (const MOrderableCollectible *) const

Interface Category:

API.

Purpose:

Determines if this object is greater than the one pointed to by its argument, that is, it has a greater elapsed time than its argument.

Calling Context:

Call this function directly.

Parameters:

const MOrderableCollectible * -Points to the object to compare this object to.

Return Value:

Returns true if this object is greater than the one pointed to by its argument.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTimestamp::IsLessThan

virtual bool IsLessThan (const MOrderableCollectible *) const

Interface Category:

API.

Purpose:

Determines if this object is less than the one pointed to by its argument, that is, it has a smaller elapsed time than its argument.

Calling Context:

Call this function directly.

Parameters:

const MOrderableCollectible * -Points to the object to compare this object to.

Return Value:

Returns true if this object is smaller than the one pointed to by its argument.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTimestamp::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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: TSQLTimestamp::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. Call this function directly.

Parameters:

TStream & -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.

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