Module ts_duration

Functions to used to handle "duration" values in time-switch.

Introduced in: 21 Feb 2005 by Håkan Stenholm <hsten@it.su.se>

Authors: Håkan Stenholm (hsten@it.su.se).

Description

Functions to used to handle "duration" values in time-switch

Function Index

duration/1 calculate duration based on time-switch parameters, if "duration" is not supplied, "dtstend - dtstart" is used.
duration_to_seconds/1 convert duration record to time in seconds.
sec_to_duration/1 convert Sec to weeks, days, ...
sub_second/1 do Duration - 1 second Note : Duration must be >= 1 second.
valid_duration/1 determine if duration of a reoccurrence will always be short enough so that no overlap can occur between reoccurrences Note : time_switch__cond_2 (which doesn't do reoccurrences) always returns 'true' Note : valid_duration/1 checks that TimeSwitchCond will be valid from dtstart until the end of time.

Function Details

duration/1

duration(TimeSwitchCond) -> #duration{}

calculate duration based on time-switch parameters, if "duration" is not supplied, "dtstend - dtstart" is used

duration_to_seconds/1

duration_to_seconds(Duration) -> integer()

convert duration record to time in seconds

sec_to_duration/1

sec_to_duration(Sec) -> #duration{}

convert Sec to weeks, days, ... seconds - start with setting as big a time units as possible e.g. 3750 seconds -> hour = 1, minute = 2, second = 30

sub_second/1

sub_second(Duration) -> #duration{}

do Duration - 1 second Note : Duration must be >= 1 second

valid_duration/1

valid_duration(TimeSwitchCond) -> true | false

determine if duration of a reoccurrence will always be short enough so that no overlap can occur between reoccurrences Note : time_switch__cond_2 (which doesn't do reoccurrences) always returns 'true' Note : valid_duration/1 checks that TimeSwitchCond will be valid from dtstart until the end of time. This means that some duration values that may have been valid in the range [dtstart, until] are rejected as invalid.


Generated by EDoc, Oct 17 2007, 16:48:06.