hlcc 2.0.0-beta2+pre1
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
telifsim_metadaqcmds.CmdTimer Class Reference

Timer to manage the total time of a task while allowing it to be broken in smaller periods. More...

Public Member Functions

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.
 

Public Attributes

 total_time_s
 
 period_time_s
 
 start_time_s
 
 timer_expired
 

Detailed Description

Timer to manage the total time of a task while allowing it to be broken in smaller periods.

Constructor & Destructor Documentation

◆ __init__()

def telifsim_metadaqcmds.CmdTimer.__init__ (   self)

Initialize all the internal variables.

Member Function Documentation

◆ expired()

def telifsim_metadaqcmds.CmdTimer.expired (   self)

Return if the timer did expired after the last reset.

◆ reset()

def telifsim_metadaqcmds.CmdTimer.reset (   self)

Reset timer.

◆ setup()

def telifsim_metadaqcmds.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 telifsim_metadaqcmds.CmdTimer.timeout_s (   self)

Perform the intermediate wait period and check if main timeout already expired.

Member Data Documentation

◆ period_time_s

telifsim_metadaqcmds.CmdTimer.period_time_s

◆ start_time_s

telifsim_metadaqcmds.CmdTimer.start_time_s

◆ timer_expired

telifsim_metadaqcmds.CmdTimer.timer_expired

◆ total_time_s

telifsim_metadaqcmds.CmdTimer.total_time_s

The documentation for this class was generated from the following file: