\section{aversive\_\-10-03-12/modules/devices/control\_\-system/filters/quadramp/quadramp.h File Reference}
\label{quadramp_8h}\index{aversive\_\-10-03-12/modules/devices/control\_\-system/filters/quadramp/quadramp.h@{aversive\_\-10-03-12/modules/devices/control\_\-system/filters/quadramp/quadramp.h}}
{\tt \#include $<$aversive.h$>$}\par
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct {\bf quadramp\_\-filter}
\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
void {\bf quadramp\_\-init} (struct {\bf quadramp\_\-filter} $\ast$q)
\item 
void {\bf quadramp\_\-set\_\-2nd\_\-order\_\-vars} (struct {\bf quadramp\_\-filter} $\ast$q, uint32\_\-t var\_\-2nd\_\-ord\_\-pos, uint32\_\-t var\_\-2nd\_\-ord\_\-neg)
\item 
void {\bf quadramp\_\-set\_\-1st\_\-order\_\-vars} (struct {\bf quadramp\_\-filter} $\ast$q, uint32\_\-t var\_\-1st\_\-ord\_\-pos, uint32\_\-t var\_\-1st\_\-ord\_\-neg)
\item 
uint8\_\-t {\bf quadramp\_\-is\_\-finished} (struct {\bf quadramp\_\-filter} $\ast$q)
\item 
int32\_\-t {\bf quadramp\_\-do\_\-filter} (void $\ast$data, int32\_\-t in)
\end{CompactItemize}


\subsection{Function Documentation}
\index{quadramp.h@{quadramp.h}!quadramp\_\-do\_\-filter@{quadramp\_\-do\_\-filter}}
\index{quadramp\_\-do\_\-filter@{quadramp\_\-do\_\-filter}!quadramp.h@{quadramp.h}}
\subsubsection[quadramp\_\-do\_\-filter]{\setlength{\rightskip}{0pt plus 5cm}int32\_\-t quadramp\_\-do\_\-filter (void $\ast$ {\em data}, \/  int32\_\-t {\em in})}\label{quadramp_8h_d27babeb523aa4a57c955c278561e06d}


Process the ramp

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em data}]should be a (struct \doxyref{quadramp\_\-filter}{p.}{structquadramp__filter} $\ast$) pointer \item[{\em in}]is the input of the filter \end{description}
\end{Desc}


Definition at line 75 of file quadramp.c.

References quadramp\_\-filter::previous\_\-in, quadramp\_\-filter::previous\_\-out, quadramp\_\-filter::previous\_\-var, quadramp\_\-filter::var\_\-1st\_\-ord\_\-neg, quadramp\_\-filter::var\_\-1st\_\-ord\_\-pos, quadramp\_\-filter::var\_\-2nd\_\-ord\_\-neg, and quadramp\_\-filter::var\_\-2nd\_\-ord\_\-pos.\index{quadramp.h@{quadramp.h}!quadramp\_\-init@{quadramp\_\-init}}
\index{quadramp\_\-init@{quadramp\_\-init}!quadramp.h@{quadramp.h}}
\subsubsection[quadramp\_\-init]{\setlength{\rightskip}{0pt plus 5cm}void quadramp\_\-init (struct {\bf quadramp\_\-filter} $\ast$ {\em q})}\label{quadramp_8h_78af159ea6946f9a4db13dd069f28e46}


Initialization of the filter 

Definition at line 31 of file quadramp.c.

References IRQ\_\-LOCK, and IRQ\_\-UNLOCK.\index{quadramp.h@{quadramp.h}!quadramp\_\-is\_\-finished@{quadramp\_\-is\_\-finished}}
\index{quadramp\_\-is\_\-finished@{quadramp\_\-is\_\-finished}!quadramp.h@{quadramp.h}}
\subsubsection[quadramp\_\-is\_\-finished]{\setlength{\rightskip}{0pt plus 5cm}uint8\_\-t quadramp\_\-is\_\-finished (struct {\bf quadramp\_\-filter} $\ast$ {\em q})}\label{quadramp_8h_38483183dca647b8093457b8158c5150}


Return 1 when (filter\_\-input == filter\_\-output \&\& 1st\_\-ord variation is 0 --speed is 0-- ). 

Definition at line 62 of file quadramp.c.

References quadramp\_\-filter::previous\_\-in, quadramp\_\-filter::previous\_\-out, and quadramp\_\-filter::previous\_\-var.\index{quadramp.h@{quadramp.h}!quadramp\_\-set\_\-1st\_\-order\_\-vars@{quadramp\_\-set\_\-1st\_\-order\_\-vars}}
\index{quadramp\_\-set\_\-1st\_\-order\_\-vars@{quadramp\_\-set\_\-1st\_\-order\_\-vars}!quadramp.h@{quadramp.h}}
\subsubsection[quadramp\_\-set\_\-1st\_\-order\_\-vars]{\setlength{\rightskip}{0pt plus 5cm}void quadramp\_\-set\_\-1st\_\-order\_\-vars (struct {\bf quadramp\_\-filter} $\ast$ {\em q}, \/  uint32\_\-t {\em var\_\-1st\_\-ord\_\-pos}, \/  uint32\_\-t {\em var\_\-1st\_\-ord\_\-neg})}\label{quadramp_8h_b7778b7254094569f079a761a6450997}




Definition at line 50 of file quadramp.c.

References IRQ\_\-LOCK, IRQ\_\-UNLOCK, quadramp\_\-filter::var\_\-1st\_\-ord\_\-neg, and quadramp\_\-filter::var\_\-1st\_\-ord\_\-pos.\index{quadramp.h@{quadramp.h}!quadramp\_\-set\_\-2nd\_\-order\_\-vars@{quadramp\_\-set\_\-2nd\_\-order\_\-vars}}
\index{quadramp\_\-set\_\-2nd\_\-order\_\-vars@{quadramp\_\-set\_\-2nd\_\-order\_\-vars}!quadramp.h@{quadramp.h}}
\subsubsection[quadramp\_\-set\_\-2nd\_\-order\_\-vars]{\setlength{\rightskip}{0pt plus 5cm}void quadramp\_\-set\_\-2nd\_\-order\_\-vars (struct {\bf quadramp\_\-filter} $\ast$ {\em q}, \/  uint32\_\-t {\em var\_\-2nd\_\-ord\_\-pos}, \/  uint32\_\-t {\em var\_\-2nd\_\-ord\_\-neg})}\label{quadramp_8h_bf074f94ce2a25f9fb45369b63d06396}




Definition at line 39 of file quadramp.c.

References IRQ\_\-LOCK, IRQ\_\-UNLOCK, quadramp\_\-filter::var\_\-2nd\_\-ord\_\-neg, and quadramp\_\-filter::var\_\-2nd\_\-ord\_\-pos.