Inheritance diagram for diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask:

Public Member Functions
def	__init__ (self, name, fn)

def	run (self, stat)

Public Member Functions inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
def	__init__ (self, name)

def	getName (self)

Public Attributes
	fn

Public Attributes inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
	name

Detailed Description

A DiagnosticTask based on a function.

The FunctionDiagnosticTask calls the function when it updates. The
function updates the DiagnosticStatusWrapper and collects data.

This is useful for gathering information about a device or driver, like temperature,
calibration, etc.

Definition at line 75 of file _diagnostic_updater.py.

Constructor & Destructor Documentation

◆ init()

def diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask.__init__	(	self,
		name,
		fn
	)

Constructs a GenericFunctionDiagnosticTask based on the given name and function.
@param name Name of the function.
@param fn Function to be called when run is called.

Definition at line 85 of file _diagnostic_updater.py.

Member Function Documentation

◆ run()

def diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask.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 93 of file _diagnostic_updater.py.

Member Data Documentation

◆ fn

diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask.fn

Definition at line 91 of file _diagnostic_updater.py.

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

_diagnostic_updater.py

Public Member Functions

Public Attributes