Class FrequencyStatus

Defined in File update_functions.hpp

Inheritance Relationships

Base Type

public diagnostic_updater::DiagnosticTask (Class DiagnosticTask)

Class Documentation

class FrequencyStatus : public diagnostic_updater::DiagnosticTask 

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.

Public Functions

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

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

inline void clear(): Resets the statistics.

inline void tick(): Signals that an event has occurred.

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