sailfish.event.RecurringEvent

class sailfish.event.RecurringEvent(last_time: Optional[float] = None, number: int = 0)[source]

Bases: NamedTuple

State of a recurring event that occurs during a simulation.

Events signal side effects to a loop which monitors simulation progress, include writing checkpoints, collecting time series data, and other post-processing tasks.

__init__()

Methods

`__init__`()
`count`(value, /)	Return number of occurrences of value.
`index`(value[, start, stop])	Return first index of value.
`is_due`(time, recurrence)
`next`(time, recurrence)
`next_time`(time, recurrence)

Attributes

`last_time`	Alias for field number 0
`number`	Alias for field number 1

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.

last_time: float: Alias for field number 0

number: int: Alias for field number 1