Timer to manage the total time of a task while allowing it to be broken in smaller periods.
More...
|
| def | __init__ (self) |
| | Initialize all the internal variables.
|
| |
| def | setup (self, total_time_s=0, period_time_s=0) |
| | Set the Main timeout and also the smaller periods.
|
| |
| def | reset (self) |
| | Reset timer.
|
| |
| def | timeout_s (self) |
| | Perform the intermediate wait period and check if main timeout already expired.
|
| |
| def | expired (self) |
| | Return if the timer did expired after the last reset.
|
| |
Timer to manage the total time of a task while allowing it to be broken in smaller periods.
◆ __init__()
| def hlcc_pubsub_test.CmdTimer.__init__ |
( |
|
self | ) |
|
Initialize all the internal variables.
◆ expired()
| def hlcc_pubsub_test.CmdTimer.expired |
( |
|
self | ) |
|
Return if the timer did expired after the last reset.
◆ reset()
| def hlcc_pubsub_test.CmdTimer.reset |
( |
|
self | ) |
|
◆ setup()
| def hlcc_pubsub_test.CmdTimer.setup |
( |
|
self, |
|
|
|
total_time_s = 0, |
|
|
|
period_time_s = 0 |
|
) |
| |
Set the Main timeout and also the smaller periods.
It will start the timer imediately.
◆ timeout_s()
| def hlcc_pubsub_test.CmdTimer.timeout_s |
( |
|
self | ) |
|
Perform the intermediate wait period and check if main timeout already expired.
◆ period_time_s
| hlcc_pubsub_test.CmdTimer.period_time_s |
◆ start_time_s
| hlcc_pubsub_test.CmdTimer.start_time_s |
◆ timer_expired
| hlcc_pubsub_test.CmdTimer.timer_expired |
◆ total_time_s
| hlcc_pubsub_test.CmdTimer.total_time_s |
The documentation for this class was generated from the following file:
