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:

Public Member Functions
void	clear ()
	Resets the statistics. More...
	FrequencyStatus (const FrequencyStatusParam &params, std::string name)
	Constructs a FrequencyStatus class with the given parameters. More...
	FrequencyStatus (const FrequencyStatusParam &params)
	Constructs a FrequencyStatus class with the given parameters. Uses a default diagnostic task name of "Frequency Status". More...
virtual void	run (diagnostic_updater::DiagnosticStatusWrapper &stat)
	Fills out this Task's DiagnosticStatusWrapper. More...
void	tick ()
	Signals that an event has occurred. 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
int	count_
int	hist_indx_
boost::mutex	lock_
const FrequencyStatusParam	params_
std::vector< int >	seq_nums_
std::vector< ros::Time >	times_

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 104 of file update_functions.h.

Constructor & Destructor Documentation

FrequencyStatus() [1/2]

diagnostic_updater::FrequencyStatus::FrequencyStatus ( const FrequencyStatusParam &  params, std::string  name  )

inline

Constructs a FrequencyStatus class with the given parameters.

Definition at line 120 of file update_functions.h.

FrequencyStatus() [2/2]

diagnostic_updater::FrequencyStatus::FrequencyStatus ( const FrequencyStatusParam &  params )

inline

Constructs a FrequencyStatus class with the given parameters. Uses a default diagnostic task name of "Frequency Status".

Definition at line 132 of file update_functions.h.

Member Function Documentation

clear()

void diagnostic_updater::FrequencyStatus::clear ( )

inline

Resets the statistics.

Definition at line 143 of file update_functions.h.

run()

virtual void diagnostic_updater::FrequencyStatus::run ( diagnostic_updater::DiagnosticStatusWrapper &  stat )

inlinevirtual

Fills out this Task's DiagnosticStatusWrapper.

Implements diagnostic_updater::DiagnosticTask.

Definition at line 168 of file update_functions.h.

tick()

void diagnostic_updater::FrequencyStatus::tick ( )

inline

Signals that an event has occurred.

Definition at line 161 of file update_functions.h.

Member Data Documentation

count_

int diagnostic_updater::FrequencyStatus::count_

private

Definition at line 109 of file update_functions.h.

hist_indx_

int diagnostic_updater::FrequencyStatus::hist_indx_

private

Definition at line 112 of file update_functions.h.

lock_

boost::mutex diagnostic_updater::FrequencyStatus::lock_

private

Definition at line 113 of file update_functions.h.

params_

const FrequencyStatusParam diagnostic_updater::FrequencyStatus::params_

private

Definition at line 107 of file update_functions.h.

seq_nums_

std::vector<int> diagnostic_updater::FrequencyStatus::seq_nums_

private

Definition at line 111 of file update_functions.h.

times_

std::vector<ros::Time> diagnostic_updater::FrequencyStatus::times_

private

Definition at line 110 of file update_functions.h.

---

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

• update_functions.h