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:

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 87 of file publisher.h.

Constructor & Destructor Documentation

HeaderlessTopicDiagnostic()

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

inline

Constructs a HeaderlessTopicDiagnostic.

Parameters

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 134 of file publisher.h.

~HeaderlessTopicDiagnostic()

virtual diagnostic_updater::HeaderlessTopicDiagnostic::~HeaderlessTopicDiagnostic ( )

inlinevirtual

Definition at line 145 of file publisher.h.

Member Function Documentation

clear_window()

virtual void diagnostic_updater::HeaderlessTopicDiagnostic::clear_window ( )

inlinevirtual

Clears the frequency statistics.

Definition at line 161 of file publisher.h.

tick()

virtual void diagnostic_updater::HeaderlessTopicDiagnostic::tick ( )

inlinevirtual

Signals that a publication has occurred.

Reimplemented in diagnostic_updater::TopicDiagnostic.

Definition at line 152 of file publisher.h.

Member Data Documentation

freq_

diagnostic_updater::FrequencyStatus diagnostic_updater::HeaderlessTopicDiagnostic::freq_

private

Definition at line 167 of file publisher.h.

---

The documentation for this class was generated from the following file:

• publisher.h