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

Public Member Functions

def __init__ (self, name)
 
def getName (self)
 
def run (self, stat)
 

Public Attributes

 name
 

Detailed Description

DiagnosticTask is an abstract base class for collecting diagnostic data.

Subclasses are provided for generating common diagnostic information.
A DiagnosticTask has a name, and a function that is called to create a
DiagnosticStatusWrapper.

Definition at line 50 of file _diagnostic_updater.py.

Constructor & Destructor Documentation

◆ __init__()

def diagnostic_updater._diagnostic_updater.DiagnosticTask.__init__ (   self,
  name 
)
Constructs a DiagnosticTask setting its name in the process.

Reimplemented in diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.

Definition at line 58 of file _diagnostic_updater.py.

Member Function Documentation

◆ getName()

def diagnostic_updater._diagnostic_updater.DiagnosticTask.getName (   self)
Returns the name of the DiagnosticTask.

Definition at line 62 of file _diagnostic_updater.py.

◆ run()

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

Reimplemented in diagnostic_updater._update_functions.Heartbeat, diagnostic_updater._update_functions.TimeStampStatus, diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask, diagnostic_updater._update_functions.FrequencyStatus, and diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask.

Definition at line 66 of file _diagnostic_updater.py.

Member Data Documentation

◆ name

diagnostic_updater._diagnostic_updater.DiagnosticTask.name

Definition at line 60 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