#include <mavlink_simple_analyzer.h>

Collaboration diagram for SimpleAnalyzer:

Public Types
enum	Mode { AVERAGE = 0, MIN, MAX }

Public Member Functions
	SimpleAnalyzer (Mode mode, float window=60.0f)
	Constructor. More...

void	reset ()
	Reset the analyzer to the initial state. More...

void	add_value (float val, float update_rate)
	Add a new value to the analyzer and update the result according to the mode. More...

bool	valid () const
	Returns true if at least one value has been added to the analyzer. More...

float	get () const
	Get the current result of the analyzer. More...

float	get_scaled (float scalingfactor) const
	Get the scaled value of the current result of the analyzer. More...

void	get_scaled (uint8_t &ret, float scalingfactor) const
	Get the rounded scaled value casted to the input template type. More...

void	get_scaled (int8_t &ret, float scalingfactor) const

Private Member Functions
void	check_limits (float &x, float min, float max) const

void	int_round (float &x) const

Private Attributes
unsigned int	_n = 0
	The number of added samples. More...

float	_window = 60.0f
	The window size for the moving average filter [s]. More...

Mode	_mode = AVERAGE
	The mode of the simple analyzer. More...

float	_result = 0.0f
	The result of the analyzed data. More...

Detailed Description

SimpleAnalyzer.

Class used for simple analysis of data streams. The data can be analyzed in the following three modes:

AVERAGE: The average value is computed at the beginning. Based on the number of analyzed values, the update rate and the window size the switch to the moving average is determined.

MIN: The minimum value is tracked.

MAX: The maximum value is tracked.

Definition at line 61 of file mavlink_simple_analyzer.h.

Member Enumeration Documentation

◆ Mode

enum SimpleAnalyzer::Mode

Enumerator
AVERAGE
MIN
MAX

Definition at line 64 of file mavlink_simple_analyzer.h.

Constructor & Destructor Documentation

◆ SimpleAnalyzer()

SimpleAnalyzer::SimpleAnalyzer	(	Mode	mode,
		float	window = `60.0f`
	)

Constructor.

Defines the mode of the analyzer and the window size in case of the averaging mode.

Parameters

[in]	mode	The mode of the analyzer
[in]	window	The window size in seconds. Only used in the averaging mode.

Definition at line 47 of file mavlink_simple_analyzer.cpp.

References reset().

Here is the call graph for this function:

Member Function Documentation

◆ add_value()

void SimpleAnalyzer::add_value	(	float	val,
		float	update_rate
	)

Add a new value to the analyzer and update the result according to the mode.

Parameters

[in]	val	The value to process
[in]	update_rate	The update rate in [1/s] for which new value are added. Used in the averaging mode to determine when to switch from averaging to the moving average.

Definition at line 79 of file mavlink_simple_analyzer.cpp.

References _mode, _n, _result, _window, AVERAGE, MAX, MIN, and reset().

Referenced by MavlinkStreamHighLatency2::update_airspeed(), MavlinkStreamHighLatency2::update_battery_status(), MavlinkStreamHighLatency2::update_global_position(), MavlinkStreamHighLatency2::update_gps(), MavlinkStreamHighLatency2::update_tecs_status(), MavlinkStreamHighLatency2::update_vehicle_status(), and MavlinkStreamHighLatency2::update_wind_estimate().

Here is the call graph for this function:

Here is the caller graph for this function: