sailfish.event.Recurrence

class sailfish.event.Recurrence(kind: Optional[int] = None, interval: Optional[float] = None)[source]

Bases: NamedTuple

Rule for how an event can recur throughout a simulation.

The available rules are:

  • linear: at evenly spaced time intervals

  • log: at multiplicative time intervals; next = time * (1 + delta)

__init__()

Methods

__init__()

count(value, /)

Return number of occurrences of value.

from_str([string])

index(value[, start, stop])

Return first index of value.

Attributes

interval

Alias for field number 1

kind

Alias for field number 0

count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

interval: float

Alias for field number 1

kind: int

Alias for field number 0