soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF > Class Template Reference

template for an average filter for circling and straight flight More...

#include <soaring_flight_averager.h>

Public Member Functions
	soaring_flight_averager (float normalized_stop_frequency)
const value_t &	get_output (void) const
void	update (const value_t &current_value, float heading, circle_state_t new_state)
void	record_input (value_t current_value, volatile float heading)
void	reset (value_t value)
bool	circle_completed (void) const
void	relax (void)

Detailed Description

template<class value_t, bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>
class soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >

template for an average filter for circling and straight flight

Definition at line 38 of file soaring_flight_averager.h.

Constructor & Destructor Documentation

soaring_flight_averager()

template<class value_t , bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>

soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::soaring_flight_averager ( float  normalized_stop_frequency )

inline

Definition at line 41 of file soaring_flight_averager.h.

Member Function Documentation

circle_completed()

template<class value_t , bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>

bool soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::circle_completed ( void  ) const

inline

Definition at line 142 of file soaring_flight_averager.h.

Referenced by soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::update().

get_output()

template<class value_t , bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>

const value_t & soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::get_output ( void  ) const

inline

Definition at line 54 of file soaring_flight_averager.h.

Referenced by navigator_t::report_data().

record_input()

template<class value_t , bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>

void soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::record_input ( value_t  current_value, volatile float  heading  )

inline

Definition at line 112 of file soaring_flight_averager.h.

Referenced by soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::update().

relax()

template<class value_t , bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>

void soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::relax ( void  )

inline

Definition at line 150 of file soaring_flight_averager.h.

References pt2< datatype, basetype >::settle().

reset()

template<class value_t , bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>

void soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::reset ( value_t  value )

inline

Definition at line 131 of file soaring_flight_averager.h.

References pt2< datatype, basetype >::settle().

Referenced by soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::update().

update()

template<class value_t , bool CLAMP_OUTPUT_FIRST_CIRCLE = false, bool SOFT_TAKEOFF = true>

void soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::update ( const value_t &  current_value, float  heading, circle_state_t  new_state  )

inline

Definition at line 60 of file soaring_flight_averager.h.

References assert, soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::circle_completed(), CIRCLING, pt2< datatype, basetype >::get_output(), PI_TIMES_2, soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::record_input(), soaring_flight_averager< value_t, CLAMP_OUTPUT_FIRST_CIRCLE, SOFT_TAKEOFF >::reset(), pt2< datatype, basetype >::respond(), STRAIGHT_FLIGHT, TRANSITION, and ZERO.

Referenced by navigator_t::update_at_10Hz().

---

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

• lib/NAV_Algorithms/soaring_flight_averager.h