File: CosTime_UTO.3

package info (click to toggle)
erlang-manpages 1%3A12.b.3-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,188 kB
  • ctags: 2
  • sloc: makefile: 68; perl: 30; sh: 15
file content (146 lines) | stat: -rw-r--r-- 3,122 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
.TH CosTime_UTO 3 "cosTime  1.1.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosTime_UTO \- This module implements the OMG CosTime::UTO interface\&.
.SH DESCRIPTION
.LP
To get access to the record definitions for the structures use: 
.br
\fI-include_lib("cosTime/include/*\&.hrl")\&.\fR

.SH EXPORTS
.LP
.B
\&'_get_time\&'(UTO) -> ulonglong()
.br
.RS
.TP
Types
UTO = #objref
.br
.RE
.RS
.LP
This operation returns the time associated with the target object\&.
.RE
.LP
.B
\&'_get_inaccuracy\&'(UTO) -> ulonglong()
.br
.RS
.TP
Types
UTO = #objref
.br
.RE
.RS
.LP
This operation returns the inaccuracy associated with the target object\&.
.RE
.LP
.B
\&'_get_tdf\&'(UTO) -> short()
.br
.RS
.TP
Types
UTO = #objref
.br
.RE
.RS
.LP
This operation returns the time displacement factor associated with the target object\&.
.RE
.LP
.B
\&'_get_utc_time\&'(UTO) -> UtcT
.br
.RS
.TP
Types
UTO = #objref
.br
Utc = #\&'TimeBase_UtcT\&'{time, inacclo, inacchi, tdf}
.br
time = ulonglong()
.br
inacclo = ulong()
.br
inacchi = ushort()
.br
tdf = short()
.br
.RE
.RS
.LP
This operation returns the data associated with the target object in Utc form\&.
.RE
.LP
.B
absolute_time(UTO) -> OtherUTO
.br
.RS
.TP
Types
UTO = OtherUTO = #objref
.br
.RE
.RS
.LP
This operation create a new UTO object representing the time in the target object added to current time (UTC)\&. The time base is \fI15 october 1582 00:00\fR\&. Comparing two time objects which use different time base is, by obvious reasons, pointless\&. Raises DATA_CONVERSION if causes an overflow\&. This operation is only useful if the target object represents a relative time\&.
.RE
.LP
.B
compare_time(UTO, ComparisonType, OtherUTO) -> Reply
.br
.RS
.TP
Types
UTO = OtherUTO = #objref
.br
ComparisonType = \&'IntervalC\&' | \&'MidC\&'
.br
Reply = \&'TCEqualTo\&' | \&'TCLessThan\&' | \&'TCGreaterThan\&' | \&'TCIndeterminate\&'
.br
.RE
.RS
.LP
This operation compares the time associated with the target object and the given UTO object\&. The different \fIComparisonType\fR are:
.LP

.RS 2
.TP 2
*
\&'MidC\&' - only compare the time represented by each object\&. Furthermore, the target object is always used as the first parameter in the comparison, i\&.e\&., if the target object\&'s time is larger \&'TCGreaterThan\&' will be returned\&.
.TP 2
*
\&'IntervalC\&' - also takes the inaccuracy into consideration, i\&.e\&., if the two objects interval overlaps \&'TCIndeterminate\&' is returned, otherwise the as for \&'MidC\&'\&.
.RE
.RE
.LP
.B
time_to_interval(UTO, OtherUTO) -> TIO
.br
.RS
.TP
Types
UTO = OtherUTO = TIO = #objref
.br
.RE
.RS
.LP
This operation returns a TIO representing the interval between the target object and the given UTO midpoint times\&. The inaccuracy in the objects are not taken into consideration\&.
.RE
.LP
.B
interval(UTO) -> TIO
.br
.RS
.TP
Types
UTO = TIO = #objref
.br
.RE
.RS
.LP
This operation creates a TIO object representing the error interval around the time value represented by the target object, i\&.e\&., \fITIO\&.upper_bound = UTO\&.time+UTO\&.inaccuracy\fR and \fITIO\&.lower_bound = UTO\&.time-UTO\&.inaccuracy\fR\&.
.RE