Public Member Functions | Private Attributes
diagnostic_updater::DiagnosticTask Class Reference

DiagnosticTask is an abstract base class for collecting diagnostic data. More...

#include <diagnostic_updater.h>

Inheritance diagram for diagnostic_updater::DiagnosticTask:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DiagnosticTask (const std::string name)
 Constructs a DiagnosticTask setting its name in the process.
const std::string & getName ()
 Returns the name of the DiagnosticTask.
virtual void run (diagnostic_updater::DiagnosticStatusWrapper &stat)=0
 Fills out this Task's DiagnosticStatusWrapper.
virtual ~DiagnosticTask ()

Private Attributes

const std::string name_

Detailed Description

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 cleate a DiagnosticStatusWrapper.

Definition at line 65 of file diagnostic_updater.h.


Constructor & Destructor Documentation

diagnostic_updater::DiagnosticTask::DiagnosticTask ( const std::string  name) [inline]

Constructs a DiagnosticTask setting its name in the process.

Definition at line 71 of file diagnostic_updater.h.

Virtual destructor as this is a base class.

Definition at line 90 of file diagnostic_updater.h.


Member Function Documentation

const std::string& diagnostic_updater::DiagnosticTask::getName ( ) [inline]

Returns the name of the DiagnosticTask.

Definition at line 77 of file diagnostic_updater.h.


Member Data Documentation

const std::string diagnostic_updater::DiagnosticTask::name_ [private]

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


diagnostic_updater
Author(s): Jeremy Leibs, Blaise Gassend, Brice Rebsamen
autogenerated on Fri Jan 3 2014 11:18:57