hkl.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-2016 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_H__
  23 #define __HKL_H__
  24
  25 #include <math.h>                       // for M_PI
  26 #include <stddef.h>                     // for size_t
  27 #include <stdio.h>                      // for FILE
  28 #include <glib.h>                       // for g_set_error, GError etc
  29 #include <hkl/ccan/darray/darray.h>     // for darray
  30
  31 /* deprecated */
  32 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
  33 # define HKL_DEPRECATED __attribute__((__deprecated__))
  34 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
  35 # define HKL_DEPRECATED __declspec(deprecated)
  36 #else
  37 # define HKL_DEPRECATED
  38 #endif
  39
  40 #if    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
  41 # define HKL_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
  42 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
  43 # define HKL_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
  44 #else
  45 # define HKL_DEPRECATED_FOR(f) HKL_DEPRECATED
  46 #endif
  47
  48 #define HKL_TINY 1e-7
  49 #define HKL_EPSILON 1e-6
  50 #define HKL_DEGTORAD (M_PI/180.)
  51 #define HKL_RADTODEG (180./M_PI)
  52
  53 /* tau = 2pi or 1 */
  54 #define HKL_TAU (2. * M_PI)
  55 /* #define HKL_TAU 1 */
  56
  57 #ifdef HKLAPI
  58 # undef HKLEAPI
  59 #endif
  60
  61 #ifdef __GNUC__
  62 # if __GNUC__ >= 4
  63 #  define HKLAPI __attribute__ ((visibility("default")))
  64 # else
  65 #  define HKLAPI
  66 # endif
  67 #else
  68 /**
  69  * @def HKLAPI
  70  * @brief Used to export functions(by changing visibility).
  71  */
  72 # define HKLAPI
  73 #endif
  74
  75 #if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
  76 # define HKL_ARG_NONNULL(...) __attribute__ ((__nonnull__(__VA_ARGS__)))
  77 #else
  78 # define HKL_ARG_NONNULL(...)
  79 #endif
  80
  81 # if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
  82 #  define HKL_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
  83 # else
  84 #  define HKL_WARN_UNUSED_RESULT
  85 # endif
  86
  87
  88 #define _darray(type) type *item; size_t size; size_t alloc
  89
  90 G_BEGIN_DECLS
  91
  92 /**********/
  93 /* Vector */
  94 /**********/
  95
  96 typedef struct _HklVector HklVector;
  97
  98 struct _HklVector
  99 {
 100         double data[3];
 101 };
 102
 103 HKLAPI void hkl_vector_init(HklVector *self, double x, double y, double z);
 104
 105 /**************/
 106 /* Quaternion */
 107 /**************/
 108
 109 typedef struct _HklQuaternion HklQuaternion;
 110 typedef struct _HklMatrix HklMatrix; /* forwarded declaration */
 111
 112 struct _HklQuaternion
 113 {
 114         double data[4];
 115 };
 116
 117 typedef darray(const char *) darray_string;
 118
 119 HKLAPI void hkl_quaternion_to_matrix(const HklQuaternion *self, HklMatrix *m) HKL_ARG_NONNULL(1, 2);
 120
 121 /**********/
 122 /* Matrix */
 123 /**********/
 124
 125 HKLAPI HklMatrix *hkl_matrix_new(void);
 126
 127 HKLAPI HklMatrix *hkl_matrix_new_full(double m11, double m12, double m13,
 128                                       double m21, double m22, double m23,
 129                                       double m31, double m32, double m33);
 130
 131 HKLAPI HklMatrix *hkl_matrix_new_euler(double euler_x, double euler_y, double euler_z);
 132
 133 HKLAPI double hkl_matrix_get(const HklMatrix *self, unsigned int i, unsigned int j) HKL_ARG_NONNULL(1);
 134
 135 HKLAPI void hkl_matrix_free(HklMatrix *self) HKL_ARG_NONNULL(1);
 136
 137 HKLAPI void hkl_matrix_init(HklMatrix *self,
 138                             double m11, double m12, double m13,
 139                             double m21, double m22, double m23,
 140                             double m31, double m32, double m33) HKL_ARG_NONNULL(1);
 141
 142 HKLAPI int hkl_matrix_cmp(const HklMatrix *self, const HklMatrix *m) HKL_ARG_NONNULL(1, 2);
 143
 144 HKLAPI void hkl_matrix_times_matrix(HklMatrix *self, const HklMatrix *m) HKL_ARG_NONNULL(1, 2);
 145
 146 /********/
 147 /* Unit */
 148 /********/
 149
 150 typedef enum _HklUnitEnum
 151 {
 152         HKL_UNIT_DEFAULT,
 153         HKL_UNIT_USER
 154 } HklUnitEnum;
 155
 156 /*************/
 157 /* Parameter */
 158 /*************/
 159
 160 typedef struct _HklParameter HklParameter;
 161
 162 /* HklParameter */
 163
 164 HKLAPI HklParameter *hkl_parameter_new_copy(const HklParameter *self) HKL_ARG_NONNULL(1);
 165
 166 HKLAPI void hkl_parameter_free(HklParameter *self) HKL_ARG_NONNULL(1);
 167
 168 HKLAPI const char *hkl_parameter_name_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 169
 170 HKLAPI const char *hkl_parameter_default_unit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 171
 172 HKLAPI const char *hkl_parameter_user_unit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 173
 174 HKLAPI double hkl_parameter_value_get(const HklParameter *self,
 175                                       HklUnitEnum unit_type) HKL_ARG_NONNULL(1);
 176
 177 HKLAPI int hkl_parameter_value_set(HklParameter *self, double value,
 178                                    HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 179
 180 HKLAPI void hkl_parameter_min_max_get(const HklParameter *self, double *min, double *max,
 181                                       HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2, 3);
 182
 183 HKLAPI int hkl_parameter_min_max_set(HklParameter *self, double min, double max,
 184                                      HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 185
 186 HKLAPI int hkl_parameter_fit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 187
 188 HKLAPI void hkl_parameter_fit_set(HklParameter *self, int fit) HKL_ARG_NONNULL(1);
 189
 190 HKLAPI void hkl_parameter_randomize(HklParameter *self) HKL_ARG_NONNULL(1);
 191
 192 /* getter and setter specific to certain type of HklParameter */
 193
 194 HKLAPI const HklVector *hkl_parameter_axis_v_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 195
 196 HKLAPI const HklQuaternion *hkl_parameter_quaternion_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 197
 198 HKLAPI const char *hkl_parameter_description_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 199
 200 /************/
 201 /* Detector */
 202 /************/
 203
 204 typedef struct _HklDetector HklDetector;
 205 typedef enum _HklDetectorType
 206 {
 207         HKL_DETECTOR_TYPE_0D
 208 } HklDetectorType;
 209
 210 HKLAPI HklDetector *hkl_detector_factory_new(HklDetectorType type);
 211
 212 HKLAPI HklDetector *hkl_detector_new_copy(const HklDetector *src) HKL_ARG_NONNULL(1);
 213
 214 HKLAPI void hkl_detector_free(HklDetector *self) HKL_ARG_NONNULL(1);
 215
 216 HKLAPI void hkl_detector_fprintf(FILE *f, const HklDetector *self) HKL_ARG_NONNULL(1, 2);
 217
 218 /************/
 219 /* Geometry */
 220 /************/
 221
 222 typedef struct _HklGeometry HklGeometry;
 223 typedef struct _HklGeometryList HklGeometryList;
 224 typedef struct _HklGeometryListItem HklGeometryListItem;
 225 typedef struct _HklSample HklSample; /* forwarded declaration */
 226
 227 /* HklGeometry */
 228
 229 HKLAPI HklGeometry *hkl_geometry_new_copy(const HklGeometry *self) HKL_ARG_NONNULL(1);
 230
 231 HKLAPI void hkl_geometry_free(HklGeometry *self) HKL_ARG_NONNULL(1);
 232
 233 HKLAPI int hkl_geometry_set(HklGeometry *self, const HklGeometry *src) HKL_ARG_NONNULL(1, 2);
 234
 235 HKLAPI const darray_string *hkl_geometry_axis_names_get(const HklGeometry *self) HKL_ARG_NONNULL(1);
 236
 237 HKLAPI const HklParameter *hkl_geometry_axis_get(const HklGeometry *self, const char *name,
 238                                                  GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 239
 240 HKLAPI int hkl_geometry_axis_set(HklGeometry *self, const char *name,
 241                                  const HklParameter *axis,
 242                                  GError **error) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT;
 243
 244 HKLAPI void hkl_geometry_axis_values_get(const HklGeometry *self,
 245                                          double values[], size_t n_values,
 246                                          HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2);
 247
 248 HKLAPI int hkl_geometry_axis_values_set(HklGeometry *self,
 249                                         double values[], size_t n_values,
 250                                         HklUnitEnum unit_type,
 251                                         GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 252
 253 HKLAPI const char *hkl_geometry_name_get(const HklGeometry *self) HKL_ARG_NONNULL(1);
 254
 255 HKLAPI double hkl_geometry_wavelength_get(const HklGeometry *self,
 256                                           HklUnitEnum unit_type) HKL_ARG_NONNULL(1);
 257
 258 HKLAPI int hkl_geometry_wavelength_set(HklGeometry *self, double wavelength,
 259                                        HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 260
 261 HKLAPI void hkl_geometry_randomize(HklGeometry *self) HKL_ARG_NONNULL(1);
 262
 263 /* TODO after bissecting it seems that this method is slow (to replace) */
 264 HKLAPI int hkl_geometry_set_values_v(HklGeometry *self, HklUnitEnum unit_type,
 265                                      GError **error, ...) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 266
 267 HKLAPI HklQuaternion hkl_geometry_sample_rotation_get(const HklGeometry *self,
 268                                                       const HklSample *sample) HKL_ARG_NONNULL(1, 2);
 269
 270 HKLAPI HklQuaternion hkl_geometry_detector_rotation_get(const HklGeometry *self,
 271                                                         const HklDetector *detector) HKL_ARG_NONNULL(1, 2);
 272
 273 HKLAPI void hkl_geometry_fprintf(FILE *file, const HklGeometry *self) HKL_ARG_NONNULL(1, 2);
 274
 275 /* HklGeometryList */
 276
 277 #define HKL_GEOMETRY_LIST_FOREACH(item, list) for((item)=hkl_geometry_list_items_first_get((list)); \
 278                                                   (item);               \
 279                                                   (item)=hkl_geometry_list_items_next_get((list), (item)))
 280
 281 HKLAPI void hkl_geometry_list_free(HklGeometryList *self) HKL_ARG_NONNULL(1);
 282
 283 HKLAPI size_t hkl_geometry_list_n_items_get(const HklGeometryList *self) HKL_ARG_NONNULL(1);
 284
 285 HKLAPI const HklGeometryListItem *hkl_geometry_list_items_first_get(const HklGeometryList *self) HKL_ARG_NONNULL(1);
 286
 287 HKLAPI const HklGeometryListItem *hkl_geometry_list_items_next_get(const HklGeometryList *self,
 288                                                                    const HklGeometryListItem *item) HKL_ARG_NONNULL(1, 2);
 289
 290 /* HklGeometryListItem */
 291
 292 HKLAPI const HklGeometry *hkl_geometry_list_item_geometry_get(const HklGeometryListItem *self) HKL_ARG_NONNULL(1);
 293
 294 /**********/
 295 /* Sample */
 296 /**********/
 297
 298 typedef struct _HklLattice HklLattice;
 299 typedef struct _HklSampleReflection HklSampleReflection;
 300
 301 /* Lattice */
 302
 303 HKLAPI HklLattice *hkl_lattice_new(double a, double b, double c,
 304                                    double alpha, double beta, double gamma,
 305                                    GError **error) HKL_WARN_UNUSED_RESULT;
 306
 307 HKLAPI HklLattice *hkl_lattice_new_copy(const HklLattice *self) HKL_ARG_NONNULL(1);
 308
 309 HKLAPI HklLattice *hkl_lattice_new_default(void);
 310
 311 HKLAPI void hkl_lattice_free(HklLattice *self) HKL_ARG_NONNULL(1);
 312
 313 HKLAPI const HklParameter *hkl_lattice_a_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 314
 315 HKLAPI int hkl_lattice_a_set(HklLattice *self, const HklParameter *parameter,
 316                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 317
 318 HKLAPI const HklParameter *hkl_lattice_b_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 319
 320 HKLAPI int hkl_lattice_b_set(HklLattice *self, const HklParameter *parameter,
 321                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 322
 323 HKLAPI const HklParameter *hkl_lattice_c_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 324
 325 HKLAPI int hkl_lattice_c_set(HklLattice *self, const HklParameter *parameter,
 326                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 327
 328 HKLAPI const HklParameter *hkl_lattice_alpha_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 329
 330 HKLAPI int hkl_lattice_alpha_set(HklLattice *self, const HklParameter *parameter,
 331                                  GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 332
 333 HKLAPI const HklParameter *hkl_lattice_beta_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 334
 335 HKLAPI int hkl_lattice_beta_set(HklLattice *self, const HklParameter *parameter,
 336                                 GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 337
 338 HKLAPI const HklParameter *hkl_lattice_gamma_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 339
 340 HKLAPI int hkl_lattice_gamma_set(HklLattice *self, const HklParameter *parameter,
 341                                  GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 342
 343 HKLAPI const HklParameter *hkl_lattice_volume_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 344
 345 HKLAPI int hkl_lattice_set(HklLattice *self,
 346                            double a, double b, double c,
 347                            double alpha, double beta, double gamma,
 348                            HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 349
 350 HKLAPI void hkl_lattice_get(const HklLattice *self,
 351                             double *a, double *b, double *c,
 352                             double *alpha, double *beta, double *gamma,
 353                             HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2, 3, 4, 5, 6, 7);
 354
 355 HKLAPI int hkl_lattice_get_B(const HklLattice *self, HklMatrix *B) HKL_ARG_NONNULL(1, 2);
 356
 357 HKLAPI int hkl_lattice_get_1_B(const HklLattice *self, HklMatrix *B) HKL_ARG_NONNULL(1, 2);
 358
 359 HKLAPI int hkl_lattice_reciprocal(const HklLattice *self, HklLattice *reciprocal) HKL_ARG_NONNULL(1, 2);
 360
 361 /* HklSample */
 362
 363 HKLAPI HklSample *hkl_sample_new(const char *name) HKL_ARG_NONNULL(1);
 364
 365 HKLAPI HklSample *hkl_sample_new_copy(const HklSample *self) HKL_ARG_NONNULL(1);
 366
 367 HKLAPI void hkl_sample_free(HklSample *self) HKL_ARG_NONNULL(1);
 368
 369 HKLAPI const char *hkl_sample_name_get(const HklSample *self) HKL_ARG_NONNULL(1);
 370
 371 HKLAPI void hkl_sample_name_set(HklSample *self, const char *name) HKL_ARG_NONNULL(1, 2);
 372
 373 HKLAPI const HklLattice *hkl_sample_lattice_get(HklSample *self) HKL_ARG_NONNULL(1);
 374
 375 HKLAPI void hkl_sample_lattice_set(HklSample *self, const HklLattice *lattice) HKL_ARG_NONNULL(1, 2);
 376
 377 HKLAPI const HklParameter *hkl_sample_ux_get(const HklSample *self) HKL_ARG_NONNULL(1);
 378
 379 HKLAPI int hkl_sample_ux_set(HklSample *self, const HklParameter *ux,
 380                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 381
 382 HKLAPI const HklParameter *hkl_sample_uy_get(const HklSample *self) HKL_ARG_NONNULL(1);
 383
 384 HKLAPI int hkl_sample_uy_set(HklSample *self, const HklParameter *uy,
 385                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 386
 387 HKLAPI const HklParameter *hkl_sample_uz_get(const HklSample *self) HKL_ARG_NONNULL(1);
 388
 389 HKLAPI int hkl_sample_uz_set(HklSample *self, const HklParameter *uz,
 390                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 391
 392 HKLAPI const HklMatrix *hkl_sample_U_get(const HklSample *self) HKL_ARG_NONNULL(1);
 393
 394 HKLAPI void hkl_sample_U_set(HklSample *self, const HklMatrix *U, GError **error) HKL_ARG_NONNULL(1);
 395
 396 HKLAPI const HklMatrix *hkl_sample_UB_get(const HklSample *self) HKL_ARG_NONNULL(1);
 397
 398 HKLAPI int hkl_sample_UB_set(HklSample *self, const HklMatrix *UB,
 399                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 400
 401 HKLAPI size_t hkl_sample_n_reflections_get(const HklSample *self) HKL_ARG_NONNULL(1);
 402
 403 #define HKL_SAMPLE_REFLECTIONS_FOREACH(_item, _list) for((_item)=hkl_sample_reflections_first_get((_list)); \
 404                                                          (_item);       \
 405                                                          (_item)=hkl_sample_reflections_next_get((_list), (_item)))
 406
 407 HKLAPI HklSampleReflection *hkl_sample_reflections_first_get(HklSample *self) HKL_ARG_NONNULL(1);
 408
 409 HKLAPI HklSampleReflection *hkl_sample_reflections_next_get(HklSample *self,
 410                                                             HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 411
 412 HKLAPI void hkl_sample_del_reflection(HklSample *self,
 413                                       HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 414
 415 HKLAPI void hkl_sample_add_reflection(HklSample *self,
 416                                       HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 417
 418 HKLAPI int hkl_sample_compute_UB_busing_levy(HklSample *self,
 419                                              const HklSampleReflection *r1,
 420                                              const HklSampleReflection *r2,
 421                                              GError **error) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT;
 422
 423 HKLAPI double hkl_sample_get_reflection_measured_angle(const HklSample *self,
 424                                                       const HklSampleReflection *r1,
 425                                                       const HklSampleReflection *r2) HKL_ARG_NONNULL(1, 2, 3);
 426
 427 HKLAPI double hkl_sample_get_reflection_theoretical_angle(const HklSample *self,
 428                                                           const HklSampleReflection *r1,
 429                                                           const HklSampleReflection *r2) HKL_ARG_NONNULL(1, 2, 3);
 430
 431 HKLAPI int hkl_sample_affine(HklSample *self, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 432
 433 /* HklSampleReflection */
 434
 435 HKLAPI HklSampleReflection *hkl_sample_reflection_new(const HklGeometry *geometry,
 436                                                       const HklDetector *detector,
 437                                                       double h, double k, double l,
 438                                                       GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 439
 440 HKLAPI void hkl_sample_reflection_hkl_get(const HklSampleReflection *self,
 441                                           double *h, double *k, double *l) HKL_ARG_NONNULL(1, 2, 3, 4);
 442
 443 HKLAPI int hkl_sample_reflection_hkl_set(HklSampleReflection *self,
 444                                          double h, double k, double l,
 445                                          GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 446
 447 HKLAPI int hkl_sample_reflection_flag_get(const HklSampleReflection *self) HKL_ARG_NONNULL(1);
 448
 449 HKLAPI void hkl_sample_reflection_flag_set(HklSampleReflection *self, int flag) HKL_ARG_NONNULL(1);
 450
 451 HKLAPI const HklGeometry *hkl_sample_reflection_geometry_get(HklSampleReflection *self) HKL_ARG_NONNULL(1);
 452
 453 HKLAPI void hkl_sample_reflection_geometry_set(HklSampleReflection *self,
 454                                                const HklGeometry *geometry) HKL_ARG_NONNULL(1, 2);
 455
 456 /**************/
 457 /* PseudoAxis */
 458 /**************/
 459
 460 typedef struct _HklEngine HklEngine;
 461 typedef struct _HklEngineList HklEngineList;
 462
 463 typedef darray(HklEngine *) darray_engine;
 464
 465 /* HklEngine */
 466
 467 HKLAPI const char *hkl_engine_name_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 468
 469 HKLAPI unsigned int hkl_engine_len(const HklEngine *self) HKL_ARG_NONNULL(1);
 470
 471 HKLAPI const darray_string *hkl_engine_pseudo_axis_names_get(HklEngine *self) HKL_ARG_NONNULL(1);
 472
 473 HKLAPI int hkl_engine_pseudo_axis_values_get(HklEngine *self,
 474                                              double values[], size_t n_values,
 475                                              HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 476
 477 HKLAPI HklGeometryList *hkl_engine_pseudo_axis_values_set(HklEngine *self,
 478                                                           double values[], size_t n_values,
 479                                                           HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 480
 481 HKLAPI const HklParameter *hkl_engine_pseudo_axis_get(const HklEngine *self,
 482                                                       const char *name,
 483                                                       GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 484
 485 typedef enum _HklEngineCapabilities
 486 {
 487         HKL_ENGINE_CAPABILITIES_READABLE = 1u << 0,
 488         HKL_ENGINE_CAPABILITIES_WRITABLE = 1u << 1,
 489         HKL_ENGINE_CAPABILITIES_INITIALIZABLE = 1u << 2,
 490 } HklEngineCapabilities;
 491
 492 HKLAPI unsigned int hkl_engine_capabilities_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 493
 494 HKLAPI int hkl_engine_initialized_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 495
 496 HKLAPI int hkl_engine_initialized_set(HklEngine *self, int initialized,
 497                                       GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 498
 499 HKLAPI void hkl_engine_fprintf(FILE *f, const HklEngine *self) HKL_ARG_NONNULL(1, 2);
 500
 501 /* mode */
 502
 503 HKLAPI const darray_string *hkl_engine_modes_names_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 504
 505 HKLAPI const char *hkl_engine_current_mode_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 506
 507 HKLAPI int hkl_engine_current_mode_set(HklEngine *self, const char *name, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 508
 509 typedef enum _HklEngineAxisNamesGet
 510 {
 511         HKL_ENGINE_AXIS_NAMES_GET_READ,
 512         HKL_ENGINE_AXIS_NAMES_GET_WRITE,
 513 } HklEngineAxisNamesGet;
 514
 515 HKLAPI const darray_string *hkl_engine_axis_names_get(const HklEngine *self,
 516                                                       HklEngineAxisNamesGet mode) HKL_ARG_NONNULL(1);
 517
 518 HKLAPI const darray_string *hkl_engine_parameters_names_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 519
 520 HKLAPI const HklParameter *hkl_engine_parameter_get(const HklEngine *self, const char *name,
 521                                                     GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 522
 523 HKLAPI int hkl_engine_parameter_set(HklEngine *self,
 524                                     const char *name, const HklParameter *parameter,
 525                                     GError **error) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT;
 526
 527 HKLAPI void hkl_engine_parameters_values_get(const HklEngine *self,
 528                                              double values[], size_t n_values,
 529                                              HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2);
 530
 531 HKLAPI int hkl_engine_parameters_values_set(HklEngine *self,
 532                                             double values[], size_t n_values,
 533                                             HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 534
 535 typedef enum _HklEngineDependencies
 536 {
 537         HKL_ENGINE_DEPENDENCIES_AXES = 1u << 0,
 538         HKL_ENGINE_DEPENDENCIES_ENERGY = 1u << 1,
 539         HKL_ENGINE_DEPENDENCIES_SAMPLE = 1u << 2,
 540 } HklEngineDependencies;
 541
 542 HKLAPI unsigned int hkl_engine_dependencies_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 543
 544
 545 /* HklEngineList */
 546
 547 HKLAPI void hkl_engine_list_free(HklEngineList *self) HKL_ARG_NONNULL(1);
 548
 549 HKLAPI darray_engine *hkl_engine_list_engines_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 550
 551 HKLAPI HklGeometry *hkl_engine_list_geometry_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 552
 553 HKLAPI int hkl_engine_list_geometry_set(HklEngineList *self, const HklGeometry *geometry) HKL_ARG_NONNULL(1, 2);
 554
 555 HKLAPI int hkl_engine_list_select_solution(HklEngineList *self,
 556                                            const HklGeometryListItem *item) HKL_ARG_NONNULL(1);
 557
 558 HKLAPI HklEngine *hkl_engine_list_engine_get_by_name(HklEngineList *self,
 559                                                      const char *name,
 560                                                      GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 561
 562 HKLAPI void hkl_engine_list_init(HklEngineList *self,
 563                                  HklGeometry *geometry,
 564                                  HklDetector *detector,
 565                                  HklSample *sample) HKL_ARG_NONNULL(1, 2, 3, 4);
 566
 567 HKLAPI int hkl_engine_list_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 568
 569 HKLAPI void hkl_engine_list_fprintf(FILE *f,
 570                                     const HklEngineList *self) HKL_ARG_NONNULL(1, 2);
 571
 572 /***********/
 573 /* Factory */
 574 /***********/
 575
 576 typedef struct _HklFactory HklFactory;
 577
 578 HKLAPI HklFactory **hkl_factory_get_all(size_t *n) HKL_ARG_NONNULL(1);
 579
 580 HKLAPI HklFactory *hkl_factory_get_by_name(const char *name,
 581                                            GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 582
 583 HKLAPI const char *hkl_factory_name_get(const HklFactory *self) HKL_ARG_NONNULL(1);
 584
 585 HKLAPI HklGeometry *hkl_factory_create_new_geometry(const HklFactory *self) HKL_ARG_NONNULL(1);
 586
 587 HKLAPI HklEngineList *hkl_factory_create_new_engine_list(const HklFactory *self) HKL_ARG_NONNULL(1);
 588
 589 G_END_DECLS
 590
 591 #endif