hkl/hkl-axis.h

   1 /* This file is part of the hkl library.
   2  *
   3  * The hkl library is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 3 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * The hkl library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with the hkl library.  If not, see <http://www.gnu.org/licenses/>.
  15  *
  16  * Copyright (C) 2003-2010 Synchrotron SOLEIL
  17  *                         L'Orme des Merisiers Saint-Aubin
  18  *                         BP 48 91192 GIF-sur-YVETTE CEDEX
  19  *
  20  * Authors: Picca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>
  21  */
  22 #ifndef __HKL_AXIS_H__
  23 #define __HKL_AXIS_H__
  24
  25 #include <hkl/hkl-macros.h>
  26 #include <hkl/hkl-interval.h>
  27 #include <hkl/hkl-vector.h>
  28 #include <hkl/hkl-quaternion.h>
  29 #include <hkl/hkl-parameter.h>
  30
  31 HKL_BEGIN_DECLS
  32
  33 typedef struct _HklAxis HklAxis;
  34
  35 struct _HklAxis {
  36         HklParameter parent_instance;
  37         HklVector axis_v;
  38         HklQuaternion q;
  39 };
  40
  41 /***********/
  42 /* HklAxis */
  43 /***********/
  44
  45 extern HklAxis *hkl_axis_new(char const *name, HklVector const *axis_v);
  46
  47 extern void hkl_axis_free(HklAxis *self);
  48
  49 extern void hkl_axis_init(HklAxis *axis, char const * name, HklVector const *axis_v);
  50
  51 extern char const *hkl_axis_get_name(HklAxis const *self);
  52
  53 extern int hkl_axis_get_changed(HklAxis const *self);
  54
  55 extern void hkl_axis_set_changed(HklAxis *self, int changed);
  56
  57 extern double hkl_axis_get_value(HklAxis const *self);
  58
  59 extern double hkl_axis_get_value_unit(HklAxis const *self);
  60
  61 extern double hkl_axis_get_value_closest(HklAxis const *self, HklAxis const *axis);
  62
  63 extern double hkl_axis_get_value_closest_unit(HklAxis const *self, HklAxis const *axis);
  64
  65 extern double hkl_axis_get_max(HklAxis const *self);
  66
  67 extern void hkl_axis_get_range_unit(HklAxis const *self, double *min, double *max);
  68
  69 extern void hkl_axis_set_value(HklAxis *self, double value);
  70
  71 extern void hkl_axis_set_value_smallest_in_range(HklAxis *self);
  72
  73 extern void hkl_axis_set_value_unit(HklAxis *self, double value);
  74
  75 extern void hkl_axis_set_range(HklAxis *self, double min, double max);
  76
  77 extern void hkl_axis_set_range_unit(HklAxis *self, double min, double max);
  78
  79 extern void hkl_axis_randomize(HklAxis *self);
  80
  81 /**
  82  * @brief get the quaternion of an axis.
  83  *
  84  * @param axis
  85  * @param q
  86  *
  87  * inline to speed computation.
  88  */
  89 extern void hkl_axis_get_quaternion(HklAxis const *self, HklQuaternion *q);
  90
  91 extern int hkl_axis_is_value_compatible_with_range(HklAxis const *self);
  92
  93 extern int hkl_axis_is_valid(const HklAxis *self);
  94
  95 extern void hkl_axis_fprintf(FILE *f, HklAxis *self);
  96
  97 HKL_END_DECLS
  98
  99 #endif /* __HKL_AXIS_H__ */