toTimeoutInCalendar

toTimeoutInCalendar( units, amount )

Описание

Возвращает интервал в единицах модельного времени, который равняется заданному количеству amount  указанных единиц времени от текущей модельной даты, например, функция toTimeoutInCalendar( DAY, 1 ) возвращает интервал в единицах модельного времени от даты date() до даты date() + 1 день.

Обратите внимание, что результат этого метода также зависит от текущей модельной даты (из-за високосного года, разной длины месяцев, перевода часов на летнее время), и поэтому этот метод не должен использоваться для инициализации каких-либо констант.

Примером применения этого метода является модель, в которой запланировано событие, случающееся каждый день в конкретное время, например, в 8:00 утра. В этом случае этот метод будет всегда возвращать корректный таймаут (даже при переводе часов на летнее время) в отличие от функции day(), которая всегда возвращает интервал в 24 часа и может привести к срабатыванию события в 7:00 или 9:00 часов.

Параметры

Имя

Описание

units

Задает единицы измерения времени одной из следующих констант:

MILLISECOND миллисекунды

SECOND

секунды

MINUTE минуты

HOUR

часы

DAY дни

WEEK

недели

MONTH месяцы

YEAR

годы

amount

Количество единиц времени (может быть отрицательным, результат в таком случае тоже будет отрицательным). Вещественное число типа double.

Результат

Тип

Описание

double

Интервал в единицах модельного времени, который может использоваться, например, для планирования события, которое должно сработать через указанное количество заданных единиц времени.