rclcpp  master
C++ ROS Client Library API
Public Member Functions | Public Attributes | List of all members
rclcpp::JumpThreshold Class Reference

A class to store a threshold for a TimeJump. More...

#include <clock.hpp>

Public Member Functions

bool is_exceeded (const TimeJump &jump)
 

Public Attributes

uint64_t min_forward_
 The minimum jump forward to be considered exceeded.. More...
 
uint64_t min_backward_
 The minimum backwards jump to be considered exceeded. More...
 
bool on_clock_change_
 Whether to trigger on any clock type change. More...
 

Detailed Description

A class to store a threshold for a TimeJump.

This class can be used to evaluate a time jump's magnitude.

Member Function Documentation

◆ is_exceeded()

bool rclcpp::JumpThreshold::is_exceeded ( const TimeJump jump)

Member Data Documentation

◆ min_forward_

uint64_t rclcpp::JumpThreshold::min_forward_

The minimum jump forward to be considered exceeded..

◆ min_backward_

uint64_t rclcpp::JumpThreshold::min_backward_

The minimum backwards jump to be considered exceeded.

◆ on_clock_change_

bool rclcpp::JumpThreshold::on_clock_change_

Whether to trigger on any clock type change.


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