Public Member Functions | Public Attributes | List of all members
diagnostic_updater._update_functions.FrequencyStatus Class Reference
Inheritance diagram for diagnostic_updater._update_functions.FrequencyStatus:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, params, name="FrequencyStatus")
 
def clear (self)
 
def run (self, stat)
 
def tick (self)
 
- Public Member Functions inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
def __init__ (self, name)
 
def getName (self)
 

Public Attributes

 count
 
 hist_indx
 
 lock
 
 params
 
 seq_nums
 
 times
 
- Public Attributes inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
 name
 

Detailed Description

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.

Definition at line 70 of file _update_functions.py.

Constructor & Destructor Documentation

◆ __init__()

def diagnostic_updater._update_functions.FrequencyStatus.__init__ (   self,
  params,
  name = "FrequencyStatus" 
)
Constructs a FrequencyStatus class with the given parameters.

Definition at line 79 of file _update_functions.py.

Member Function Documentation

◆ clear()

def diagnostic_updater._update_functions.FrequencyStatus.clear (   self)
Resets the statistics.

Definition at line 86 of file _update_functions.py.

◆ run()

def diagnostic_updater._update_functions.FrequencyStatus.run (   self,
  stat 
)
Fills out this Task's DiagnosticStatusWrapper.
@param stat: the DiagnosticStatusWrapper to fill
@return the filled DiagnosticStatusWrapper

Reimplemented from diagnostic_updater._diagnostic_updater.DiagnosticTask.

Definition at line 100 of file _update_functions.py.

◆ tick()

def diagnostic_updater._update_functions.FrequencyStatus.tick (   self)
Signals that an event has occurred.

Definition at line 95 of file _update_functions.py.

Member Data Documentation

◆ count

diagnostic_updater._update_functions.FrequencyStatus.count

Definition at line 89 of file _update_functions.py.

◆ hist_indx

diagnostic_updater._update_functions.FrequencyStatus.hist_indx

Definition at line 93 of file _update_functions.py.

◆ lock

diagnostic_updater._update_functions.FrequencyStatus.lock

Definition at line 83 of file _update_functions.py.

◆ params

diagnostic_updater._update_functions.FrequencyStatus.params

Definition at line 82 of file _update_functions.py.

◆ seq_nums

diagnostic_updater._update_functions.FrequencyStatus.seq_nums

Definition at line 92 of file _update_functions.py.

◆ times

diagnostic_updater._update_functions.FrequencyStatus.times

Definition at line 91 of file _update_functions.py.


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


diagnostic_updater
Author(s): Kevin Watts, Brice Rebsamen , Jeremy Leibs, Blaise Gassend
autogenerated on Tue Nov 15 2022 03:17:19