Public Member Functions | Private Member Functions | Private Attributes | List of all members
diagnostic_updater::TimeStampStatus Class Reference

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

#include <update_functions.h>

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

Public Member Functions

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

Constructor & Destructor Documentation

◆ TimeStampStatus() [1/3]

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

Constructs the TimeStampStatus with the given parameters.

Definition at line 285 of file update_functions.h.

◆ TimeStampStatus() [2/3]

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

◆ TimeStampStatus() [3/3]

diagnostic_updater::TimeStampStatus::TimeStampStatus ( )
inline

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

Definition at line 309 of file update_functions.h.

Member Function Documentation

◆ init()

void diagnostic_updater::TimeStampStatus::init ( )
inlineprivate

Definition at line 269 of file update_functions.h.

◆ run()

void TimeStampStatus::run ( diagnostic_updater::DiagnosticStatusWrapper stat)
virtual

Fills out this Task's DiagnosticStatusWrapper.

Implements diagnostic_updater::DiagnosticTask.

Definition at line 5 of file timestamp_status.cpp.

◆ tick() [1/2]

void diagnostic_updater::TimeStampStatus::tick ( double  stamp)
inline

Signals an event. Timestamp stored as a double.

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

Definition at line 322 of file update_functions.h.

◆ tick() [2/2]

void diagnostic_updater::TimeStampStatus::tick ( const ros::Time  t)
inline

Signals an event.

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

Definition at line 351 of file update_functions.h.

Member Data Documentation

◆ deltas_valid_

bool diagnostic_updater::TimeStampStatus::deltas_valid_
private

Definition at line 366 of file update_functions.h.

◆ early_count_

int diagnostic_updater::TimeStampStatus::early_count_
private

Definition at line 360 of file update_functions.h.

◆ late_count_

int diagnostic_updater::TimeStampStatus::late_count_
private

Definition at line 361 of file update_functions.h.

◆ lock_

boost::mutex diagnostic_updater::TimeStampStatus::lock_
private

Definition at line 367 of file update_functions.h.

◆ max_delta_

double diagnostic_updater::TimeStampStatus::max_delta_
private

Definition at line 364 of file update_functions.h.

◆ min_delta_

double diagnostic_updater::TimeStampStatus::min_delta_
private

Definition at line 365 of file update_functions.h.

◆ params_

TimeStampStatusParam diagnostic_updater::TimeStampStatus::params_
private

Definition at line 359 of file update_functions.h.

◆ zero_count_

int diagnostic_updater::TimeStampStatus::zero_count_
private

Definition at line 362 of file update_functions.h.

◆ zero_seen_

bool diagnostic_updater::TimeStampStatus::zero_seen_
private

Definition at line 363 of file update_functions.h.


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


diagnostic_updater
Author(s): Kevin Watts, Brice Rebsamen , Jeremy Leibs, Blaise Gassend
autogenerated on Sun Sep 27 2020 03:36:59