Class DiagnosticTask

Defined in File diagnostic_updater.hpp

Inheritance Relationships

Derived Types

public diagnostic_updater::CompositeDiagnosticTask (Class CompositeDiagnosticTask)
public diagnostic_updater::FrequencyStatus (Class FrequencyStatus)
public diagnostic_updater::GenericFunctionDiagnosticTask< T > (Template Class GenericFunctionDiagnosticTask)
public diagnostic_updater::Heartbeat (Class Heartbeat)
public diagnostic_updater::TimeStampStatus (Class TimeStampStatus)

Class Documentation

class DiagnosticTask

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.

Subclassed by diagnostic_updater::CompositeDiagnosticTask, diagnostic_updater::FrequencyStatus, diagnostic_updater::GenericFunctionDiagnosticTask< T >, diagnostic_updater::Heartbeat, diagnostic_updater::TimeStampStatus

Public Functions

inline explicit DiagnosticTask(const std::string name): Constructs a DiagnosticTask setting its name in the process.

inline const std::string &getName(): Returns the name of the DiagnosticTask.

virtual void run(diagnostic_updater::DiagnosticStatusWrapper &stat) = 0: Fills out this Task’s DiagnosticStatusWrapper.

inline virtual ~DiagnosticTask(): Virtual destructor as this is a base class.