Inheritance diagram for diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask:

[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 :class:`CompositeDiagnosticTask` into a single :class:`DiagnosticTask`.

The :class:`CompositeDiagnosticTask` allows multiple :class:`DiagnosticTask` instances to
be combined into a single task that produces a single
:class:`DiagnosticStatusWrapper`. 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.

:ivar tasks: List of tasks
:vartype tasks: list of :class:`DiagnosticTask`

Definition at line 107 of file _diagnostic_updater.py.

Constructor & Destructor Documentation

◆ init()

def diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.__init__	(	self,
		name
	)

Constructs a :class:`CompositeDiagnosticTask` with the given name.

:param str name: The name of the diagnostic task.

Reimplemented from diagnostic_updater._diagnostic_updater.DiagnosticTask.

Definition at line 122 of file _diagnostic_updater.py.

Member Function Documentation

◆ addTask()

def diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.addTask	(	self,
		t
	)

Adds a child :class:`CompositeDiagnosticTask`.

This :class:`CompositeDiagnosticTask` will be called each time this
:class:`CompositeDiagnosticTask` is run.

:param DiagnosticTask t: the :class:`DiagnosticTask` to add.

Definition at line 150 of file _diagnostic_updater.py.

◆ run()

def diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.run	(	self,
		stat
	)

Fills out this Task's :class:`DiagnosticStatusWrapper`.

:param DiagnosticStatusWrapper stat: the :class:`DiagnosticStatusWrapper` to fill
:return: the filled :class:`DiagnosticStatusWrapper`
:rtype: DiagnosticStatusWrapper

Reimplemented from diagnostic_updater._diagnostic_updater.DiagnosticTask.

Definition at line 131 of file _diagnostic_updater.py.

Member Data Documentation

◆ tasks

diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.tasks

Definition at line 129 of file _diagnostic_updater.py.

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

_diagnostic_updater.py

Public Member Functions

Public Attributes