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-2014 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 /**************/
 104 /* Quaternion */
 105 /**************/
 106
 107 typedef struct _HklQuaternion HklQuaternion;
 108
 109 struct _HklQuaternion
 110 {
 111         double data[4];
 112 };
 113
 114 typedef darray(const char *) darray_string;
 115
 116 /**********/
 117 /* Matrix */
 118 /**********/
 119
 120 typedef struct _HklMatrix HklMatrix;
 121
 122 HKLAPI HklMatrix *hkl_matrix_new(void);
 123
 124 HKLAPI HklMatrix *hkl_matrix_new_full(double m11, double m12, double m13,
 125                                       double m21, double m22, double m23,
 126                                       double m31, double m32, double m33);
 127
 128 HKLAPI HklMatrix *hkl_matrix_new_euler(double euler_x, double euler_y, double euler_z);
 129
 130 HKLAPI double hkl_matrix_get(const HklMatrix *self, unsigned int i, unsigned int j) HKL_ARG_NONNULL(1);
 131
 132 HKLAPI void hkl_matrix_free(HklMatrix *self) HKL_ARG_NONNULL(1);
 133
 134 HKLAPI void hkl_matrix_init(HklMatrix *self,
 135                             double m11, double m12, double m13,
 136                             double m21, double m22, double m23,
 137                             double m31, double m32, double m33) HKL_ARG_NONNULL(1);
 138
 139 HKLAPI int hkl_matrix_cmp(const HklMatrix *self, const HklMatrix *m) HKL_ARG_NONNULL(1, 2);
 140
 141 HKLAPI void hkl_matrix_times_matrix(HklMatrix *self, const HklMatrix *m) HKL_ARG_NONNULL(1, 2);
 142
 143 /********/
 144 /* Unit */
 145 /********/
 146
 147 typedef enum _HklUnitEnum
 148 {
 149         HKL_UNIT_DEFAULT,
 150         HKL_UNIT_USER
 151 } HklUnitEnum;
 152
 153 /*************/
 154 /* Parameter */
 155 /*************/
 156
 157 typedef struct _HklParameter HklParameter;
 158
 159 /* HklParameter */
 160
 161 HKLAPI HklParameter *hkl_parameter_new_copy(const HklParameter *self) HKL_ARG_NONNULL(1);
 162
 163 HKLAPI void hkl_parameter_free(HklParameter *self) HKL_ARG_NONNULL(1);
 164
 165 HKLAPI const char *hkl_parameter_name_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 166
 167 HKLAPI const char *hkl_parameter_default_unit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 168
 169 HKLAPI const char *hkl_parameter_user_unit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 170
 171 HKLAPI double hkl_parameter_value_get(const HklParameter *self,
 172                                       HklUnitEnum unit_type) HKL_ARG_NONNULL(1);
 173
 174 HKLAPI int hkl_parameter_value_set(HklParameter *self, double value,
 175                                    HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 176
 177 HKLAPI void hkl_parameter_min_max_get(const HklParameter *self, double *min, double *max,
 178                                       HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2, 3);
 179
 180 HKLAPI int hkl_parameter_min_max_set(HklParameter *self, double min, double max,
 181                                      HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 182
 183 HKLAPI int hkl_parameter_fit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 184
 185 HKLAPI void hkl_parameter_fit_set(HklParameter *self, int fit) HKL_ARG_NONNULL(1);
 186
 187 HKLAPI void hkl_parameter_randomize(HklParameter *self) HKL_ARG_NONNULL(1);
 188
 189 /* getter and setter specific to certain type of HklParameter */
 190
 191 HKLAPI const HklVector *hkl_parameter_axis_v_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 192
 193 HKLAPI const HklQuaternion *hkl_parameter_quaternion_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 194
 195 /************/
 196 /* Detector */
 197 /************/
 198
 199 typedef struct _HklDetector HklDetector;
 200 typedef enum _HklDetectorType
 201 {
 202         HKL_DETECTOR_TYPE_0D
 203 } HklDetectorType;
 204
 205 HKLAPI HklDetector *hkl_detector_factory_new(HklDetectorType type);
 206
 207 HKLAPI HklDetector *hkl_detector_new_copy(const HklDetector *src) HKL_ARG_NONNULL(1);
 208
 209 HKLAPI void hkl_detector_free(HklDetector *self) HKL_ARG_NONNULL(1);
 210
 211 HKLAPI void hkl_detector_fprintf(FILE *f, const HklDetector *self) HKL_ARG_NONNULL(1, 2);
 212
 213 /************/
 214 /* Geometry */
 215 /************/
 216
 217 typedef struct _HklGeometry HklGeometry;
 218 typedef struct _HklGeometryList HklGeometryList;
 219 typedef struct _HklGeometryListItem HklGeometryListItem;
 220
 221 /* HklGeometry */
 222
 223 HKLAPI HklGeometry *hkl_geometry_new_copy(const HklGeometry *self) HKL_ARG_NONNULL(1);
 224
 225 HKLAPI void hkl_geometry_free(HklGeometry *self) HKL_ARG_NONNULL(1);
 226
 227 HKLAPI int hkl_geometry_set(HklGeometry *self, const HklGeometry *src) HKL_ARG_NONNULL(1, 2);
 228
 229 HKLAPI const darray_string *hkl_geometry_axes_names_get(const HklGeometry *self) HKL_ARG_NONNULL(1);
 230
 231 HKLAPI const HklParameter *hkl_geometry_axis_get(const HklGeometry *self, const char *name,
 232                                                  GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 233
 234 HKLAPI int hkl_geometry_axis_set(HklGeometry *self, const char *name,
 235                                  const HklParameter *axis,
 236                                  GError **error) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT;
 237
 238 HKLAPI void hkl_geometry_axes_values_get(const HklGeometry *self,
 239                                          double values[], size_t n_values,
 240                                          HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2);
 241
 242 HKLAPI int hkl_geometry_axes_values_set(HklGeometry *self,
 243                                         double values[], size_t n_values,
 244                                         HklUnitEnum unit_type,
 245                                         GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 246
 247 HKLAPI const char *hkl_geometry_name_get(const HklGeometry *self) HKL_ARG_NONNULL(1);
 248
 249 HKLAPI double hkl_geometry_wavelength_get(const HklGeometry *self,
 250                                           HklUnitEnum unit_type) HKL_ARG_NONNULL(1);
 251
 252 HKLAPI int hkl_geometry_wavelength_set(HklGeometry *self, double wavelength,
 253                                        HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 254
 255 HKLAPI void hkl_geometry_randomize(HklGeometry *self) HKL_ARG_NONNULL(1);
 256
 257 /* TODO after bissecting it seems that this method is slow (to replace) */
 258 HKLAPI int hkl_geometry_set_values_v(HklGeometry *self, HklUnitEnum unit_type,
 259                                      GError **error, ...) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 260
 261 HKLAPI void hkl_geometry_fprintf(FILE *file, const HklGeometry *self) HKL_ARG_NONNULL(1, 2);
 262
 263 /* HklGeometryList */
 264
 265 #define HKL_GEOMETRY_LIST_FOREACH(item, list) for((item)=hkl_geometry_list_items_first_get((list)); \
 266                                                   (item);               \
 267                                                   (item)=hkl_geometry_list_items_next_get((list), (item)))
 268
 269 HKLAPI void hkl_geometry_list_free(HklGeometryList *self) HKL_ARG_NONNULL(1);
 270
 271 HKLAPI size_t hkl_geometry_list_n_items_get(const HklGeometryList *self) HKL_ARG_NONNULL(1);
 272
 273 HKLAPI const HklGeometryListItem *hkl_geometry_list_items_first_get(const HklGeometryList *self) HKL_ARG_NONNULL(1);
 274
 275 HKLAPI const HklGeometryListItem *hkl_geometry_list_items_next_get(const HklGeometryList *self,
 276                                                                    const HklGeometryListItem *item) HKL_ARG_NONNULL(1, 2);
 277
 278 /* HklGeometryListItem */
 279
 280 HKLAPI const HklGeometry *hkl_geometry_list_item_geometry_get(const HklGeometryListItem *self) HKL_ARG_NONNULL(1);
 281
 282 /**********/
 283 /* Sample */
 284 /**********/
 285
 286 typedef struct _HklLattice HklLattice;
 287 typedef struct _HklSample HklSample;
 288 typedef struct _HklSampleReflection HklSampleReflection;
 289
 290 /* Lattice */
 291
 292 HKLAPI HklLattice *hkl_lattice_new(double a, double b, double c,
 293                                    double alpha, double beta, double gamma,
 294                                    GError **error) HKL_WARN_UNUSED_RESULT;
 295
 296 HKLAPI HklLattice *hkl_lattice_new_copy(const HklLattice *self) HKL_ARG_NONNULL(1);
 297
 298 HKLAPI HklLattice *hkl_lattice_new_default(void);
 299
 300 HKLAPI void hkl_lattice_free(HklLattice *self) HKL_ARG_NONNULL(1);
 301
 302 HKLAPI const HklParameter *hkl_lattice_a_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 303
 304 HKLAPI int hkl_lattice_a_set(HklLattice *self, const HklParameter *parameter,
 305                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 306
 307 HKLAPI const HklParameter *hkl_lattice_b_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 308
 309 HKLAPI int hkl_lattice_b_set(HklLattice *self, const HklParameter *parameter,
 310                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 311
 312 HKLAPI const HklParameter *hkl_lattice_c_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 313
 314 HKLAPI int hkl_lattice_c_set(HklLattice *self, const HklParameter *parameter,
 315                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 316
 317 HKLAPI const HklParameter *hkl_lattice_alpha_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 318
 319 HKLAPI int hkl_lattice_alpha_set(HklLattice *self, const HklParameter *parameter,
 320                                  GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 321
 322 HKLAPI const HklParameter *hkl_lattice_beta_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 323
 324 HKLAPI int hkl_lattice_beta_set(HklLattice *self, const HklParameter *parameter,
 325                                 GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 326
 327 HKLAPI const HklParameter *hkl_lattice_gamma_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 328
 329 HKLAPI int hkl_lattice_gamma_set(HklLattice *self, const HklParameter *parameter,
 330                                  GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 331
 332 HKLAPI int hkl_lattice_set(HklLattice *self,
 333                            double a, double b, double c,
 334                            double alpha, double beta, double gamma,
 335                            HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 336
 337 HKLAPI void hkl_lattice_get(const HklLattice *self,
 338                             double *a, double *b, double *c,
 339                             double *alpha, double *beta, double *gamma,
 340                             HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2, 3, 4, 5, 6, 7);
 341
 342 HKLAPI int hkl_lattice_get_B(const HklLattice *self, HklMatrix *B) HKL_ARG_NONNULL(1, 2);
 343
 344 HKLAPI int hkl_lattice_get_1_B(const HklLattice *self, HklMatrix *B) HKL_ARG_NONNULL(1, 2);
 345
 346 HKLAPI int hkl_lattice_reciprocal(const HklLattice *self, HklLattice *reciprocal) HKL_ARG_NONNULL(1, 2);
 347
 348 /* HklSample */
 349
 350 HKLAPI HklSample *hkl_sample_new(const char *name) HKL_ARG_NONNULL(1);
 351
 352 HKLAPI HklSample *hkl_sample_new_copy(const HklSample *self) HKL_ARG_NONNULL(1);
 353
 354 HKLAPI void hkl_sample_free(HklSample *self) HKL_ARG_NONNULL(1);
 355
 356 HKLAPI const char *hkl_sample_name_get(const HklSample *self) HKL_ARG_NONNULL(1);
 357
 358 HKLAPI void hkl_sample_name_set(HklSample *self, const char *name) HKL_ARG_NONNULL(1, 2);
 359
 360 HKLAPI const HklLattice *hkl_sample_lattice_get(HklSample *self) HKL_ARG_NONNULL(1);
 361
 362 HKLAPI void hkl_sample_lattice_set(HklSample *self, const HklLattice *lattice) HKL_ARG_NONNULL(1, 2);
 363
 364 HKLAPI const HklParameter *hkl_sample_ux_get(const HklSample *self) HKL_ARG_NONNULL(1);
 365
 366 HKLAPI int hkl_sample_ux_set(HklSample *self, const HklParameter *ux,
 367                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 368
 369 HKLAPI const HklParameter *hkl_sample_uy_get(const HklSample *self) HKL_ARG_NONNULL(1);
 370
 371 HKLAPI int hkl_sample_uy_set(HklSample *self, const HklParameter *uy,
 372                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 373
 374 HKLAPI const HklParameter *hkl_sample_uz_get(const HklSample *self) HKL_ARG_NONNULL(1);
 375
 376 HKLAPI int hkl_sample_uz_set(HklSample *self, const HklParameter *uz,
 377                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 378
 379 HKLAPI const HklMatrix *hkl_sample_U_get(const HklSample *self) HKL_ARG_NONNULL(1);
 380
 381 HKLAPI void hkl_sample_U_set(HklSample *self, const HklMatrix *U, GError **error) HKL_ARG_NONNULL(1);
 382
 383 HKLAPI const HklMatrix *hkl_sample_UB_get(const HklSample *self) HKL_ARG_NONNULL(1);
 384
 385 HKLAPI int hkl_sample_UB_set(HklSample *self, const HklMatrix *UB,
 386                              GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 387
 388 HKLAPI size_t hkl_sample_n_reflections_get(const HklSample *self) HKL_ARG_NONNULL(1);
 389
 390 #define HKL_SAMPLE_REFLECTIONS_FOREACH(_item, _list) for((_item)=hkl_sample_reflections_first_get((_list)); \
 391                                                          (_item);       \
 392                                                          (_item)=hkl_sample_reflections_next_get((_list), (_item)))
 393
 394 HKLAPI HklSampleReflection *hkl_sample_reflections_first_get(HklSample *self) HKL_ARG_NONNULL(1);
 395
 396 HKLAPI HklSampleReflection *hkl_sample_reflections_next_get(HklSample *self,
 397                                                             HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 398
 399 HKLAPI void hkl_sample_del_reflection(HklSample *self,
 400                                       HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 401
 402 HKLAPI void hkl_sample_add_reflection(HklSample *self,
 403                                       HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 404
 405 HKLAPI int hkl_sample_compute_UB_busing_levy(HklSample *self,
 406                                              const HklSampleReflection *r1,
 407                                              const HklSampleReflection *r2,
 408                                              GError **error) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT;
 409
 410 HKLAPI double hkl_sample_get_reflection_mesured_angle(const HklSample *self,
 411                                                       const HklSampleReflection *r1,
 412                                                       const HklSampleReflection *r2) HKL_ARG_NONNULL(1, 2, 3);
 413
 414 HKLAPI double hkl_sample_get_reflection_theoretical_angle(const HklSample *self,
 415                                                           const HklSampleReflection *r1,
 416                                                           const HklSampleReflection *r2) HKL_ARG_NONNULL(1, 2, 3);
 417
 418 HKLAPI int hkl_sample_affine(HklSample *self, GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 419
 420 /* HklSampleReflection */
 421
 422 HKLAPI HklSampleReflection *hkl_sample_reflection_new(const HklGeometry *geometry,
 423                                                       const HklDetector *detector,
 424                                                       double h, double k, double l,
 425                                                       GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 426
 427 HKLAPI void hkl_sample_reflection_hkl_get(const HklSampleReflection *self,
 428                                           double *h, double *k, double *l) HKL_ARG_NONNULL(1, 2, 3, 4);
 429
 430 HKLAPI int hkl_sample_reflection_hkl_set(HklSampleReflection *self,
 431                                          double h, double k, double l,
 432                                          GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 433
 434 HKLAPI int hkl_sample_reflection_flag_get(const HklSampleReflection *self) HKL_ARG_NONNULL(1);
 435
 436 HKLAPI void hkl_sample_reflection_flag_set(HklSampleReflection *self, int flag) HKL_ARG_NONNULL(1);
 437
 438 HKLAPI const HklGeometry *hkl_sample_reflection_geometry_get(HklSampleReflection *self) HKL_ARG_NONNULL(1);
 439
 440 HKLAPI void hkl_sample_reflection_geometry_set(HklSampleReflection *self,
 441                                                const HklGeometry *geometry) HKL_ARG_NONNULL(1, 2);
 442
 443 /**************/
 444 /* PseudoAxis */
 445 /**************/
 446
 447 typedef struct _HklEngine HklEngine;
 448 typedef struct _HklEngineList HklEngineList;
 449
 450 typedef darray(HklEngine *) darray_engine;
 451
 452 /* HklEngine */
 453
 454 HKLAPI const char *hkl_engine_name_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 455
 456 HKLAPI unsigned int hkl_engine_len(const HklEngine *self) HKL_ARG_NONNULL(1);
 457
 458 HKLAPI const darray_string *hkl_engine_pseudo_axes_names_get(HklEngine *self) HKL_ARG_NONNULL(1);
 459
 460 HKLAPI int hkl_engine_pseudo_axes_values_get(HklEngine *self,
 461                                              double values[], size_t n_values,
 462                                              HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 463
 464 HKLAPI HklGeometryList *hkl_engine_pseudo_axes_values_set(HklEngine *self,
 465                                                           double values[], size_t n_values,
 466                                                           HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 467
 468 HKLAPI const HklParameter *hkl_engine_pseudo_axis_get(const HklEngine *self,
 469                                                       const char *name,
 470                                                       GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 471
 472 typedef enum _HklEngineCapabilities
 473 {
 474         HKL_ENGINE_CAPABILITIES_READABLE = 1u << 0,
 475         HKL_ENGINE_CAPABILITIES_WRITABLE = 1u << 1,
 476         HKL_ENGINE_CAPABILITIES_INITIALIZABLE = 1u << 2,
 477 } HklEngineCapabilities;
 478
 479 HKLAPI unsigned int hkl_engine_capabilities_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 480
 481 HKLAPI int hkl_engine_initialized_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 482
 483 HKLAPI int hkl_engine_initialized_set(HklEngine *self, int initialized,
 484                                       GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 485
 486 HKLAPI void hkl_engine_fprintf(FILE *f, const HklEngine *self) HKL_ARG_NONNULL(1, 2);
 487
 488 /* mode */
 489
 490 HKLAPI const darray_string *hkl_engine_modes_names_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 491
 492 HKLAPI const char *hkl_engine_current_mode_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 493
 494 HKLAPI int hkl_engine_current_mode_set(HklEngine *self, const char *name, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 495
 496 typedef enum _HklEngineAxesNamesGet
 497 {
 498         HKL_ENGINE_AXES_NAMES_GET_READ,
 499         HKL_ENGINE_AXES_NAMES_GET_WRITE,
 500 } HklEngineAxesNamesGet;
 501
 502 HKLAPI const darray_string *hkl_engine_axes_names_get(const HklEngine *self,
 503                                                       HklEngineAxesNamesGet mode) HKL_ARG_NONNULL(1);
 504
 505 HKLAPI const darray_string *hkl_engine_parameters_names_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 506
 507 HKLAPI const HklParameter *hkl_engine_parameter_get(const HklEngine *self, const char *name,
 508                                                     GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 509
 510 HKLAPI int hkl_engine_parameter_set(HklEngine *self,
 511                                     const char *name, const HklParameter *parameter,
 512                                     GError **error) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT;
 513
 514 HKLAPI void hkl_engine_parameters_values_get(const HklEngine *self,
 515                                              double values[], size_t n_values,
 516                                              HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2);
 517
 518 HKLAPI int hkl_engine_parameters_values_set(HklEngine *self,
 519                                             double values[], size_t n_values,
 520                                             HklUnitEnum unit_type, GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 521
 522 /* HklEngineList */
 523
 524 HKLAPI void hkl_engine_list_free(HklEngineList *self) HKL_ARG_NONNULL(1);
 525
 526 HKLAPI darray_engine *hkl_engine_list_engines_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 527
 528 HKLAPI HklGeometry *hkl_engine_list_geometry_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 529
 530 HKLAPI int hkl_engine_list_geometry_set(HklEngineList *self, const HklGeometry *geometry) HKL_ARG_NONNULL(1, 2);
 531
 532 HKLAPI int hkl_engine_list_select_solution(HklEngineList *self,
 533                                            const HklGeometryListItem *item) HKL_ARG_NONNULL(1);
 534
 535 HKLAPI HklEngine *hkl_engine_list_engine_get_by_name(HklEngineList *self,
 536                                                      const char *name,
 537                                                      GError **error) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT;
 538
 539 HKLAPI void hkl_engine_list_init(HklEngineList *self,
 540                                  HklGeometry *geometry,
 541                                  HklDetector *detector,
 542                                  HklSample *sample) HKL_ARG_NONNULL(1, 2, 3, 4);
 543
 544 HKLAPI int hkl_engine_list_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 545
 546 HKLAPI void hkl_engine_list_fprintf(FILE *f,
 547                                     const HklEngineList *self) HKL_ARG_NONNULL(1, 2);
 548
 549 /***********/
 550 /* Factory */
 551 /***********/
 552
 553 typedef struct _HklFactory HklFactory;
 554
 555 HKLAPI HklFactory **hkl_factory_get_all(size_t *n) HKL_ARG_NONNULL(1);
 556
 557 HKLAPI HklFactory *hkl_factory_get_by_name(const char *name,
 558                                            GError **error) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT;
 559
 560 HKLAPI const char *hkl_factory_name_get(const HklFactory *self) HKL_ARG_NONNULL(1);
 561
 562 HKLAPI HklGeometry *hkl_factory_create_new_geometry(const HklFactory *self) HKL_ARG_NONNULL(1);
 563
 564 HKLAPI HklEngineList *hkl_factory_create_new_engine_list(const HklFactory *self) HKL_ARG_NONNULL(1);
 565
 566 G_END_DECLS
 567
 568 #endif