File: CosTime_UTO.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 (228 lines) | stat: -rw-r--r-- 5,533 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>CosTime_UTO</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_UTO</H1>
</CENTER>

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

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation returns the time displacement factor associated with 
the target object.

</DIV>

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

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>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 returns the data associated with the target object in
Utc form.

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation create a new UTO object representing the time in the target
object added to current time (UTC). 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.
Raises DATA_CONVERSION if causes an overflow. This operation is only useful
if the target object represents a relative time.

</DIV>

<P><A NAME="compare_time/3"><STRONG><CODE>compare_time(UTO, ComparisonType, OtherUTO) -&#62; Reply</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UTO = OtherUTO = #objref</CODE></STRONG><BR>
<STRONG><CODE>ComparisonType = 'IntervalC' | 'MidC'</CODE></STRONG><BR>
<STRONG><CODE>Reply = 'TCEqualTo' | 'TCLessThan' | 'TCGreaterThan' | 'TCIndeterminate'</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation compares the time associated with the target object and the
given UTO object. The different <CODE>ComparisonType</CODE> are:

<P> 
<P>
<UL>

<LI>
'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.
</LI>


<LI>
'IntervalC' - also takes the inaccuracy into consideration, i.e.,
if the two objects interval overlaps 'TCIndeterminate' is returned,
otherwise the as for 'MidC'.
</LI>


</UL>

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

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

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation creates a TIO object representing the error interval
around the time value represented by the target object, i.e., 
<CODE>TIO.upper_bound = UTO.time+UTO.inaccuracy</CODE> and 
<CODE>TIO.lower_bound = UTO.time-UTO.inaccuracy</CODE>.

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