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. | |

## Public Attributes | |

double * | max_freq_ |

Maximum acceptable frequency. | |

double * | min_freq_ |

Minimum acceptable frequency. | |

double | tolerance_ |

Tolerance with which bounds must be satisfied. | |

int | window_size_ |

Number of events to consider in the statistics. |

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

Definition at line 50 of file update_functions.h.

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.

Maximum acceptable frequency.

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

Definition at line 74 of file update_functions.h.

Minimum acceptable frequency.

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

Definition at line 66 of file update_functions.h.

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.

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 Sun Oct 5 2014 23:27:19

Author(s): Kevin Watts, Brice Rebsamen

autogenerated on Sun Oct 5 2014 23:27:19