diagnostic_updater::TimeStampStatus Class Reference

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

#include <update_functions.h>

Inheritance diagram for diagnostic_updater::TimeStampStatus:

List of all members.

Public Member Functions
virtual void	run (diagnostic_updater::DiagnosticStatusWrapper &stat)
	Fills out this Task's DiagnosticStatusWrapper.
void	tick (double stamp)
	Signals an event. Timestamp stored as a double.
void	tick (const ros::Time t)
	Signals an event.
	TimeStampStatus (const TimeStampStatusParam &params, std::string name)
	Constructs the TimeStampStatus with the given parameters.
	TimeStampStatus (const TimeStampStatusParam &params)
	Constructs the TimeStampStatus with the given parameters. Uses a default diagnostic task name of "Timestamp Status".
	TimeStampStatus ()
	Constructs the TimeStampStatus with the default parameters. Uses a default diagnostic task name of "Timestamp Status".
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 263 of file update_functions.h.

---

Constructor & Destructor Documentation

diagnostic_updater::TimeStampStatus::TimeStampStatus	(	const TimeStampStatusParam &	params,
		std::string	name
	)		[inline]

Constructs the TimeStampStatus with the given parameters.

Definition at line 282 of file update_functions.h.

diagnostic_updater::TimeStampStatus::TimeStampStatus

(

const TimeStampStatusParam &

params

)

[inline]

Constructs the TimeStampStatus with the given parameters. Uses a default diagnostic task name of "Timestamp Status".

Definition at line 294 of file update_functions.h.

diagnostic_updater::TimeStampStatus::TimeStampStatus

(

)

[inline]

Constructs the TimeStampStatus with the default parameters. Uses a default diagnostic task name of "Timestamp Status".

Definition at line 306 of file update_functions.h.

---

Member Function Documentation

void diagnostic_updater::TimeStampStatus::init

(

)

[inline, private]

Definition at line 266 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 353 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 319 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 348 of file update_functions.h.

---

Member Data Documentation

bool diagnostic_updater::TimeStampStatus::deltas_valid_ [private]

Definition at line 405 of file update_functions.h.

int diagnostic_updater::TimeStampStatus::early_count_ [private]

Definition at line 399 of file update_functions.h.

int diagnostic_updater::TimeStampStatus::late_count_ [private]

Definition at line 400 of file update_functions.h.

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

Definition at line 406 of file update_functions.h.

double diagnostic_updater::TimeStampStatus::max_delta_ [private]

Definition at line 403 of file update_functions.h.

double diagnostic_updater::TimeStampStatus::min_delta_ [private]

Definition at line 404 of file update_functions.h.

TimeStampStatusParam diagnostic_updater::TimeStampStatus::params_ [private]

Definition at line 398 of file update_functions.h.

int diagnostic_updater::TimeStampStatus::zero_count_ [private]

Definition at line 401 of file update_functions.h.

bool diagnostic_updater::TimeStampStatus::zero_seen_ [private]

Definition at line 402 of file update_functions.h.

---

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

• update_functions.h