diagnostic_updater::TimeStampStatus Class Reference

Diagnostic task to monitor the interval between events. More...

#include <update_functions.h>

Inheritance diagram for diagnostic_updater::TimeStampStatus:

[legend]

List of all members.

Public Member Functions
virtual void	run (diagnostic_updater::DiagnosticStatusWrapper &stat)
	Fills out this Task's DiagnosticStatusWrapper.
void	tick (const ros::Time t)
	Signals an event.
void	tick (double stamp)
	Signals an event. Timestamp stored as a double.
	TimeStampStatus ()
	Constructs the TimeStampStatus with the default parameters.
	TimeStampStatus (const TimeStampStatusParam &params)
	Constructs the TimeStampStatus with the given parameters.
Private Member Functions
void	init ()
Private Attributes
bool	deltas_valid_
int	early_count_
int	late_count_
boost::mutex	lock_
double	max_delta_
double	min_delta_
TimeStampStatusParam	params_
int	zero_count_
bool	zero_seen_

---

Detailed Description

Diagnostic task to monitor the interval between events.

This diagnostic task monitors the difference between consecutive events, and creates corresponding diagnostics. An error occurs if the interval between consecutive events is too large or too small. An error condition will only be reported during a single diagnostic report unless it persists. Tallies of errors are also maintained to keep track of errors in a more persistent way.

Definition at line 246 of file update_functions.h.

---

Constructor & Destructor Documentation

diagnostic_updater::TimeStampStatus::TimeStampStatus

(

const TimeStampStatusParam &

params

)

[inline]

Constructs the TimeStampStatus with the given parameters.

Definition at line 265 of file update_functions.h.

diagnostic_updater::TimeStampStatus::TimeStampStatus

(

)

[inline]

Constructs the TimeStampStatus with the default parameters.

Definition at line 276 of file update_functions.h.

---

Member Function Documentation

void diagnostic_updater::TimeStampStatus::init

(

)

[inline, private]

Definition at line 249 of file update_functions.h.

virtual void diagnostic_updater::TimeStampStatus::run

(

diagnostic_updater::DiagnosticStatusWrapper &

stat

)

[inline, virtual]

Fills out this Task's DiagnosticStatusWrapper.

Implements diagnostic_updater::DiagnosticTask.

Definition at line 323 of file update_functions.h.

void diagnostic_updater::TimeStampStatus::tick

(

const ros::Time

t

)

[inline]

Signals an event.

Parameters:

t

The timestamp of the event that will be used in computing intervals.

Definition at line 318 of file update_functions.h.

void diagnostic_updater::TimeStampStatus::tick

(

double

stamp

)

[inline]

Signals an event. Timestamp stored as a double.

Parameters:

stamp

The timestamp of the event that will be used in computing intervals.

Definition at line 289 of file update_functions.h.

---

Member Data Documentation

bool diagnostic_updater::TimeStampStatus::deltas_valid_ [private]

Definition at line 375 of file update_functions.h.

int diagnostic_updater::TimeStampStatus::early_count_ [private]

Definition at line 369 of file update_functions.h.

int diagnostic_updater::TimeStampStatus::late_count_ [private]

Definition at line 370 of file update_functions.h.

boost::mutex diagnostic_updater::TimeStampStatus::lock_ [private]

Definition at line 376 of file update_functions.h.

double diagnostic_updater::TimeStampStatus::max_delta_ [private]

Definition at line 373 of file update_functions.h.

double diagnostic_updater::TimeStampStatus::min_delta_ [private]

Definition at line 374 of file update_functions.h.

TimeStampStatusParam diagnostic_updater::TimeStampStatus::params_ [private]

Definition at line 368 of file update_functions.h.

int diagnostic_updater::TimeStampStatus::zero_count_ [private]

Definition at line 371 of file update_functions.h.

bool diagnostic_updater::TimeStampStatus::zero_seen_ [private]

Definition at line 372 of file update_functions.h.

---

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

• update_functions.h