Public Member Functions | Public Attributes | List of all members
diagnostic_updater::FrequencyStatusParam Struct Reference

A structure that holds the constructor parameters for the FrequencyStatus class. More...

#include <update_functions.h>

Public Member Functions

 FrequencyStatusParam (double *min_freq, double *max_freq, double tolerance=0.1, int window_size=5)
 Creates a filled-out FrequencyStatusParam. More...
 

Public Attributes

double * max_freq_
 Maximum acceptable frequency. More...
 
double * min_freq_
 Minimum acceptable frequency. More...
 
double tolerance_
 Tolerance with which bounds must be satisfied. More...
 
int window_size_
 Number of events to consider in the statistics. More...
 

Detailed Description

A structure that holds the constructor parameters for the FrequencyStatus class.

Definition at line 50 of file update_functions.h.

Constructor & Destructor Documentation

◆ FrequencyStatusParam()

diagnostic_updater::FrequencyStatusParam::FrequencyStatusParam ( double *  min_freq,
double *  max_freq,
double  tolerance = 0.1,
int  window_size = 5 
)
inline

Creates a filled-out FrequencyStatusParam.

Definition at line 56 of file update_functions.h.

Member Data Documentation

◆ max_freq_

double* diagnostic_updater::FrequencyStatusParam::max_freq_

Maximum acceptable frequency.

A pointer is used so that the value can be updated.

Definition at line 74 of file update_functions.h.

◆ min_freq_

double* diagnostic_updater::FrequencyStatusParam::min_freq_

Minimum acceptable frequency.

A pointer is used so that the value can be updated.

Definition at line 66 of file update_functions.h.

◆ tolerance_

double diagnostic_updater::FrequencyStatusParam::tolerance_

Tolerance with which bounds must be satisfied.

Acceptable values are from *min_freq_ * (1 - torelance_) to *max_freq_ * (1 + tolerance_).

Common use cases are to set tolerance_ to zero, or to assign the same value to *max_freq_ and min_freq_.

Definition at line 86 of file update_functions.h.

◆ window_size_

int diagnostic_updater::FrequencyStatusParam::window_size_

Number of events to consider in the statistics.

Definition at line 91 of file update_functions.h.


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


diagnostic_updater
Author(s): Kevin Watts, Brice Rebsamen , Jeremy Leibs, Blaise Gassend
autogenerated on Wed Mar 27 2019 02:34:25