$search

diagnostic_updater::FrequencyStatus Class Reference

A diagnostic task that monitors the frequency of an event. More...

#include <update_functions.h>

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

List of all members.

Public Member Functions

void clear ()
 Resets the statistics.
 FrequencyStatus (const FrequencyStatusParam &params)
 Constructs a FrequencyStatus class with the given parameters.
virtual void run (diagnostic_updater::DiagnosticStatusWrapper &stat)
 Fills out this Task's DiagnosticStatusWrapper.
void tick ()
 Signals that an event has occurred.

Private Attributes

int count_
int hist_indx_
boost::mutex lock_
const FrequencyStatusParam params_
std::vector< int > seq_nums_
std::vector< ros::Timetimes_

Detailed Description

A diagnostic task that monitors the frequency of an event.

This diagnostic task monitors the frequency of calls to its tick method, and creates corresponding diagnostics. It will report a warning if the frequency is outside acceptable bounds, and report an error if there have been no events in the latest window.

Definition at line 103 of file update_functions.h.


Constructor & Destructor Documentation

diagnostic_updater::FrequencyStatus::FrequencyStatus ( const FrequencyStatusParam params  )  [inline]

Constructs a FrequencyStatus class with the given parameters.

Definition at line 119 of file update_functions.h.


Member Function Documentation

void diagnostic_updater::FrequencyStatus::clear (  )  [inline]

Resets the statistics.

Definition at line 130 of file update_functions.h.

virtual void diagnostic_updater::FrequencyStatus::run ( diagnostic_updater::DiagnosticStatusWrapper stat  )  [inline, virtual]

Fills out this Task's DiagnosticStatusWrapper.

Implements diagnostic_updater::DiagnosticTask.

Definition at line 155 of file update_functions.h.

void diagnostic_updater::FrequencyStatus::tick (  )  [inline]

Signals that an event has occurred.

Definition at line 148 of file update_functions.h.


Member Data Documentation

Definition at line 108 of file update_functions.h.

Definition at line 111 of file update_functions.h.

Definition at line 112 of file update_functions.h.

Definition at line 106 of file update_functions.h.

Definition at line 110 of file update_functions.h.

Definition at line 109 of file update_functions.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends


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