param_distance.h File Reference

#include "param.h"

Include dependency graph for param_distance.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
struct yac_param *	yac_param_distance_new (const char *name, double *value_ptr, double default_value, double value_min, double value_max, int has_default, int is_defined)
	Create a distance parameter (stored in radians)

Function Documentation

yac_param_distance_new()

struct yac_param * yac_param_distance_new	(	const char *	name,
		double *	value_ptr,
		double	default_value,
		double	value_min,
		double	value_max,
		int	has_default,
		int	is_defined )

Create a distance parameter (stored in radians)

Unit handling:

• Numeric setter/getter APIs use radians.
• String setter/getter APIs use degrees by default.
• String setter accepts optional unit suffixes deg, rad, d, r (case-insensitive); if present, conversion is applied accordingly.

Parameters

name	Name of the parameter
value_ptr	Pointer to the double value (in radians)
default_value	Default value (in radians, ignored if has_default is false)
value_min	Minimum allowed value (inclusive, in radians, must be >= 0)
value_max	Maximum allowed value (inclusive, in radians, must be <= M_PI)
has_default	If true, parameter has a default value; if false, value is undefined until set
is_defined	If true, initial value is considered defined; if false, initial value is considered undefined and user must set it before getting

Requirements:

• value_min >= 0
• value_max <= M_PI
• value_min <= value_max

Returns

Pointer to new parameter handle

Definition at line 135 of file param_distance.c.

Here is the call graph for this function:

Here is the caller graph for this function: