diffusion-double.h File Reference

Double datatype associated functions. More...

Functions
bool	read_diffusion_double_value (const DIFFUSION_VALUE_T *value, double *double_value, DIFFUSION_API_ERROR *error)
	Read a double from the diffusion value.
bool	write_diffusion_double_value (double value, const BUF_T *buf)
	Write a double value into a BUF_T for an update.

Detailed Description

Double datatype associated functions.

Function Documentation

read_diffusion_double_value()

bool read_diffusion_double_value	(	const DIFFUSION_VALUE_T *	value,
		double *	double_value,
		DIFFUSION_API_ERROR *	error )

Read a double from the diffusion value.

Parameters

value	the diffusion value.
double_value	pointer to set the double value to.
error	populated if an error occurs. Can be NULL.

Returns

true if the value was successfully set in the provided double_value pointer. False otherwise.

write_diffusion_double_value()

bool write_diffusion_double_value	(	double	value,
		const BUF_T *	buf )

Write a double value into a BUF_T for an update.

Parameters

value	value to be written into the BUF_T
buf	BUF_T to write the double value into

Returns

true if the value was successfully written into the BUF_T. False will be returned if buf is NULL.