bpf class
[FTS Data Classes]

---

Detailed Description

The bpf class.

Break-point function (or time-tagged values).

Data Structures
struct	bpfunc
Typedefs
typedef struct bpf	bpf_t
	The bpf data type.
typedef struct bpfunc	bpfunc_t
Functions
int	bpf_get_size (bpf_t *bpf)
	Get size of a bpf.
double	bpf_get_time (bpf_t *bpf, int index)
	Get time of point at given index of a bpf.
double	bpf_get_value (bpf_t *bpf, int index)
	Get value of point at given index of a bpf.
double	bpf_get_slope (bpf_t *bpf, int index)
	Get slope of point at given index of a bpf.
double	bpf_get_duration (bpf_t *bpf)
	Get duration of bpf.
FTS_API double	bpf_get_interpolated (bpf_t *bpf, double time)
	Get (interpolated) bpf value at given time.
FTS_API void	bpf_clear (bpf_t *bpf)
	Clear a bpf (set to a single point 0 at time 0).
FTS_API void	bpf_set_point (bpf_t *bpf, int index, double time, double value)
	Set point at given index.
FTS_API void	bpf_append_point (bpf_t *bpf, double time, double value)
	Append point with given time and value to a bpf.
FTS_API int	bpf_insert_point (bpf_t *bpf, double time, double value)
	Insert a new point with given time and value in a bpf.
FTS_API void	bpf_simplify (bpf_t *bpf)
	Remove redundant points from a bpf.
Variables
FTS_API fts_class_t *	bpf_class
	The bpf class identifier (pointer to class instance).

---

Typedef Documentation

typedef struct bpfunc bpfunc_t

the break-point function itself

---

Function Documentation

FTS_API void bpf_append_point	(	bpf_t *	bpf,
		double	time,
		double	value
	)

Append point with given time and value to a bpf.

Parameters:

	bpf	the bpf
	time	time of new point
	value	value of new point

FTS_API void bpf_clear

(

bpf_t *

bpf

)

Clear a bpf (set to a single point 0 at time 0).

Parameters:

bpf

the bpf

double bpf_get_duration

(

bpf_t *

bpf

)

Get duration of bpf.

Parameters:

bpf

the bpf

Returns:

bpf duration

FTS_API double bpf_get_interpolated	(	bpf_t *	bpf,
		double	time
	)

Get (interpolated) bpf value at given time.

Parameters:

	bpf	the bpf
	time	the time

Returns:

value at given time

int bpf_get_size

(

bpf_t *

bpf

)

Get size of a bpf.

Parameters:

bpf

the bpf

Returns:

current size (number of points) of the bpf

double bpf_get_slope	(	bpf_t *	bpf,
		int	index
	)

Get slope of point at given index of a bpf.

Parameters:

	bpf	the bpf
	index	point index

Returns:

slope of the point at the given index

double bpf_get_time	(	bpf_t *	bpf,
		int	index
	)

Get time of point at given index of a bpf.

Parameters:

	bpf	the bpf
	index	point index

Returns:

time of the point at the given index

double bpf_get_value	(	bpf_t *	bpf,
		int	index
	)

Get value of point at given index of a bpf.

Parameters:

	bpf	the bpf
	index	point index

Returns:

value of the point at the given index

FTS_API int bpf_insert_point	(	bpf_t *	bpf,
		double	time,
		double	value
	)

Insert a new point with given time and value in a bpf.

Parameters:

	bpf	the bpf
	time	time of new point
	value	value of new point

FTS_API void bpf_set_point	(	bpf_t *	bpf,
		int	index,
		double	time,
		double	value
	)

Set point at given index.

Parameters:

	bpf	the bpf
	index	index of point
	time	set time
	value	set value

FTS_API void bpf_simplify

(

bpf_t *

bpf

)

Remove redundant points from a bpf.

The function

Parameters:

bpf

the bpf