hkl-parameter

hkl-parameter

Synopsis

                    HklParameter;
HklParameter *      hkl_parameter_new                   (char const *name,
                                                         double min,
                                                         double value,
                                                         double max,
                                                         int fit,
                                                         int changed,
                                                         HklUnit const *unit,
                                                         HklUnit const *punit);
HklParameter *      hkl_parameter_new_copy              (HklParameter const *self);
int                 hkl_parameter_init                  (HklParameter *self,
                                                         char const *name,
                                                         double min,
                                                         double value,
                                                         double max,
                                                         int fit,
                                                         int changed,
                                                         HklUnit const *unit,
                                                         HklUnit const *punit);
void                hkl_parameter_free                  (HklParameter *self);
void                hkl_parameter_set_value             (HklParameter *self,
                                                         double value);
double              hkl_parameter_get_value_unit        (HklParameter const *self);
int                 hkl_parameter_set_value_unit        (HklParameter *self,
                                                         double value);
double              hkl_parameter_get_max               (HklParameter const *self);
void                hkl_parameter_get_range_unit        (HklParameter const *self,
                                                         double *min,
                                                         double *max);
void                hkl_parameter_set_range             (HklParameter *self,
                                                         double min,
                                                         double max);
void                hkl_parameter_set_range_unit        (HklParameter *self,
                                                         double min,
                                                         double max);
void                hkl_parameter_randomize             (HklParameter *self);
int                 hkl_parameter_is_valid              (const HklParameter *self);
void                hkl_parameter_fprintf               (FILE *f,
                                                         HklParameter *self);

Description

Details

HklParameter

typedef struct {
	const char *name;
	HklInterval range;
	double value;
	HklUnit const *unit;
	HklUnit const *punit;
	int fit;
	int changed;
} HklParameter;


hkl_parameter_new ()

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

name :

min :

value :

max :

fit :

changed :

unit :

punit :

Returns :


hkl_parameter_new_copy ()

HklParameter *      hkl_parameter_new_copy              (HklParameter const *self);

self :

Returns :


hkl_parameter_init ()

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

self :

name :

min :

value :

max :

fit :

changed :

unit :

punit :

Returns :


hkl_parameter_free ()

void                hkl_parameter_free                  (HklParameter *self);

self :


hkl_parameter_set_value ()

void                hkl_parameter_set_value             (HklParameter *self,
                                                         double value);

self :

value :


hkl_parameter_get_value_unit ()

double              hkl_parameter_get_value_unit        (HklParameter const *self);

self :

Returns :


hkl_parameter_set_value_unit ()

int                 hkl_parameter_set_value_unit        (HklParameter *self,
                                                         double value);

self :

value :

Returns :


hkl_parameter_get_max ()

double              hkl_parameter_get_max               (HklParameter const *self);

self :

Returns :


hkl_parameter_get_range_unit ()

void                hkl_parameter_get_range_unit        (HklParameter const *self,
                                                         double *min,
                                                         double *max);

self :

min :

max :


hkl_parameter_set_range ()

void                hkl_parameter_set_range             (HklParameter *self,
                                                         double min,
                                                         double max);

self :

min :

max :


hkl_parameter_set_range_unit ()

void                hkl_parameter_set_range_unit        (HklParameter *self,
                                                         double min,
                                                         double max);

self :

min :

max :


hkl_parameter_randomize ()

void                hkl_parameter_randomize             (HklParameter *self);

self :


hkl_parameter_is_valid ()

int                 hkl_parameter_is_valid              (const HklParameter *self);

self :

Returns :


hkl_parameter_fprintf ()

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

f :

self :