Public Member Functions | Private Attributes | List of all members
diagnostic_updater::DiagnosticTask Class Referenceabstract

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

#include <diagnostic_updater.h>

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

Public Member Functions

 DiagnosticTask (const std::string name)
 Constructs a DiagnosticTask setting its name in the process. More...
 
const std::string & getName ()
 Returns the name of the DiagnosticTask. More...
 
virtual void run (diagnostic_updater::DiagnosticStatusWrapper &stat)=0
 Fills out this Task's DiagnosticStatusWrapper. More...
 
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 66 of file diagnostic_updater.h.

Constructor & Destructor Documentation

◆ DiagnosticTask()

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

Constructs a DiagnosticTask setting its name in the process.

Definition at line 72 of file diagnostic_updater.h.

◆ ~DiagnosticTask()

virtual diagnostic_updater::DiagnosticTask::~DiagnosticTask ( )
inlinevirtual

Virtual destructor as this is a base class.

Definition at line 91 of file diagnostic_updater.h.

Member Function Documentation

◆ getName()

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

Returns the name of the DiagnosticTask.

Definition at line 78 of file diagnostic_updater.h.

◆ run()

virtual void diagnostic_updater::DiagnosticTask::run ( diagnostic_updater::DiagnosticStatusWrapper stat)
pure virtual

Member Data Documentation

◆ name_

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

Definition at line 95 of file diagnostic_updater.h.


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 Oct 9 2020 03:35:21