File: CosTime_TimeService.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 (86 lines) | stat: -rw-r--r-- 1,814 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
.TH CosTime_TimeService 3 "cosTime  1.1.3" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
CosTime_TimeService \- This module implements the OMG CosTime::TimeService 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
universal_time(TimeService) -> Reply
.br
.RS
.TP
Types
TimeService = #objref
.br
Reply = UTO | {\&'EXCEPTION", #\&'TimerService_TimeUnavailable\&'{}}
.br
UTO = #objref
.br
.RE
.RS
.LP
This operation returns the current time and the Inaccuracy given when starting this application in a UTO\&. The time base is \fI15 october 1582 00:00\fR\&. Comparing two time objects which use different time base is, by obvious reasons, pointless\&.
.RE
.LP
.B
new_universal_time(TimeService, Time, Inaccuracy, Tdf) -> UTO
.br
.RS
.TP
Types
TimeService = UTO = #objref
.br
Time = Inaccuracy = ulonglong()
.br
Tdf = short()
.br
.RE
.RS
.LP
This operation creates a new UTO object representing the time parameters given\&. This is the only way to create a UTO with an arbitrary time from its components\&. This is useful when using the Timer Event Service\&.
.RE
.LP
.B
uto_from_utc(TimeService, Utc) -> UTO
.br
.RS
.TP
Types
TimeService = 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 is used to create a UTO given a time in the Utc form\&.
.RE
.LP
.B
new_interval(TimeService, Lower, Upper) -> TIO
.br
.RS
.TP
Types
TimeService = TIO = #objref
.br
Lower = Upper = ulonglong()
.br
.RE
.RS
.LP
This operation is used to create a new TIO object, representing the input parameters\&. If \fILower\fR is greater than Upper BAD_PARAM is raised\&.
.RE