diagnostic_updater::TopicDiagnostic Class Reference

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

#include <publisher.h>

Inheritance diagram for diagnostic_updater::TopicDiagnostic:
Inheritance graph

List of all members.

Public Member Functions

virtual void tick (const ros::Time &stamp)
 Collects statistics and publishes the message.
virtual void tick ()
 TopicDiagnostic (std::string name, diagnostic_updater::Updater &diag, const diagnostic_updater::FrequencyStatusParam &freq, const diagnostic_updater::TimeStampStatusParam &stamp)
 Constructs a TopicDiagnostic.
virtual ~TopicDiagnostic ()

Private Attributes

TimeStampStatus stamp_

Detailed Description

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

Definition at line 111 of file publisher.h.

Constructor & Destructor Documentation

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

Constructs a TopicDiagnostic.

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.
stamp The parameters for the TimeStampStatus class that will be computing statistics.

Definition at line 129 of file publisher.h.

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

Definition at line 140 of file publisher.h.

Member Function Documentation

virtual void diagnostic_updater::TopicDiagnostic::tick ( const ros::Time stamp  )  [inline, virtual]

Collects statistics and publishes the message.

stamp Timestamp to use for interval computation by the TimeStampStatus class.

Definition at line 156 of file publisher.h.

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

This method should never be called on a TopicDiagnostic as a timestamp is needed to collect the timestamp diagnostics. It is defined here to prevent the inherited tick method from being used accidentally.

Reimplemented from diagnostic_updater::HeaderlessTopicDiagnostic.

Definition at line 148 of file publisher.h.

Member Data Documentation

Definition at line 163 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