User's Guide
Reference Manual
Release Notes
PDF
Top

cosTime
Reference Manual
Version 1.1.8

Expand All
Contract All

Table of Contents

# CosTime_TIO

### MODULE

CosTime_TIO

### MODULE SUMMARY

This module implements the OMG CosTime::TIO interface.

### DESCRIPTION

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

### EXPORTS

'_get_time_interval'(TIO) -> TimeInterval

Types:

TIO = #objref
TimeInterval = #'TimeBase_IntervalT{lower_bound, upper_bound}
lower_bound = upper_bound = ulonglong

This operation returns the interval associated with the target object.

spans(TIO, UTO) -> Reply

Types:

TIO = UTO = OtherTIO = #objref
Reply = {OverlapType, OtherTIO}
OverlapType = 'OTContainer' | 'OTContained' | 'OTOverlap' | 'OTNoOverlap'

This operation returns a OverlapType 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:

- 'OTContainer' - target objects lower and upper limits are, respectively, less or equal to and greater or equal to given object's.
- 'OTContained' - target objects lower and upper limits are, respectively, greater or equal to and less or equal to given object's.
- 'OTOverlap' - target objects interval overlap given object's.
- 'OTNoOverlap' - target objects interval do not overlap given object's.

overlaps(TIO, OtherTIO) -> Reply

Types:

TIO = OtherTIO = AnotherTIO = #objref
Reply = {OverlapType, AnotherTIO}
OverlapType = 'OTContainer' | 'OTContained' | 'OTOverlap' | 'OTNoOverlap'

This operation returns a OverlapType 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.

time(TIO) -> UTO

Types:

TIO = UTO = #objref

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.