ecflow.Repeat

class ecflow.Repeat

Bases: pybind11_object

Represents one of RepeatString, RepeatEnumerated, RepeatInteger, RepeatDate, RepeatDateTime, RepeatDateList, RepeatDateTimeList, or RepeatDay.

Accessor methods:

current_value() -> None # if empty
current_value() -> int  # if holding RepeatDate/DateList/Integer/Day
current_value() -> str  # if holdind RepeatDateTime/DateTimeList/Enumerated/RepeatString

Repeat.current_index(self: ecflow.Repeat) → int

The current index of the repeat (as an integer)

Repeat.current_value(self: ecflow.Repeat) → object

The current value of the repeat (as a string for RepeatDateTime, RepeatDateTimeList, RepeatEnumerated, RepeatString; as an integer for RepeatDate, RepeatDateList, RepeatInteger and RepeatDay)

Repeat.empty(self: ecflow.Repeat) → bool

Return true if the repeat is empty.

Repeat.end(self: ecflow.Repeat) → int

The last value of the repeat, as an integer

Repeat.increment(self: ecflow.Repeat) → None

Increment the repeat to the next value

n.b. this modifies the in-memory local object only –it does not update the ecFlow server.

Repeat.name(self: ecflow.Repeat) → str

The repeat name, can be referenced in trigger expressions

Repeat.start(self: ecflow.Repeat) → int

The start value of the repeat, as an integer

Repeat.step(self: ecflow.Repeat) → int

The increment for the repeat, as an integer

Repeat.value(self: ecflow.Repeat) → int

The current value of the repeat as an integer