Class TopicStatusParamWithHeader

Inheritance Relationships

Base Types

Class Documentation

class TopicStatusParamWithHeader : public cras::FrequencyStatusParam, public diagnostic_updater::TimeStampStatusParam

A combined parameter defining both rate diagnostics and delay diagnostics (for messages with a header).

Note

This is a combination of FrequencyStatusParam and TimeStampStatusParam.

Public Functions

TopicStatusParamWithHeader(double *min_freq, double *max_freq, double tolerance = 0.1, int window_size = 5, double min_acceptable = -1.0, double max_acceptable = 5.0)

Construct the param object.

Parameters:

  • min_freq – [in] Pointer to a double containing the minimum allowed frequency. Cannot be nullptr.

  • max_freq – [in] Pointer to a double containing the maximum allowed frequency. Cannot be nullptr.

  • tolerance – [in] Tolerance of the rate.

  • window_size – [in] Number of updates during which the frequency is computed.

  • min_acceptable – [in] Min acceptable delay (in s). It can be negative if timestamps in future are expected.

  • max_acceptable – [in] Max acceptable delay (in s). It can be negative if timestamps in future are expected.

TopicStatusParamWithHeader(double min_freq = 0.0, double max_freq = ::std::numeric_limits<double>::infinity(), double tolerance = 0.1, int window_size = 5, double min_acceptable = -1.0, double max_acceptable = 5.0)

Construct the param object.

Note

Internal pointers for min/max rate are used.

Parameters:

  • min_freq – [in] Minimum allowed frequency.

  • max_freq – [in] Maximum allowed frequency.

  • tolerance – [in] Tolerance of the rate.

  • window_size – [in] Number of updates during which the frequency is computed.

  • min_acceptable – [in] Min acceptable delay (in s). It can be negative if timestamps in future are expected.

  • max_acceptable – [in] Max acceptable delay (in s). It can be negative if timestamps in future are expected.

explicit TopicStatusParamWithHeader(const ::diagnostic_updater::FrequencyStatusParam &freqParam)

Construct the object from a FrequencyStatusParam using default timestamp delay values.

Parameters:

freqParam – [in] The param to initialize from.

explicit TopicStatusParamWithHeader(const ::diagnostic_updater::TimeStampStatusParam &stampParam)

Construct the object from a TimeStampStatusParam using default rate values.

Parameters:

stampParam – [in] The param to initialize from.

TopicStatusParamWithHeader(const ::diagnostic_updater::FrequencyStatusParam &freqParam, const ::diagnostic_updater::TimeStampStatusParam &stampParam)

Construct the object from a FrequencyStatusParam and TimeStampStatusParam.

Parameters:

  • freqParam – [in] The rate param to initialize from.

  • stampParam – [in] The timestamp delay param to initialize from.

TopicStatusParamWithHeader(const ::cras::SimpleTopicStatusParamWithHeader &params)

Initialize this object from SimpleTopicStatusParam. Internal pointers for min/max rate will be used, so the params object may cease to exist.

Parameters:

params – [in] The parameters to initialize with.