1CosTime_UTO(3)             Erlang Module Definition             CosTime_UTO(3)
2
3
4

NAME

6       CosTime_UTO - This module implements the OMG CosTime::UTO interface.
7

DESCRIPTION

9       To get access to the record definitions for the structures use:
10       -include_lib("cosTime/include/*.hrl").
11

EXPORTS

13       '_get_time'(UTO) -> ulonglong()
14
15              Types:
16
17                 UTO = #objref
18
19              This  operation  returns the time associated with the target ob‐
20              ject.
21
22       '_get_inaccuracy'(UTO) -> ulonglong()
23
24              Types:
25
26                 UTO = #objref
27
28              This operation returns the inaccuracy associated with the target
29              object.
30
31       '_get_tdf'(UTO) -> short()
32
33              Types:
34
35                 UTO = #objref
36
37              This  operation  returns the time displacement factor associated
38              with the target object.
39
40       '_get_utc_time'(UTO) -> UtcT
41
42              Types:
43
44                 UTO = #objref
45                 Utc = #'TimeBase_UtcT'{time, inacclo, inacchi, tdf}
46                 time = ulonglong()
47                 inacclo = ulong()
48                 inacchi = ushort()
49                 tdf = short()
50
51              This operation returns the data associated with the  target  ob‐
52              ject in Utc form.
53
54       absolute_time(UTO) -> OtherUTO
55
56              Types:
57
58                 UTO = OtherUTO = #objref
59
60              This  operation create a new UTO object representing the time in
61              the target object added to current time (UTC). The time base  is
62              15 october 1582 00:00. Comparing two time objects which use dif‐
63              ferent time base  is,  by  obvious  reasons,  pointless.  Raises
64              DATA_CONVERSION  if  causes  an overflow. This operation is only
65              useful if the target object represents a relative time.
66
67       compare_time(UTO, ComparisonType, OtherUTO) -> Reply
68
69              Types:
70
71                 UTO = OtherUTO = #objref
72                 ComparisonType = 'IntervalC' | 'MidC'
73                 Reply = 'TCEqualTo' | 'TCLessThan' | 'TCGreaterThan' | 'TCIn‐
74                 determinate'
75
76              This  operation compares the time associated with the target ob‐
77              ject and the given UTO object. The different ComparisonType are:
78
79                * 'MidC' - only compare the time represented by  each  object.
80                  Furthermore,  the  target object is always used as the first
81                  parameter in the comparison, i.e., if  the  target  object's
82                  time is larger 'TCGreaterThan' will be returned.
83
84                * 'IntervalC'  - also takes the inaccuracy into consideration,
85                  i.e., if the two objects interval overlaps 'TCIndeterminate'
86                  is returned, otherwise the as for 'MidC'.
87
88       time_to_interval(UTO, OtherUTO) -> TIO
89
90              Types:
91
92                 UTO = OtherUTO = TIO = #objref
93
94              This  operation  returns a TIO representing the interval between
95              the target object and the given UTO midpoint times. The  inaccu‐
96              racy in the objects are not taken into consideration.
97
98       interval(UTO) -> TIO
99
100              Types:
101
102                 UTO = TIO = #objref
103
104              This  operation  creates a TIO object representing the error in‐
105              terval around the time value represented by the  target  object,
106              i.e.,     TIO.upper_bound    =    UTO.time+UTO.inaccuracy    and
107              TIO.lower_bound = UTO.time-UTO.inaccuracy.
108
109
110
111Ericsson AB                      cosTime 5.0.1                  CosTime_UTO(3)
Impressum