Ada Conformity Assessment Authority |
Home |
Conformity Assessment | Test Suite |
ARG | Ada Standard |

{*AI05-0299-1*}
[This subclause specifies a high-resolution, monotonic clock package.]

The following language-defined
library package exists:

{*AI12-0241-1*}
{*AI12-0302-1*}
**package** Ada.Real_Time

**with** Nonblocking, Global => **in out synchronized** **is**

Time_First :

Time_Last :

Time_Unit :

Time_Span_First :

Time_Span_Last :

Time_Span_Zero :

Time_Span_Unit :

{*AI95-00386-01*}
**function** Nanoseconds (NS : Integer) **return** Time_Span;

**function** Microseconds (US : Integer) **return** Time_Span;

**function** Milliseconds (MS : Integer) **return** Time_Span;

**function** Seconds (S : Integer) **return** Time_Span;

**function** Minutes (M : Integer) **return** Time_Span;

... --

In this Annex, *real time*
is defined to be the physical time as observed in the external environment.
The type Time is a *time type* as defined by 9.6;
[values of this type may be used in a delay_until_statement.]
Values of this type represent segments of an ideal time line. The set
of values of the type Time corresponds one-to-one with an implementation-defined
range of mathematical integers.

The Time
value I represents the half-open real time interval that starts with
E+I*Time_Unit and is limited by E+(I+1)*Time_Unit, where Time_Unit is
an implementation-defined real number and E is an unspecified origin
point, the *epoch*, that is the same for all values of the type
Time. It is not specified by the language whether the time values are
synchronized with any standard time reference. [For example, E can correspond
to the time of system initialization or it can correspond to the epoch
of some time standard.]

This half-open interval I consists of all real
numbers R such that E+I*Time_Unit <= R < E+(I+1)*Time_Unit.

Values of the type Time_Span represent length of
real time duration. The set of values of this type corresponds one-to-one
with an implementation-defined range of mathematical integers. The Time_Span
value corresponding to the integer I represents the real-time duration
I*Time_Unit.

Time_First and Time_Last are the smallest and largest
values of the Time type, respectively. Similarly, Time_Span_First and
Time_Span_Last are the smallest and largest values of the Time_Span type,
respectively.

A value of type Seconds_Count represents an elapsed
time, measured in seconds, since the epoch.

Time_Unit is the smallest amount of real time representable
by the Time type; it is expressed in seconds. Time_Span_Unit is the difference
between two successive values of the Time type. It is also the smallest
positive value of type Time_Span. Time_Unit and Time_Span_Unit represent
the same real time duration. A *clock tick*
is a real time interval during which the clock value (as observed by
calling the Clock function) remains constant. Tick is the average length
of such intervals.

{*AI95-00432-01*}
The function To_Duration converts the value TS to a value of type Duration.
Similarly, the function To_Time_Span converts the value D to a value
of type Time_Span. For To_Duration, the result is rounded to the nearest
value of type Duration (away from zero if exactly halfway between two
values). If the result is outside the range of Duration, Constraint_Error
is raised. For To_Time_Span, the value of D is first rounded to the nearest
integral multiple of Time_Unit, away from zero if exactly halfway between
two multiples. If the rounded value is outside the range of Time_Span,
Constraint_Error is raised. Otherwise, the value is converted to the
type Time_Span.

To_Duration(Time_Span_Zero) returns 0.0, and To_Time_Span(0.0)
returns Time_Span_Zero.

{*AI95-00386-01*}
{*AI95-00432-01*}
The functions Nanoseconds, Microseconds, Milliseconds, Seconds, and Minutes
convert the input parameter to a value of the type Time_Span. NS, US,
MS, S, and M are interpreted as a number of nanoseconds, microseconds,
milliseconds, seconds, and minutes respectively. The input parameter
is first converted to seconds and rounded to the nearest integral multiple
of Time_Unit, away from zero if exactly halfway between two multiples.
If the rounded value is outside the range of Time_Span, Constraint_Error
is raised. Otherwise, the rounded value is converted to the type Time_Span.

The effects of the operators on Time and Time_Span
are as for the operators defined for integer types.

The function Clock returns the amount of time since
the epoch.

The effects of the Split and Time_Of operations are
defined as follows, treating values of type Time, Time_Span, and Seconds_Count
as mathematical integers. The effect of Split(T,SC,TS) is to set SC and
TS to values such that T*Time_Unit = SC*1.0 + TS*Time_Unit, and 0.0 <=
TS*Time_Unit < 1.0. The value returned by Time_Of(SC,TS) is the value
T such that T*Time_Unit = SC*1.0 + TS*Time_Unit.

The range of Time values shall be sufficient to uniquely
represent the range of real times from program start-up to 50 years later.
Tick shall be no greater than 1 millisecond. Time_Unit shall be less
than or equal to 20 microseconds.

Time_Span_First shall be no greater than –3600
seconds, and Time_Span_Last shall be no less than 3600 seconds.

A *clock jump* is the difference
between two successive distinct values of the clock (as observed by calling
the Clock function). There shall be no backward clock jumps.

The implementation shall document the values of Time_First,
Time_Last, Time_Span_First, Time_Span_Last, Time_Span_Unit, and Tick.

The implementation shall document the properties
of the underlying time base used for the clock and for type Time, such
as the range of values supported and any relevant aspects of the underlying
hardware or operating system facilities used.

The implementation shall document whether or not
there is any synchronization with external time references, and if such
synchronization exists, the sources of synchronization information, the
frequency of synchronization, and the synchronization method applied.

{*AI05-0299-1*}
The implementation shall document any aspects of the external environment
that could interfere with the clock behavior as defined in this subclause.

{*AI05-0299-1*}
For the purpose of the metrics defined in this subclause, real time is
defined to be the International Atomic Time (TAI).

The implementation
shall document the following metrics:

An upper bound on the real-time duration of a clock
tick. This is a value D such that if t1 and t2 are any real times such
that t1 < t2 and Clock_{t1}
= Clock_{t2}
then t2 – t1 <= D.

An upper bound on the size of a clock jump.

An upper bound on the *drift
rate* of Clock with respect to real time. This is a real number D
such that

E*(1–D) <= (Clock_{t+E} – Clock_{t}) <= E*(1+D)

provided that: Clock_{t} + E*(1+D) <= Time_Last.

provided that: Clock

where Clock_{t}
is the value of Clock at time t, and E is a real time duration not less
than 24 hours. The value of E used for this metric shall be reported.

An upper bound on the execution time of a call
to the Clock function, in processor clock cycles.

Upper bounds on the execution times of the operators
of the types Time and Time_Span, in processor clock cycles.

Implementations targeted to machines with word size
smaller than 32 bits need not support the full range and granularity
of the Time and Time_Span types.

Since the range and granularity are implementation
defined, the supported values need to be documented.

When appropriate, implementations should provide
configuration mechanisms to change the value of Tick.

It is recommended that Calendar.Clock and Real_Time.Clock
be implemented as transformations of the same time base.

It is recommended that the “best” time
base which exists in the underlying system be available to the application
through Clock. “Best” may mean highest accuracy or largest
range.

NOTES

35 {*AI05-0299-1*}
The rules in this subclause do not imply that the implementation can
protect the user from operator or installation errors which could result
in the clock being set incorrectly.

36 Time_Unit is the granularity of the
Time type. In contrast, Tick represents the granularity of Real_Time.Clock.
There is no requirement that these be the same.

{*AI95-00386-01*}
{*AI05-0005-1*}
Functions Seconds and Minutes are added to Real_Time.
If Real_Time is referenced in a use_clause,
and an entity *E* with a defining_identifier
of Seconds or Minutes is defined in a package that is also referenced
in a use_clause,
the entity *E* may no longer be use-visible, resulting in errors.
This should be rare and is easily fixed if it does occur.

{*AI95-00432-01*}
Added wording explaining how and when many of these functions can raise
Constraint_Error. While there always was an intent to raise Constraint_Error
if the values did not fit, there never was any wording to that effect,
and since Time_Span was a private type, the normal numeric type rules
do not apply to it.

Ada 2005 and 2012 Editions sponsored in part by **Ada-Europe**