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

Public Member Functions

def __init__ (self, name)
 
def addTask (self, t)
 
def run (self, stat)
 
- Public Member Functions inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
def getName (self)
 

Public Attributes

 tasks
 
- Public Attributes inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
 name
 

Detailed Description

Merges CompositeDiagnosticTask into a single DiagnosticTask.

The CompositeDiagnosticTask allows multiple DiagnosticTask instances to
be combined into a single task that produces a single
DiagnosticStatusWrapped. The output of the combination has the max of
the status levels, and a concatenation of the non-zero-level messages.

For instance, this could be used to combine the calibration and offset data
from an IMU driver.

Definition at line 98 of file _diagnostic_updater.py.

Constructor & Destructor Documentation

◆ __init__()

def diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.__init__ (   self,
  name 
)
Constructs a CompositeDiagnosticTask with the given name.

Reimplemented from diagnostic_updater._diagnostic_updater.DiagnosticTask.

Definition at line 110 of file _diagnostic_updater.py.

Member Function Documentation

◆ addTask()

def diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.addTask (   self,
  t 
)
Adds a child CompositeDiagnosticTask.

This CompositeDiagnosticTask will be called each time this
CompositeDiagnosticTask is run.

Definition at line 135 of file _diagnostic_updater.py.

◆ run()

def diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.run (   self,
  stat 
)
Runs each child and merges their outputs.

Reimplemented from diagnostic_updater._diagnostic_updater.DiagnosticTask.

Definition at line 115 of file _diagnostic_updater.py.

Member Data Documentation

◆ tasks

diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.tasks

Definition at line 113 of file _diagnostic_updater.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