niryo_libraries.diagnostic_updater._update_functions.FrequencyStatus

class documentation

class FrequencyStatus(DiagnosticTask):

Constructor: FrequencyStatus(params, name)

View In Hierarchy

A diagnostic task that monitors the frequency of an event.

This diagnostic task monitors the frequency of calls to its tick method, and creates corresponding diagnostics. It will report a warning if the frequency is outside acceptable bounds, and report an error if there have been no events in the latest window.

Method __init__ Constructs a FrequencyStatus class with the given parameters.
Method clear Resets the statistics.
Method run Fills out this Task's DiagnosticStatusWrapper. @param stat: the DiagnosticStatusWrapper to fill @return the filled DiagnosticStatusWrapper
Method tick Signals that an event has occurred.
Instance Variable count Undocumented
Instance Variable hist_indx Undocumented
Instance Variable lock Undocumented
Instance Variable params Undocumented
Instance Variable seq_nums Undocumented
Instance Variable times Undocumented

Inherited from DiagnosticTask:

Method getName Returns the name of the DiagnosticTask.
Instance Variable name Undocumented
def __init__(self, params, name='FrequencyStatus'):
overrides niryo_libraries.diagnostic_updater._diagnostic_updater.DiagnosticTask.__init__

Constructs a FrequencyStatus class with the given parameters.

def clear(self):

Resets the statistics.

def run(self, stat):
overrides niryo_libraries.diagnostic_updater._diagnostic_updater.DiagnosticTask.run

Fills out this Task's DiagnosticStatusWrapper. @param stat: the DiagnosticStatusWrapper to fill @return the filled DiagnosticStatusWrapper

def tick(self):

Signals that an event has occurred.

count: int =

Undocumented

hist_indx =

Undocumented

lock =

Undocumented

params =

Undocumented

seq_nums =

Undocumented

times =

Undocumented