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