diagnostic_updater._diagnostic_updater.DiagnosticTask Class Reference

Inheritance diagram for diagnostic_updater._diagnostic_updater.DiagnosticTask:

Public Member Functions
def	__init__ (self, name)
def	getName (self)
def	run (self, stat)

Public Attributes
	name

Detailed Description

DiagnosticTask is an abstract base class for collecting diagnostic data.

Subclasses are provided for generating common diagnostic information.
A :class:`DiagnosticTask` has a name, and a function that is called to create a
:class:`DiagnosticStatusWrapper`.

Definition at line 50 of file _diagnostic_updater.py.

Constructor & Destructor Documentation

__init__()

def diagnostic_updater._diagnostic_updater.DiagnosticTask.__init__	(		self,
			name
	)

Constructs a :class:`DiagnosticTask` setting its name in the process.

:param str name: The name of the diagnostic task.

Reimplemented in diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask.

Definition at line 58 of file _diagnostic_updater.py.

Member Function Documentation

getName()

def diagnostic_updater._diagnostic_updater.DiagnosticTask.getName

(

self

)

Returns the name of the :class:`DiagnosticTask`.

:rtype: str

Definition at line 65 of file _diagnostic_updater.py.

run()

def diagnostic_updater._diagnostic_updater.DiagnosticTask.run	(		self,
			stat
	)

Fills out this Task's :class:`DiagnosticStatusWrapper`.

:param DiagnosticStatusWrapper stat: the :class:`DiagnosticStatusWrapper` to fill
:return: the filled :class:`DiagnosticStatusWrapper`
:rtype: DiagnosticStatusWrapper

Reimplemented in diagnostic_updater._update_functions.Heartbeat, diagnostic_updater._update_functions.TimeStampStatus, diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask, diagnostic_updater._update_functions.FrequencyStatus, and diagnostic_updater._diagnostic_updater.FunctionDiagnosticTask.

Definition at line 72 of file _diagnostic_updater.py.

Member Data Documentation

name

diagnostic_updater._diagnostic_updater.DiagnosticTask.name

Definition at line 63 of file _diagnostic_updater.py.

---

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

• _diagnostic_updater.py