niryo_libraries.diagnostic_updater._diagnostic

class documentation

class DiagnosticTask:

Known subclasses: niryo_libraries.diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask, niryo_libraries.diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask, niryo_libraries.diagnostic_updater._update_functions.FrequencyStatus, niryo_libraries.diagnostic_updater._update_functions.Heartbeat, niryo_libraries.diagnostic_updater._update_functions.TimeStampStatus

Constructor: DiagnosticTask(name)

View In Hierarchy

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.

Method	`__init__`	Constructs a DiagnosticTask setting its name in the process.
Method	`getName`	Returns the name of the DiagnosticTask.
Method	`run`	Fills out this Task's DiagnosticStatusWrapper. @param stat: the DiagnosticStatusWrapper to fill @return the filled DiagnosticStatusWrapper
Instance Variable	`name`	Undocumented

def __init__(self, name): ¶

overridden in niryo_libraries.diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask, niryo_libraries.diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask, niryo_libraries.diagnostic_updater._update_functions.FrequencyStatus, niryo_libraries.diagnostic_updater._update_functions.Heartbeat, niryo_libraries.diagnostic_updater._update_functions.TimeStampStatus

Constructs a DiagnosticTask setting its name in the process.

def getName(self): ¶

Returns the name of the DiagnosticTask.

def run(self, stat): ¶

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

name = ¶

Undocumented

niryo_libraries.diagnostic_updater._diagnostic_updater.DiagnosticTask

`niryo_libraries.diagnostic_updater._diagnostic_updater.DiagnosticTask`