aversive_10-03-12/modules/devices/control_system/filters/ramp/ramp.h File Reference

This module provides structure and functions to filter a ramp. More...

Go to the source code of this file.

Data Structures
struct	ramp_filter
	Definition of structur ramp_filter. More...
Functions
void	ramp_init (struct ramp_filter *r)
	Initialisation of the ramp_filter structur.
void	ramp_set_vars (struct ramp_filter *r, uint32_t neg, uint32_t pos)
	Set the fields of the ramp_filter structur.
int32_t	ramp_do_filter (void *r, int32_t in)
	Apply ramp_filter to a ramp.

---

Detailed Description

This module provides structure and functions to filter a ramp.

Author:

Vincent

Version:

1.0

Date:

6.01.2005 @ 12:00

Todo:

Verify the english language

Test:

filter a constante value to generate a ramp on the hardware. Everything is all right

Definition in file ramp.h.

---

Function Documentation

int32_t ramp_do_filter	(	void *	r,
		int32_t	in
	)

Apply ramp_filter to a ramp.

Parameters:

	r	ramp_filter used to filter the in
	in	ramp to filter

Returns:

filtered in

Definition at line 56 of file ramp.c.

References ramp_filter::prev_out, ramp_filter::var_neg, and ramp_filter::var_pos.

void ramp_init

(

struct ramp_filter *

r

)

Initialisation of the ramp_filter structur.

Parameters:

r

ramp_filter structur to initiate

Definition at line 28 of file ramp.c.

References IRQ_LOCK, IRQ_UNLOCK, ramp_filter::prev_out, ramp_filter::var_neg, and ramp_filter::var_pos.

void ramp_set_vars	(	struct ramp_filter *	r,
		uint32_t	neg,
		uint32_t	pos
	)

Set the fields of the ramp_filter structur.

Parameters:

	r	ramp_structure to modificate
	neg	limit for the negative variation
	pos	limit for the positive variation

Definition at line 43 of file ramp.c.

References IRQ_LOCK, IRQ_UNLOCK, ramp_filter::var_neg, and ramp_filter::var_pos.