ecflow.RepeatInteger

class ecflow.RepeatInteger

Bases: pybind11_object

Allows a node to be repeated using a integer range.

A node can only have one repeat. The repeat can be referenced in trigger expressions.

Constructor:

RepeatInteger(variable,start,end,step)
   string variable:     The name of the repeat. The current integer value can be
                        referenced in trigger expressions using the variable name
   int start:           Start integer value
   int end:             End end integer value
   int step<optional>:  Default = 1, The step amount

Usage:

t = Task('t1',
         RepeatInteger('HOUR', 6, 24, 6 ))

Accessor methods:

current_index() -> int
   Zero-based position: (value - start) / step.
current_value() -> int
   The current integer value.

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

Return the zero-based index of the current value: (value - start) / step.

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

Return the current integer value.

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

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

Return the name of the repeat.

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

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