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
decltype(::diagnostic_updater::TimeStampStatusParam::max_acceptable_)	maxDelay {5.0}
	Max acceptable delay (in s). It can be negative if timestamps in future are expected. More...

RateType	maxRate {::std::numeric_limits<RateType>::infinity()}
	Maximum allowed frequency. More...

decltype(::diagnostic_updater::TimeStampStatusParam::min_acceptable_)	minDelay {-1.0}
	Min acceptable delay (in s). It can be negative if timestamps in future are expected. 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 with a header (can measure delay).

Definition at line 49 of file topic_status_param.hpp.

Member Typedef Documentation

◆ RateType

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

Definition at line 51 of file topic_status_param.hpp.

Member Data Documentation

◆ maxDelay

decltype(::diagnostic_updater::TimeStampStatusParam::max_acceptable_) cras::SimpleTopicStatusParamWithHeader::maxDelay {5.0}

Max acceptable delay (in s). It can be negative if timestamps in future are expected.

Definition at line 69 of file topic_status_param.hpp.

◆ maxRate

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

Maximum allowed frequency.

Definition at line 57 of file topic_status_param.hpp.

◆ minDelay

decltype(::diagnostic_updater::TimeStampStatusParam::min_acceptable_) cras::SimpleTopicStatusParamWithHeader::minDelay {-1.0}

Min acceptable delay (in s). It can be negative if timestamps in future are expected.

Definition at line 66 of file topic_status_param.hpp.

◆ minRate

RateType cras::SimpleTopicStatusParamWithHeader::minRate {0}

Minimum allowed frequency.

Definition at line 54 of file topic_status_param.hpp.

◆ rateTolerance

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

Tolerance of the rate.

Definition at line 60 of file topic_status_param.hpp.

◆ rateWindowSize

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

Number of updates during which the frequency is computed.

Definition at line 63 of file topic_status_param.hpp.

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

topic_status_param.hpp

Public Types

Public Attributes