niryo_libraries.diagnostic_updater._diagnostic_updater.DiagnosticTaskVector

class documentation

class DiagnosticTaskVector:

Known subclasses: niryo_libraries.diagnostic_updater._diagnostic_updater.Updater

View In Hierarchy

Internal use only.

Base class for diagnostic_updater::Updater and self_test::Dispatcher. The class manages a collection of diagnostic updaters. It contains the common functionality used for producing diagnostic updates and for self-tests.

Class DiagnosticTaskInternal Class used to represent a diagnostic task internally in DiagnosticTaskVector.
Method __init__ Undocumented
Method add Add a task to the DiagnosticTaskVector.
Method addedTaskCallback Allows an action to be taken when a task is added. The Updater class uses this to immediately publish a diagnostic that says that the node is loading.
Method removeByName Removes a task based on its name.
Instance Variable lock Undocumented
Instance Variable tasks Undocumented
def __init__(self):
overridden in niryo_libraries.diagnostic_updater._diagnostic_updater.Updater

Undocumented

def add(self, *args):

Add a task to the DiagnosticTaskVector.

Usage: add(task): where task is a DiagnosticTask add(name, fn): add a DiagnosticTask embodied by a name and function

def addedTaskCallback(self, task):
overridden in niryo_libraries.diagnostic_updater._diagnostic_updater.Updater

Allows an action to be taken when a task is added. The Updater class uses this to immediately publish a diagnostic that says that the node is loading.

def removeByName(self, name):

Removes a task based on its name.

Removes the first task that matches the specified name. (New in version 1.1.2)

@param name Name of the task to remove. @return Returns true if a task matched and was removed.

lock =

Undocumented

tasks: list =

Undocumented