Erlang -- CosTime_TimeService

User's Guide
Reference Manual
Release Notes
PDF
Top

cosTime
Reference Manual
Version 1.1.10

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_TimeService

### MODULE

CosTime_TimeService

### MODULE SUMMARY

This module implements the OMG CosTime::TimeService interface.

### DESCRIPTION

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

### EXPORTS

universal_time(TimeService) -> Reply

Types:

TimeService = #objref
Reply = UTO | {'EXCEPTION", #'TimerService_TimeUnavailable'{}}
UTO = #objref

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

new_universal_time(TimeService, Time, Inaccuracy, Tdf) -> UTO

Types:

TimeService = UTO = #objref
Time = Inaccuracy = ulonglong()
Tdf = short()

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.

uto_from_utc(TimeService, Utc) -> UTO

Types:

TimeService = UTO = #objref
Utc = #'TimeBase_UtcT'{time, inacclo, inacchi, tdf}
time = ulonglong()
inacclo = ulong()
inacchi = ushort()
tdf = short()

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

new_interval(TimeService, Lower, Upper) -> TIO

Types:

TimeService = TIO = #objref
Lower = Upper = ulonglong()

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