From 84adefa331c4159d432d22840663c38f155cd4c1 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Fri, 20 Nov 2009 14:54:40 +0000 Subject: The R13B03 release. --- lib/cosTime/doc/src/CosTime_UTO.xml | 155 ++++++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 lib/cosTime/doc/src/CosTime_UTO.xml (limited to 'lib/cosTime/doc/src/CosTime_UTO.xml') diff --git a/lib/cosTime/doc/src/CosTime_UTO.xml b/lib/cosTime/doc/src/CosTime_UTO.xml new file mode 100644 index 0000000000..73784e50f6 --- /dev/null +++ b/lib/cosTime/doc/src/CosTime_UTO.xml @@ -0,0 +1,155 @@ + + + + +
+ + 2000 + 2007 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + CosTime_UTO + Niclas Eklund + Niclas Eklund + + Niclas Eklund + + 2000-02-01 + 1.0 +
+ CosTime_UTO + This module implements the OMG CosTime::UTO interface. + +

To get access to the record definitions for the structures use:

+-include_lib("cosTime/include/*.hrl").

+ + + + '_get_time'(UTO) -> ulonglong() + Return the time associated with the target object + + UTO = #objref + + +

This operation returns the time associated with the target object.

+ + + + '_get_inaccuracy'(UTO) -> ulonglong() + Return the inaccuracy associated with the target object + + UTO = #objref + + +

This operation returns the inaccuracy associated with the target object.

+ + + + '_get_tdf'(UTO) -> short() + Return the time displacement factor associated with the target object + + UTO = #objref + + +

This operation returns the time displacement factor associated with + the target object.

+ + + + '_get_utc_time'(UTO) -> UtcT + Return the data associated with the target object in Utc form + + UTO = #objref + Utc = #'TimeBase_UtcT'{time, inacclo, inacchi, tdf} + time = ulonglong() + inacclo = ulong() + inacchi = ushort() + tdf = short() + + +

This operation returns the data associated with the target object in + Utc form.

+ + + + absolute_time(UTO) -> OtherUTO + Create a new UTO object representing the time in the target object added to current time (UTC) + + UTO = OtherUTO = #objref + + +

This operation create a new UTO object representing the time in the target + object added to current time (UTC). The time base is + 15 october 1582 00:00. 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.

+ + + + compare_time(UTO, ComparisonType, OtherUTO) -> Reply + Compare the time associated with the target object and the given UTO object + + UTO = OtherUTO = #objref + ComparisonType = 'IntervalC' | 'MidC' + Reply = 'TCEqualTo' | 'TCLessThan' | 'TCGreaterThan' | 'TCIndeterminate' + + +

This operation compares the time associated with the target object and the + given UTO object. The different ComparisonType are:

+

+ + '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. + 'IntervalC' - also takes the inaccuracy into consideration, i.e., + if the two objects interval overlaps 'TCIndeterminate' is returned, + otherwise the as for 'MidC'. + + + + + time_to_interval(UTO, OtherUTO) -> TIO + Create a TIO representing the interval between the target object and the given UTO midpoint times + + UTO = OtherUTO = TIO = #objref + + +

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.

+ + + + interval(UTO) -> TIO + Create a TIO object representing the error interval around the time value represented by the target object + + UTO = TIO = #objref + + +

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

+ + + + + + -- cgit v1.2.3