Public Types | Public Attributes | List of all members
cras::SimpleTopicStatusParamNoHeader Struct Reference

Helper struct for easy brace-initialization of TopicStatusParam objects. On supported compilers, you can also use designated braced initialization, i.e. param = {.maxRate = 10}. Supported is e.g. GCC 8+ in any mode or any compiler in C++20 mode. More...

#include <topic_status_param.hpp>

Public Types

typedef ::std::remove_pointer_t< decltype(::diagnostic_updater::FrequencyStatusParam::max_freq_)> RateType
 

Public Attributes

RateType maxRate {::std::numeric_limits<RateType>::infinity()}
 Maximum allowed frequency. More...
 
RateType minRate {0}
 Minimum allowed frequency. More...
 
decltype(::diagnostic_updater::FrequencyStatusParam::tolerance_rateTolerance {0.1}
 Tolerance of the rate. More...
 
decltype(::diagnostic_updater::FrequencyStatusParam::window_size_rateWindowSize {5}
 Number of updates during which the frequency is computed. More...
 

Detailed Description

Helper struct for easy brace-initialization of TopicStatusParam objects. On supported compilers, you can also use designated braced initialization, i.e. param = {.maxRate = 10}. Supported is e.g. GCC 8+ in any mode or any compiler in C++20 mode.

Note
Version for message types without a header (cannot measure delay).

Definition at line 26 of file topic_status_param.hpp.

Member Typedef Documentation

◆ RateType

Definition at line 28 of file topic_status_param.hpp.

Member Data Documentation

◆ maxRate

RateType cras::SimpleTopicStatusParamNoHeader::maxRate {::std::numeric_limits<RateType>::infinity()}

Maximum allowed frequency.

Definition at line 34 of file topic_status_param.hpp.

◆ minRate

RateType cras::SimpleTopicStatusParamNoHeader::minRate {0}

Minimum allowed frequency.

Definition at line 31 of file topic_status_param.hpp.

◆ rateTolerance

decltype(::diagnostic_updater::FrequencyStatusParam::tolerance_) cras::SimpleTopicStatusParamNoHeader::rateTolerance {0.1}

Tolerance of the rate.

Definition at line 37 of file topic_status_param.hpp.

◆ rateWindowSize

decltype(::diagnostic_updater::FrequencyStatusParam::window_size_) cras::SimpleTopicStatusParamNoHeader::rateWindowSize {5}

Number of updates during which the frequency is computed.

Definition at line 40 of file topic_status_param.hpp.


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


cras_cpp_common
Author(s): Martin Pecka
autogenerated on Tue Nov 26 2024 03:49:04