hkl-parameter-private

hkl-parameter-private

Functions

Types and Values

Description

Functions

g_quark_from_static_string ()

return
g_quark_from_static_string ();

fprintf ()

else
fprintf (f Param1);

hkl_parameter_new ()

HklParameter *
hkl_parameter_new (const char *name,
                   const char *description,
                   double min,
                   double value,
                   double max,
                   int fit,
                   int changed,
                   const HklUnit *unit,
                   const HklUnit *punit);

create a new HklParameter

Returns


hkl_parameter_init_copy ()

int
hkl_parameter_init_copy (HklParameter *self,
                         const HklParameter *src,
                         GError **error);

Parameters

self

the this ptr

 

src

the parameter to copy from

 

error

return location for a GError, or NULL

 

Returns

TRUE on success, FALSE if an error occurred


hkl_parameter_value_get_closest ()

double
hkl_parameter_value_get_closest (const HklParameter *self,
                                 const HklParameter *ref);

Parameters

self

the this ptr

 

ref

the reference HklParameter

 

Returns

the closest value of the ref HklParameter from the current self HklParameter


hkl_parameter_value_set_smallest_in_range ()

void
hkl_parameter_value_set_smallest_in_range
                               (HklParameter *self);

Parameters

self

the this ptr

 

hkl_parameter_is_valid ()

int
hkl_parameter_is_valid (const HklParameter *self);

check if the value of the HklParameter is in the min,max range

Returns


hkl_parameter_fprintf ()

void
hkl_parameter_fprintf (FILE *f,
                       HklParameter *self);

print into the FILE f an HklParameter

Types and Values

HklParameter

typedef struct {
	const char *name;
	const char *description;
	HklInterval range;
	double _value;
	const HklUnit *unit;
	const HklUnit *punit;
	int fit;
	int changed;
	const HklParameterOperations *ops;
} HklParameter;

HKL_PARAMETER_DEFAULTS

#define HKL_PARAMETER_DEFAULTS .name="dummy", .description="no description", .range={.min=0, .max=0}, ._value=0, .unit=NULL, .punit=NULL, .fit=TRUE, .changed=TRUE, .ops = &hkl_parameter_operations_defaults

HKL_PARAMETER_DEFAULTS_ANGLE

#define HKL_PARAMETER_DEFAULTS_ANGLE HKL_PARAMETER_DEFAULTS, .range={.min=-M_PI, .max=M_PI}, .unit = &hkl_unit_angle_rad, .punit = &hkl_unit_angle_deg

HKL_PARAMETER_ERROR

#define HKL_PARAMETER_ERROR hkl_parameter_error_quark ()

enum HklParameterError

Members

HKL_PARAMETER_ERROR_MIN_MAX_SET

   

struct HklParameterOperations

struct HklParameterOperations {
	HklParameter *        (*copy)(const HklParameter *self);
	void                  (*free)(HklParameter *self);
	int                   (*init_copy)(HklParameter *self, const HklParameter *src,
					   GError **error);
	double                (*get_value_closest)(const HklParameter *self,
						   const HklParameter *other);
	int                   (*set_value)(HklParameter *self, double value,
					   HklUnitEnum unit_type, GError **error);
	void                  (*set_value_smallest_in_range)(HklParameter *self);
	void                  (*randomize)(HklParameter *self);
	int                   (*is_valid)(const HklParameter *self);
	void                  (*fprintf)(FILE *f, const HklParameter *self);
	const HklVector *     (*axis_v_get)(const HklParameter *self);
	const HklQuaternion * (*quaternion_get)(const HklParameter *self);
};

HKL_PARAMETER_OPERATIONS_DEFAULTS

#define             HKL_PARAMETER_OPERATIONS_DEFAULTS

dup

	HklParameter *dup = HKL_MALLOC(HklParameter);

alea

		double alea = (double)rand() / (RAND_MAX + 1.);

factor

	double factor = hkl_unit_factor(self->unit, self->punit);

darray_parameter

typedef darray(HklParameter *) darray_parameter;