Class TimeStampStatus

Defined in File update_functions.hpp

Inheritance Relationships

Base Type

public diagnostic_updater::DiagnosticTask (Class DiagnosticTask)

Class Documentation

class TimeStampStatus : public diagnostic_updater::DiagnosticTask 

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.

Public Functions

inline TimeStampStatus(const TimeStampStatusParam &params, std::string name, const rclcpp::Clock::SharedPtr &clock = std::make_shared<rclcpp::Clock>()): Constructs the TimeStampStatus with the given parameters.

inline explicit TimeStampStatus(const TimeStampStatusParam &params, const rclcpp::Clock::SharedPtr &clock = std::make_shared<rclcpp::Clock>()): Constructs the TimeStampStatus with the given parameters. Uses a default diagnostic task name of “Timestamp Status”.

inline explicit TimeStampStatus(const rclcpp::Clock::SharedPtr &clock = std::make_shared<rclcpp::Clock>()): Constructs the TimeStampStatus with the default parameters. Uses a default diagnostic task name of “Timestamp Status”.

inline void tick(double stamp)

Signals an event. Timestamp stored as a double.

Parameters:: stamp – The timestamp of the event that will be used in computing intervals.

inline void tick(const rclcpp::Time t)

Signals an event.

Parameters:: t – The timestamp of the event that will be used in computing intervals.

inline virtual void run(diagnostic_updater::DiagnosticStatusWrapper &stat): Fills out this Task’s DiagnosticStatusWrapper.