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

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

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

Constructs a HeaderlessTopicDiagnostic.

name The name of the topic that is being diagnosed.
diag The diagnostic_updater that the CompositeDiagnosticTask should add itself to.
freq The parameters for the FrequencyStatus class that will be computing statistics.

Definition at line 70 of file publisher.h.

virtual diagnostic_updater::HeaderlessTopicDiagnostic::~HeaderlessTopicDiagnostic (  )  [inline, virtual]

Definition at line 81 of file publisher.h.

Member Function Documentation

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

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends

Author(s): Jeremy Leibs, Blaise Gassend
autogenerated on Wed Jan 30 11:30:36 2013