File: CosTime_TIO.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 (165 lines) | stat: -rw-r--r-- 4,094 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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>CosTime_TIO</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_TIO</H1>
</CENTER>

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

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG CosTime::TIO 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="'_get_time_interval'/1"><STRONG><CODE>'_get_time_interval'(TIO) -&#62; TimeInterval</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TIO = #objref</CODE></STRONG><BR>
<STRONG><CODE>TimeInterval = #'TimeBase_IntervalT{lower_bound, upper_bound}</CODE></STRONG><BR>
<STRONG><CODE>lower_bound = upper_bound = ulonglong</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation returns the interval associated with the target object.

</DIV>

<P><A NAME="spans/2"><STRONG><CODE>spans(TIO, UTO) -&#62; Reply</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TIO = UTO = OtherTIO = #objref</CODE></STRONG><BR>
<STRONG><CODE>Reply = {OverlapType, OtherTIO}</CODE></STRONG><BR>
<STRONG><CODE>OverlapType = 'OTContainer' | 'OTContained' | 'OTOverlap' | 'OTNoOverlap'</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation returns a <STRONG>OverlapType</STRONG> depending on how the interval
in the target object and the timerange represented by the UTO object 
overlap. If the OverlapType is 'OTNoOverlap' the out parameter represents 
the gap between the two intervals. If OverlapType is one of the others, the
out parameter represents the overlap interval.
The definitions of the OverlapType's are:

<P> 
<P>
<UL>

<LI>
'OTContainer' - target objects lower and upper limits are,
respectively, less or equal to and greater or equal to given object's.
</LI>


<LI>
'OTContained' - target objects lower and upper limits are,
respectively, greater or equal to and less or equal to given object's.
</LI>


<LI>
'OTOverlap' - target objects interval overlap given object's.
</LI>


<LI>
'OTNoOverlap' - target objects interval do not overlap given object's.
</LI>


</UL>

</DIV>

<P><A NAME="overlaps/2"><STRONG><CODE>overlaps(TIO, OtherTIO) -&#62; Reply</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TIO = OtherTIO = AnotherTIO = #objref</CODE></STRONG><BR>
<STRONG><CODE>Reply = {OverlapType, AnotherTIO}</CODE></STRONG><BR>
<STRONG><CODE>OverlapType = 'OTContainer' | 'OTContained' | 'OTOverlap' | 'OTNoOverlap'</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation returns a <STRONG>OverlapType</STRONG> depending on how the interval
in the target object and the timerange represented by the TIO object 
overlap. The OverlapType's are described under spans/2.

</DIV>

<P><A NAME="time/1"><STRONG><CODE>time(TIO) -&#62; UTO</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TIO = UTO = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation returns a UTO in which the interval equals the time interval
in the target object and time value is the midpoint of the interval.

</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>