File: CosTime_TimeService.html

package info (click to toggle)
erlang-doc-html 1%3A10.b.1a-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 22,488 kB
  • ctags: 9,933
  • sloc: erlang: 505; ansic: 323; perl: 61; sh: 45; makefile: 39
file content (141 lines) | stat: -rw-r--r-- 3,724 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>CosTime_TimeService</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>CosTime_TimeService</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosTime_TimeService
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG CosTime::TimeService interface.
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P> To get access to the record definitions for the structures use:<BR>

<CODE>-include_lib(&#34;cosTime/include/*.hrl&#34;).</CODE>

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="universal_time/1"><STRONG><CODE>universal_time(TimeService) -&#62; Reply</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimeService = #objref</CODE></STRONG><BR>
<STRONG><CODE>Reply = UTO | {'EXCEPTION&#34;, #'TimerService_TimeUnavailable'{}}</CODE></STRONG><BR>
<STRONG><CODE>UTO = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation returns the current time and the Inaccuracy given
when starting this application in a UTO. The time base is 
<STRONG>15 october 1582 00:00</STRONG>. Comparing two time objects which use 
different time base is, by obvious reasons, pointless.

</DIV>

<P><A NAME="new_universal_time/4"><STRONG><CODE>new_universal_time(TimeService, Time, Inaccuracy, Tdf) -&#62; UTO</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimeService = UTO = #objref</CODE></STRONG><BR>
<STRONG><CODE>Time = Inaccuracy = ulonglong()</CODE></STRONG><BR>
<STRONG><CODE>Tdf = short()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> 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.

</DIV>

<P><A NAME="uto_from_utc/2"><STRONG><CODE>uto_from_utc(TimeService, Utc) -&#62; UTO</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimeService = UTO = #objref</CODE></STRONG><BR>
<STRONG><CODE>Utc = #'TimeBase_UtcT'{time, inacclo, inacchi, tdf}</CODE></STRONG><BR>
<STRONG><CODE>time = ulonglong()</CODE></STRONG><BR>
<STRONG><CODE>inacclo = ulong()</CODE></STRONG><BR>
<STRONG><CODE>inacchi = ushort()</CODE></STRONG><BR>
<STRONG><CODE>tdf = short()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation is used to create a UTO given a time in the Utc form.

</DIV>

<P><A NAME="new_interval/3"><STRONG><CODE>new_interval(TimeService, Lower, Upper) -&#62; TIO</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TimeService = TIO = #objref</CODE></STRONG><BR>
<STRONG><CODE>Lower = Upper = ulonglong()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation is used to create a new TIO object, representing 
the input parameters. If <STRONG>Lower</STRONG> is greater than Upper 
BAD_PARAM is raised.

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Support - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>cosTime 1.1<BR>
Copyright &copy; 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>