Erlang -- CosTime_UTO

User's Guide
Reference Manual
Release Notes
PDF
Top

cosTime
Reference Manual
Version 1.2.1

Expand All
Contract All

Table of Contents

- cosTime
  - Top of manual page
  - install_time/0
  - uninstall_time/0
  - install_timerevent/0
  - uninstall_timerevent/0
  - start/0
  - stop/0
  - start_time_service/2
  - stop_time_service/1
  - start_timerevent_service/1
  - stop_timerevent_service/1
- CosTime_TIO
  - Top of manual page
  - '_get_time_interval'/1
  - spans/2
  - overlaps/2
  - time/1
- CosTime_TimeService
  - Top of manual page
  - universal_time/1
  - new_universal_time/4
  - uto_from_utc/2
  - new_interval/3
- CosTime_UTO
  - Top of manual page
  - '_get_time'/1
  - '_get_inaccuracy'/1
  - '_get_tdf'/1
  - '_get_utc_time'/1
  - absolute_time/1
  - compare_time/3
  - time_to_interval/2
  - interval/1
- CosTimerEvent_TimerEventHandler
  - Top of manual page
  - '_get_status'/1
  - time_set/1
  - set_timer/3
  - cancel_timer/1
  - set_data/2
- CosTimerEvent_TimerEventService
  - Top of manual page
  - register/3
  - unregister/2
  - event_time/2

# CosTime_UTO

### MODULE

CosTime_UTO

### MODULE SUMMARY

This module implements the OMG CosTime::UTO interface.

### DESCRIPTION

To get access to the record definitions for the structures use:
-include_lib("cosTime/include/*.hrl").

### EXPORTS

'_get_time'(UTO) -> ulonglong()

Types:

UTO = #objref

This operation returns the time associated with the target object.

'_get_inaccuracy'(UTO) -> ulonglong()

Types:

UTO = #objref

This operation returns the inaccuracy associated with the target object.

'_get_tdf'(UTO) -> short()

Types:

UTO = #objref

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

'_get_utc_time'(UTO) -> UtcT

Types:

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

Types:

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

Types:

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

Types:

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

Types:

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.