hkl-axis

hkl-axis

Synopsis

                    HklAxis;
HklAxis *           hkl_axis_new                        (char const *name,
                                                         HklVector const *axis_v);
void                hkl_axis_free                       (HklAxis *self);
void                hkl_axis_init                       (HklAxis *axis,
                                                         char const *name,
                                                         HklVector const *axis_v);
char const *        hkl_axis_get_name                   (HklAxis const *self);
int                 hkl_axis_get_changed                (HklAxis const *self);
void                hkl_axis_set_changed                (HklAxis *self,
                                                         int changed);
double              hkl_axis_get_value                  (HklAxis const *self);
double              hkl_axis_get_value_unit             (HklAxis const *self);
double              hkl_axis_get_value_closest          (HklAxis const *self,
                                                         HklAxis const *axis);
double              hkl_axis_get_value_closest_unit     (HklAxis const *self,
                                                         HklAxis const *axis);
double              hkl_axis_get_max                    (HklAxis const *self);
void                hkl_axis_get_range_unit             (HklAxis const *self,
                                                         double *min,
                                                         double *max);
void                hkl_axis_set_value                  (HklAxis *self,
                                                         double value);
void                hkl_axis_set_value_smallest_in_range
                                                        (HklAxis *self);
void                hkl_axis_set_value_unit             (HklAxis *self,
                                                         double value);
void                hkl_axis_set_range                  (HklAxis *self,
                                                         double min,
                                                         double max);
void                hkl_axis_set_range_unit             (HklAxis *self,
                                                         double min,
                                                         double max);
void                hkl_axis_randomize                  (HklAxis *self);
void                hkl_axis_get_quaternion             (HklAxis const *self,
                                                         HklQuaternion *q);
int                 hkl_axis_is_value_compatible_with_range
                                                        (HklAxis const *self);
int                 hkl_axis_is_valid                   (const HklAxis *self);
void                hkl_axis_fprintf                    (FILE *f,
                                                         HklAxis *self);

Description

Details

HklAxis

typedef struct {
	HklParameter parent_instance;
	HklVector axis_v;
	HklQuaternion q;
} HklAxis;


hkl_axis_new ()

HklAxis *           hkl_axis_new                        (char const *name,
                                                         HklVector const *axis_v);

name :

axis_v :

Returns :


hkl_axis_free ()

void                hkl_axis_free                       (HklAxis *self);

self :


hkl_axis_init ()

void                hkl_axis_init                       (HklAxis *axis,
                                                         char const *name,
                                                         HklVector const *axis_v);

axis :

name :

axis_v :


hkl_axis_get_name ()

char const *        hkl_axis_get_name                   (HklAxis const *self);

self :

Returns :


hkl_axis_get_changed ()

int                 hkl_axis_get_changed                (HklAxis const *self);

self :

Returns :


hkl_axis_set_changed ()

void                hkl_axis_set_changed                (HklAxis *self,
                                                         int changed);

self :

changed :


hkl_axis_get_value ()

double              hkl_axis_get_value                  (HklAxis const *self);

self :

Returns :


hkl_axis_get_value_unit ()

double              hkl_axis_get_value_unit             (HklAxis const *self);

self :

Returns :


hkl_axis_get_value_closest ()

double              hkl_axis_get_value_closest          (HklAxis const *self,
                                                         HklAxis const *axis);

self :

axis :

Returns :


hkl_axis_get_value_closest_unit ()

double              hkl_axis_get_value_closest_unit     (HklAxis const *self,
                                                         HklAxis const *axis);

self :

axis :

Returns :


hkl_axis_get_max ()

double              hkl_axis_get_max                    (HklAxis const *self);

self :

Returns :


hkl_axis_get_range_unit ()

void                hkl_axis_get_range_unit             (HklAxis const *self,
                                                         double *min,
                                                         double *max);

self :

min :

max :


hkl_axis_set_value ()

void                hkl_axis_set_value                  (HklAxis *self,
                                                         double value);

self :

value :


hkl_axis_set_value_smallest_in_range ()

void                hkl_axis_set_value_smallest_in_range
                                                        (HklAxis *self);

self :


hkl_axis_set_value_unit ()

void                hkl_axis_set_value_unit             (HklAxis *self,
                                                         double value);

self :

value :


hkl_axis_set_range ()

void                hkl_axis_set_range                  (HklAxis *self,
                                                         double min,
                                                         double max);

self :

min :

max :


hkl_axis_set_range_unit ()

void                hkl_axis_set_range_unit             (HklAxis *self,
                                                         double min,
                                                         double max);

self :

min :

max :


hkl_axis_randomize ()

void                hkl_axis_randomize                  (HklAxis *self);

self :


hkl_axis_get_quaternion ()

void                hkl_axis_get_quaternion             (HklAxis const *self,
                                                         HklQuaternion *q);

self :

q :


hkl_axis_is_value_compatible_with_range ()

int                 hkl_axis_is_value_compatible_with_range
                                                        (HklAxis const *self);

self :

Returns :


hkl_axis_is_valid ()

int                 hkl_axis_is_valid                   (const HklAxis *self);

self :

Returns :


hkl_axis_fprintf ()

void                hkl_axis_fprintf                    (FILE *f,
                                                         HklAxis *self);

f :

self :