Classes | Public Member Functions | Public Attributes
diagnostic_updater._diagnostic_updater.DiagnosticTaskVector Class Reference
Inheritance diagram for diagnostic_updater._diagnostic_updater.DiagnosticTaskVector:
Inheritance graph
[legend]

List of all members.

Classes

class  DiagnosticTaskInternal

Public Member Functions

def __init__
def add
def addedTaskCallback
def removeByName

Public Attributes

 lock
 tasks

Detailed Description

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.

Definition at line 142 of file _diagnostic_updater.py.


Constructor & Destructor Documentation

Reimplemented in diagnostic_updater._diagnostic_updater.Updater.

Definition at line 165 of file _diagnostic_updater.py.


Member Function Documentation

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

Definition at line 176 of file _diagnostic_updater.py.

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.

Reimplemented in diagnostic_updater._diagnostic_updater.Updater.

Definition at line 169 of file _diagnostic_updater.py.

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.

Definition at line 192 of file _diagnostic_updater.py.


Member Data Documentation

Definition at line 165 of file _diagnostic_updater.py.

Definition at line 165 of file _diagnostic_updater.py.


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


diagnostic_updater
Author(s): Kevin Watts, Brice Rebsamen , Jeremy Leibs, Blaise Gassend
autogenerated on Fri Aug 28 2015 10:29:58