ecflow.Cron

class ecflow.Cron

Bases: instance

A cron defines a repeating time dependency for a node.

Constructor:

Cron()
Cron(string time_series,
     days_of_week=list of ints,   # 0-6, Sunday-Saturday
     days_of_month=list of ints,  # 1-31
     months=list of ints)         # 1-12
Cron(TimeSeries time_series,
     days_of_week=list of ints,
     days_of_month=list of ints,
     months=list of ints)

Exceptions:

• raises IndexError || RuntimeError when an invalid cron is specified

Usage (see the cron definition for more examples):

# Run every day at 2pm
cron = Cron('14:00')

# Run every 30 minutes between 0:00 and 20:00, the first 6 days of the month from January until July
cron = Cron('+00:00 20:00 00:30', days_of_month=[1,2,3,4,5,6], months=[1,2,3,4,5,6])

# Run relative to suite start time or task requeue time
cron = Cron('+01:30',days_of_week=[0,1,2,3,4,5,6])

# Run relative to suite start time or task requeue time
cron = Cron('+00:15 23:00 00:30', days_of_week=[0,1,2],days_of_month=[4,5,6], months=[1,2,3])

# Define Cron based on start/end/increment
start = TimeSlot(0 , 0)
finish = TimeSlot(23, 0)
incr = TimeSlot(0, 30)
ts = TimeSeries(start, finish, incr, True)  # True means relative to suite start
cron = Cron(ts, days_of_week=[0,1,2,3,4,5,6],days_of_month=[1,2,3,4,5,6], months=[1,2])

# Use Cron methods to set weekdays, days of month and month parameters
cron = Cron()
cron.set_week_days([0, 1, 2, 3, 4, 5, 6])
cron.set_days_of_month([1, 2, 3, 4, 5, 6 ])
cron.set_months([1, 2, 3, 4, 5, 6])
cron.set_time_series(ts)

# Use Cron methods to set time series
cron = Cron()
cron.set_time_series(1, 30, True)  # same as cron +01:30

# Use Cron methods to set time series over all days of the week
cron = Cron()
cron.set_week_days([0, 1, 2, 3, 4, 5, 6])
cron.set_time_series('00:30 01:30 00:01')

# Use Cron methods to set relative time series over all days of the week
cron = Cron()
cron.set_week_days([0, 1, 2, 3, 4, 5, 6])
cron.set_time_series('+00:30')

property Cron.days_of_month

returns a integer list of days of the month

Cron.last_day_of_the_month((Cron)arg1) → bool :

Return true if last day of month is enabled

property Cron.last_week_days_of_the_month

returns a integer list of last week days of the month

property Cron.months

returns a integer list of months of the year

Cron.set_days_of_month((Cron)arg1, (list)arg2) → None :

Specifies days of the month. Expects a list of integers with integer range 1-31

Cron.set_last_day_of_the_month((Cron)arg1) → None :

Set cron for the last day of the month

Cron.set_last_week_days_of_the_month((Cron)arg1, (list)arg2) → None :

Specifies last week days of the month. Expects a list of integers, with integer range 0==Sun to 6==Sat

Cron.set_months((Cron)arg1, (list)arg2) → None :

Specifies months. Expects a list of integers, with integer range 1-12

Cron.set_time_series((Cron)arg1, (int)hour, (int)minute[, (bool)relative=False]) → None :

time_series(hour(int),minute(int),relative to suite start(bool=false)), Add a time slot

set_time_series( (Cron)arg1, (TimeSeries)arg2) -> None :

Add a time series. This will never complete

set_time_series( (Cron)arg1, (TimeSlot)arg2, (TimeSlot)arg3, (TimeSlot)arg4) -> None :

Add a time series. This will never complete

set_time_series( (Cron)arg1, (str)arg2) -> None :

Add a time series. This will never complete

Cron.set_week_days((Cron)arg1, (list)arg2) → None :

Specifies days of week. Expects a list of integers, with integer range 0==Sun to 6==Sat

Cron.time((Cron)arg1) → TimeSeries :

return cron time as a TimeSeries

property Cron.week_days

returns a integer list of week days