robotoc::MovingWindowFilter< dim > Class Template Reference

Moving window filter for foot step planning. More...

#include <moving_window_filter.hpp>

Public Types
using	Vector = Eigen::Matrix< double, dim, 1 >

Public Member Functions
	MovingWindowFilter (const double time_length, const double min_sampling_period=0.0)
	Constructs the filter. More...
	MovingWindowFilter ()
	Default constructor. More...
	~MovingWindowFilter ()
	Destructor. More...
	MovingWindowFilter (const MovingWindowFilter &)=default
	Default copy constructor. More...
MovingWindowFilter &	operator= (const MovingWindowFilter &)=default
	Default copy assign operator. More...
	MovingWindowFilter (MovingWindowFilter &&) noexcept=default
	Default move constructor. More...
MovingWindowFilter &	operator= (MovingWindowFilter &&) noexcept=default
	Default move assign operator. More...
void	setParameters (const double time_length, const double min_sampling_period=0.0)
	Set parameters of the filter. More...
void	clear ()
	Clear the filter. More...
void	push_back (const double t, const Vector &data)
	Push back a data. More...
int	size () const
	Gets the current data size. More...
const Vector &	average () const
	Gets the average. More...

Detailed Description

template<int dim>
class robotoc::MovingWindowFilter< dim >

Moving window filter for foot step planning.

Member Typedef Documentation

Vector

template<int dim>

using robotoc::MovingWindowFilter< dim >::Vector = Eigen::Matrix<double, dim, 1>

Constructor & Destructor Documentation

MovingWindowFilter() [1/4]

template<int dim>

robotoc::MovingWindowFilter< dim >::MovingWindowFilter ( const double  time_length, const double  min_sampling_period = 0.0  )

inline

Constructs the filter.

Parameters

[in]	time_length	Time length (seconds) of the filter.
[in]	min_sampling_period	Minimum sampling period. Must be non-negative. Default is zero.

MovingWindowFilter() [2/4]

template<int dim>

robotoc::MovingWindowFilter< dim >::MovingWindowFilter ( )

inline

Default constructor.

~MovingWindowFilter()

template<int dim>

robotoc::MovingWindowFilter< dim >::~MovingWindowFilter ( )

inline

Destructor.

MovingWindowFilter() [3/4]

template<int dim>

robotoc::MovingWindowFilter< dim >::MovingWindowFilter ( const MovingWindowFilter< dim > &  )

default

Default copy constructor.

MovingWindowFilter() [4/4]

template<int dim>

robotoc::MovingWindowFilter< dim >::MovingWindowFilter ( MovingWindowFilter< dim > &&  )

defaultnoexcept

Default move constructor.

Member Function Documentation

average()

template<int dim>

const Vector & robotoc::MovingWindowFilter< dim >::average ( ) const

inline

Gets the average.

clear()

template<int dim>

void robotoc::MovingWindowFilter< dim >::clear ( )

inline

Clear the filter.

operator=() [1/2]

template<int dim>

MovingWindowFilter & robotoc::MovingWindowFilter< dim >::operator= ( const MovingWindowFilter< dim > &  )

default

Default copy assign operator.

operator=() [2/2]

template<int dim>

MovingWindowFilter & robotoc::MovingWindowFilter< dim >::operator= ( MovingWindowFilter< dim > &&  )

defaultnoexcept

Default move assign operator.

push_back()

template<int dim>

void robotoc::MovingWindowFilter< dim >::push_back ( const double  t, const Vector &  data  )

inline

Push back a data.

Parameters

[in]	t	Time of the data sampling.
[in]	data	The data.

setParameters()

template<int dim>

void robotoc::MovingWindowFilter< dim >::setParameters ( const double  time_length, const double  min_sampling_period = 0.0  )

inline

Set parameters of the filter.

Parameters

[in]	time_length	Time length (seconds) of the filter.
[in]	min_sampling_period	Minimum sampling period. Must be non-negative. Default is zero.

size()

template<int dim>

int robotoc::MovingWindowFilter< dim >::size ( ) const

inline

Gets the current data size.

---

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

• /github/workspace/include/robotoc/mpc/moving_window_filter.hpp