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

Public Member Functions

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

Public Attributes

 deltas_valid
 
 early_count
 
 late_count
 
 lock
 
 max_delta
 
 min_delta
 
 params
 
 zero_count
 
 zero_seen
 
- Public Attributes inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
 name
 

Detailed Description

Diagnostic task to monitor the interval between events.

This diagnostic task monitors the difference between consecutive events,
and creates corresponding diagnostics. An error occurs if the interval
between consecutive events is too large or too small. An error condition
will only be reported during a single diagnostic report unless it
persists. Tallies of errors are also maintained to keep track of errors
in a more persistent way.

Definition at line 147 of file _update_functions.py.

Constructor & Destructor Documentation

◆ __init__()

def diagnostic_updater._update_functions.TimeStampStatus.__init__ (   self,
  params = TimeStampStatusParam(),
  name = "Timestamp Status" 
)
Constructs the TimeStampStatus with the given parameters.

Definition at line 158 of file _update_functions.py.

Member Function Documentation

◆ run()

def diagnostic_updater._update_functions.TimeStampStatus.run (   self,
  stat 
)

Definition at line 190 of file _update_functions.py.

◆ tick()

def diagnostic_updater._update_functions.TimeStampStatus.tick (   self,
  stamp 
)
Signals an event.
@param stamp The timestamp of the event that will be used in computing
intervals. Can be either a double or a ros::Time.

Definition at line 171 of file _update_functions.py.

Member Data Documentation

◆ deltas_valid

diagnostic_updater._update_functions.TimeStampStatus.deltas_valid

Definition at line 169 of file _update_functions.py.

◆ early_count

diagnostic_updater._update_functions.TimeStampStatus.early_count

Definition at line 163 of file _update_functions.py.

◆ late_count

diagnostic_updater._update_functions.TimeStampStatus.late_count

Definition at line 164 of file _update_functions.py.

◆ lock

diagnostic_updater._update_functions.TimeStampStatus.lock

Definition at line 162 of file _update_functions.py.

◆ max_delta

diagnostic_updater._update_functions.TimeStampStatus.max_delta

Definition at line 167 of file _update_functions.py.

◆ min_delta

diagnostic_updater._update_functions.TimeStampStatus.min_delta

Definition at line 168 of file _update_functions.py.

◆ params

diagnostic_updater._update_functions.TimeStampStatus.params

Definition at line 161 of file _update_functions.py.

◆ zero_count

diagnostic_updater._update_functions.TimeStampStatus.zero_count

Definition at line 165 of file _update_functions.py.

◆ zero_seen

diagnostic_updater._update_functions.TimeStampStatus.zero_seen

Definition at line 166 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 Mon Feb 28 2022 22:18:16