niryo_libraries.diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask

class documentation

class FunctionDiagnosticTask(DiagnosticTask):

Constructor: FunctionDiagnosticTask(name, fn)

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.

Method	`__init__`	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.
Method	`run`	Fills out this Task's DiagnosticStatusWrapper. @param stat: the DiagnosticStatusWrapper to fill @return the filled DiagnosticStatusWrapper
Instance Variable	`fn`	Undocumented

Inherited from DiagnosticTask:

Method	`getName`	Returns the name of the DiagnosticTask.
Instance Variable	`name`	Undocumented

def __init__(self, name, fn): ¶

overrides niryo_libraries.diagnostic_updater._diagnostic_updater.DiagnosticTask.__init__

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.

def run(self, stat): ¶

overrides niryo_libraries.diagnostic_updater._diagnostic_updater.DiagnosticTask.run

Fills out this Task's DiagnosticStatusWrapper. @param stat: the DiagnosticStatusWrapper to fill @return the filled DiagnosticStatusWrapper

fn = ¶

Undocumented