openpectus.lang.exec.timer

Attributes

TickConsumer

Tick function. It is called by the timer on each tick with arguments:

Classes

`EngineTimer`
`NullTimer`
`OneThreadTimer`	Single threaded (1 extra thread) timer.

Module Contents

openpectus.lang.exec.timer.TickConsumer

Tick function. It is called by the timer on each tick with arguments: - tick_time: float Time of the tick in seconds - increment_time: float Time since last tick_time

Will be called on all ticks, even tick 0 where increment_time is zero.

On pause/resume, will also be called on the first tick after resume where increment_time is also zero.

class openpectus.lang.exec.timer.EngineTimer

__str__()

Return type:: str

set_tick_fn(tick_fn)

Parameters:: tick_fn (TickConsumer)

start()

stop()

class openpectus.lang.exec.timer.NullTimer: Bases: EngineTimer

class openpectus.lang.exec.timer.OneThreadTimer(interval, tick=None)

Bases: EngineTimer

Single threaded (1 extra thread) timer.

This allows controlled multithreading.

Parameters:

interval (float)
tick (TickConsumer | None)

interval

tick = None

running = False

__str__()

Return type:: str

set_tick_fn(tick_fn)

Parameters:: tick_fn (TickConsumer)

start(): Start timer

ticker()

stop()