Public Member Functions | Private Attributes | List of all members
diagnostic_updater::HeaderlessTopicDiagnostic Class Reference

A class to facilitate making diagnostics for a topic using a FrequencyStatus. More...

#include <publisher.h>

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

Public Member Functions

virtual void clear_window ()
 Clears the frequency statistics. More...
 
 HeaderlessTopicDiagnostic (std::string name, diagnostic_updater::Updater &diag, const diagnostic_updater::FrequencyStatusParam &freq)
 Constructs a HeaderlessTopicDiagnostic. More...
 
virtual void tick ()
 Signals that a publication has occurred. More...
 
virtual ~HeaderlessTopicDiagnostic ()
 
- Public Member Functions inherited from diagnostic_updater::CompositeDiagnosticTask
void addTask (DiagnosticTask *t)
 Adds a child CompositeDiagnosticTask. More...
 
 CompositeDiagnosticTask (const std::string name)
 Constructs a CompositeDiagnosticTask with the given name. More...
 
virtual void run (DiagnosticStatusWrapper &stat)
 Runs each child and merges their outputs. More...
 
- Public Member Functions inherited from diagnostic_updater::DiagnosticTask
 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 ~DiagnosticTask ()
 

Private Attributes

diagnostic_updater::FrequencyStatus freq_
 

Detailed Description

A class to facilitate making diagnostics for a topic using a FrequencyStatus.

The word "headerless" in the class name refers to the fact that it is mainly designed for use with messages that do not have a header, and that cannot therefore be checked using a TimeStampStatus.

Definition at line 55 of file publisher.h.

Constructor & Destructor Documentation

diagnostic_updater::HeaderlessTopicDiagnostic::HeaderlessTopicDiagnostic ( std::string  name,
diagnostic_updater::Updater diag,
const diagnostic_updater::FrequencyStatusParam freq 
)
inline

Constructs a HeaderlessTopicDiagnostic.

Parameters
nameThe name of the topic that is being diagnosed.
diagThe diagnostic_updater that the CompositeDiagnosticTask should add itself to.
freqThe parameters for the FrequencyStatus class that will be computing statistics.

Definition at line 70 of file publisher.h.

virtual diagnostic_updater::HeaderlessTopicDiagnostic::~HeaderlessTopicDiagnostic ( )
inlinevirtual

Definition at line 81 of file publisher.h.

Member Function Documentation

virtual void diagnostic_updater::HeaderlessTopicDiagnostic::clear_window ( )
inlinevirtual

Clears the frequency statistics.

Definition at line 97 of file publisher.h.

virtual void diagnostic_updater::HeaderlessTopicDiagnostic::tick ( )
inlinevirtual

Signals that a publication has occurred.

Reimplemented in diagnostic_updater::TopicDiagnostic.

Definition at line 88 of file publisher.h.

Member Data Documentation

diagnostic_updater::FrequencyStatus diagnostic_updater::HeaderlessTopicDiagnostic::freq_
private

Definition at line 103 of file publisher.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 Mon Jun 10 2019 13:06:54