Public Member Functions | Private Attributes
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]

List of all members.

Public Member Functions

virtual void clear_window ()
 Clears the frequency statistics.
 HeaderlessTopicDiagnostic (std::string name, diagnostic_updater::Updater &diag, const diagnostic_updater::FrequencyStatusParam &freq)
 Constructs a HeaderlessTopicDiagnostic.
virtual void tick ()
 Signals that a publication has occurred.
virtual ~HeaderlessTopicDiagnostic ()

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

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.

Definition at line 81 of file publisher.h.


Member Function Documentation

Clears the frequency statistics.

Definition at line 97 of file publisher.h.

virtual void diagnostic_updater::HeaderlessTopicDiagnostic::tick ( ) [inline, virtual]

Signals that a publication has occurred.

Reimplemented in diagnostic_updater::TopicDiagnostic.

Definition at line 88 of file publisher.h.


Member Data Documentation

Definition at line 103 of file publisher.h.


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