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-2013 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 <hkl/ccan/darray/darray.h>     // for darray
  29
  30 /* Guard C code in headers, while including them from C++ */
  31 #ifdef __cplusplus
  32 # define HKL_BEGIN_DECLS  extern "C" {
  33 # define HKL_END_DECLS    }
  34 #else
  35 # define HKL_BEGIN_DECLS
  36 # define HKL_END_DECLS
  37 #endif
  38
  39 /* deprecated */
  40 #if    __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1)
  41 # define HKL_DEPRECATED __attribute__((__deprecated__))
  42 #elif defined(_MSC_VER) && (_MSC_VER >= 1300)
  43 # define HKL_DEPRECATED __declspec(deprecated)
  44 #else
  45 # define HKL_DEPRECATED
  46 #endif
  47
  48 #if    __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
  49 # define HKL_DEPRECATED_FOR(f) __attribute__((__deprecated__("Use '" #f "' instead")))
  50 #elif defined(_MSC_FULL_VER) && (_MSC_FULL_VER > 140050320)
  51 # define HKL_DEPRECATED_FOR(f) __declspec(deprecated("is deprecated. Use '" #f "' instead"))
  52 #else
  53 # define HKL_DEPRECATED_FOR(f) HKL_DEPRECATED
  54 #endif
  55
  56 #define HKL_TRUE 1
  57 #define HKL_FALSE 0
  58
  59 #define HKL_TINY 1e-7
  60 #define HKL_EPSILON 1e-6
  61 #define HKL_DEGTORAD (M_PI/180.)
  62 #define HKL_RADTODEG (180./M_PI)
  63
  64 /* tau = 2pi or 1 */
  65 #define HKL_TAU (2. * M_PI)
  66 /* #define HKL_TAU 1 */
  67
  68 #ifdef HKLAPI
  69 # undef HKLEAPI
  70 #endif
  71
  72 #ifdef __GNUC__
  73 # if __GNUC__ >= 4
  74 #  define HKLAPI __attribute__ ((visibility("default")))
  75 # else
  76 #  define HKLAPI
  77 # endif
  78 #else
  79 /**
  80  * @def HKLAPI
  81  * @brief Used to export functions(by changing visibility).
  82  */
  83 # define HKLAPI
  84 #endif
  85
  86 #if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
  87 # define HKL_ARG_NONNULL(...) __attribute__ ((__nonnull__(__VA_ARGS__)))
  88 #else
  89 # define HKL_ARG_NONNULL(...)
  90 #endif
  91
  92 #define _darray(type) type *item; size_t size; size_t alloc
  93
  94 HKL_BEGIN_DECLS
  95
  96 /**********/
  97 /* Matrix */
  98 /**********/
  99
 100 typedef struct _HklMatrix HklMatrix;
 101
 102 HKLAPI HklMatrix *hkl_matrix_new(void);
 103
 104 HKLAPI HklMatrix *hkl_matrix_new_full(double m11, double m12, double m13,
 105                                       double m21, double m22, double m23,
 106                                       double m31, double m32, double m33);
 107
 108 HKLAPI HklMatrix *hkl_matrix_new_euler(double euler_x, double euler_y, double euler_z);
 109
 110 HKLAPI double hkl_matrix_get(const HklMatrix *self, unsigned int i, unsigned int j) HKL_ARG_NONNULL(1);
 111
 112 HKLAPI void hkl_matrix_free(HklMatrix *self) HKL_ARG_NONNULL(1);
 113
 114 HKLAPI void hkl_matrix_init(HklMatrix *self,
 115                             double m11, double m12, double m13,
 116                             double m21, double m22, double m23,
 117                             double m31, double m32, double m33) HKL_ARG_NONNULL(1);
 118
 119 HKLAPI int hkl_matrix_cmp(const HklMatrix *self, const HklMatrix *m) HKL_ARG_NONNULL(1, 2);
 120
 121 HKLAPI void hkl_matrix_times_matrix(HklMatrix *self, const HklMatrix *m) HKL_ARG_NONNULL(1, 2);
 122
 123 /*********/
 124 /* Error */
 125 /*********/
 126
 127 typedef struct _HklError HklError;
 128
 129 HKLAPI const char *hkl_error_message_get(const HklError *self) HKL_ARG_NONNULL(1);
 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 double hkl_parameter_value_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 146
 147 HKLAPI int hkl_parameter_value_set(HklParameter *self, double value,
 148                                    HklError **error) HKL_ARG_NONNULL(1);
 149
 150 HKLAPI double hkl_parameter_value_unit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 151
 152 HKLAPI int hkl_parameter_value_unit_set(HklParameter *self, double value,
 153                                         HklError **error) HKL_ARG_NONNULL(1);
 154
 155 HKLAPI void hkl_parameter_min_max_get(const HklParameter *self, double *min, double *max) HKL_ARG_NONNULL(1, 2, 3);
 156
 157 HKLAPI void hkl_parameter_min_max_set(HklParameter *self, double min, double max) HKL_ARG_NONNULL(1);
 158
 159 HKLAPI void hkl_parameter_min_max_unit_get(const HklParameter *self, double *min, double *max) HKL_ARG_NONNULL(1, 2, 3);
 160
 161 HKLAPI void hkl_parameter_min_max_unit_set(HklParameter *self, double min, double max) HKL_ARG_NONNULL(1);
 162
 163 HKLAPI int hkl_parameter_fit_get(const HklParameter *self) HKL_ARG_NONNULL(1);
 164
 165 HKLAPI void hkl_parameter_fit_set(HklParameter *self, int fit) HKL_ARG_NONNULL(1);
 166
 167 HKLAPI void hkl_parameter_randomize(HklParameter *self) HKL_ARG_NONNULL(1);
 168
 169 /************/
 170 /* Detector */
 171 /************/
 172
 173 typedef struct _HklDetector HklDetector;
 174 typedef enum _HklDetectorType
 175 {
 176         HKL_DETECTOR_TYPE_0D
 177 } HklDetectorType;
 178
 179 HKLAPI void hkl_detector_free(HklDetector *self) HKL_ARG_NONNULL(1);
 180
 181 HKLAPI void hkl_detector_idx_set(HklDetector *self, int idx) HKL_ARG_NONNULL(1);
 182
 183 HKLAPI void hkl_detector_fprintf(FILE *f, const HklDetector *self) HKL_ARG_NONNULL(1, 2);
 184
 185 HKLAPI HklDetector *hkl_detector_factory_new(HklDetectorType type);
 186
 187 /************/
 188 /* Geometry */
 189 /************/
 190
 191 typedef struct _HklGeometry HklGeometry;
 192 typedef struct _HklGeometryList HklGeometryList;
 193 typedef struct _HklGeometryListItem HklGeometryListItem;
 194
 195 /* HklGeometry */
 196
 197 HKLAPI void hkl_geometry_free(HklGeometry *self) HKL_ARG_NONNULL(1);
 198
 199 HKLAPI void hkl_geometry_set(HklGeometry *self, const HklGeometry *src) HKL_ARG_NONNULL(1, 2);
 200
 201 HKLAPI const HklParameter *hkl_geometry_axis_get(const HklGeometry *self, const char *name) HKL_ARG_NONNULL(1, 2);
 202
 203 HKLAPI void hkl_geometry_axis_set(HklGeometry *self, const HklParameter *axis) HKL_ARG_NONNULL(1, 2);
 204
 205 HKLAPI const char *hkl_geometry_name_get(const HklGeometry *self) HKL_ARG_NONNULL(1);
 206
 207 HKLAPI double hkl_geometry_wavelength_get(const HklGeometry *self) HKL_ARG_NONNULL(1);
 208
 209 HKLAPI void hkl_geometry_wavelength_set(HklGeometry *self, double wavelength) HKL_ARG_NONNULL(1);
 210
 211 HKLAPI void hkl_geometry_randomize(HklGeometry *self) HKL_ARG_NONNULL(1);
 212
 213 HKLAPI int hkl_geometry_set_values_unit_v(HklGeometry *self, ...) HKL_ARG_NONNULL(1);
 214
 215 HKLAPI void hkl_geometry_fprintf(FILE *file, const HklGeometry *self) HKL_ARG_NONNULL(1, 2);
 216
 217 /* HklGeometryList */
 218
 219 #define HKL_GEOMETRY_LIST_FOREACH(item, list) for((item)=hkl_geometry_list_items_first_get((list)); \
 220                                                   (item);               \
 221                                                   (item)=hkl_geometry_list_items_next_get((list), (item)))
 222
 223 HKLAPI size_t hkl_geometry_list_n_items_get(const HklGeometryList *self) HKL_ARG_NONNULL(1);
 224
 225 HKLAPI const HklGeometryListItem *hkl_geometry_list_items_first_get(const HklGeometryList *self) HKL_ARG_NONNULL(1);
 226
 227 HKLAPI const HklGeometryListItem *hkl_geometry_list_items_next_get(const HklGeometryList *self,
 228                                                                    const HklGeometryListItem *item) HKL_ARG_NONNULL(1, 2);
 229
 230 /* HklGeometryListItem */
 231
 232 HKLAPI const HklGeometry *hkl_geometry_list_item_geometry_get(const HklGeometryListItem *self) HKL_ARG_NONNULL(1);
 233
 234 /**********/
 235 /* Sample */
 236 /**********/
 237
 238 typedef struct _HklLattice HklLattice;
 239 typedef struct _HklSample HklSample;
 240 typedef struct _HklSampleReflection HklSampleReflection;
 241
 242 /* Lattice */
 243
 244 HKLAPI HklLattice *hkl_lattice_new(double a, double b, double c,
 245                                    double alpha, double beta, double gamma);
 246
 247 HKLAPI HklLattice *hkl_lattice_new_copy(const HklLattice *self) HKL_ARG_NONNULL(1);
 248
 249 HKLAPI HklLattice *hkl_lattice_new_default(void);
 250
 251 HKLAPI void hkl_lattice_free(HklLattice *self) HKL_ARG_NONNULL(1);
 252
 253 HKLAPI const HklParameter *hkl_lattice_a_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 254
 255 HKLAPI void hkl_lattice_a_set(HklLattice *self, const HklParameter *parameter) HKL_ARG_NONNULL(1, 2);
 256
 257 HKLAPI const HklParameter *hkl_lattice_b_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 258
 259 HKLAPI void hkl_lattice_b_set(HklLattice *self, const HklParameter *parameter) HKL_ARG_NONNULL(1, 2);
 260
 261 HKLAPI const HklParameter *hkl_lattice_c_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 262
 263 HKLAPI void hkl_lattice_c_set(HklLattice *self, const HklParameter *parameter) HKL_ARG_NONNULL(1, 2);
 264
 265 HKLAPI const HklParameter *hkl_lattice_alpha_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 266
 267 HKLAPI void hkl_lattice_alpha_set(HklLattice *self, const HklParameter *parameter) HKL_ARG_NONNULL(1, 2);
 268
 269 HKLAPI const HklParameter *hkl_lattice_beta_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 270
 271 HKLAPI void hkl_lattice_beta_set(HklLattice *self, const HklParameter *parameter) HKL_ARG_NONNULL(1, 2);
 272
 273 HKLAPI const HklParameter *hkl_lattice_gamma_get(const HklLattice *self) HKL_ARG_NONNULL(1);
 274
 275 HKLAPI void hkl_lattice_gamma_set(HklLattice *self, const HklParameter *parameter) HKL_ARG_NONNULL(1, 2);
 276
 277 HKLAPI int hkl_lattice_set(HklLattice *self,
 278                            double a, double b, double c,
 279                            double alpha, double beta, double gamma) HKL_ARG_NONNULL(1);
 280
 281 HKLAPI void hkl_lattice_get(const HklLattice *self,
 282                             double *a, double *b, double *c,
 283                             double *alpha, double *beta, double *gamma) HKL_ARG_NONNULL(1, 2, 3, 4, 5, 6, 7);
 284
 285 HKLAPI int hkl_lattice_get_B(const HklLattice *self, HklMatrix *B) HKL_ARG_NONNULL(1, 2);
 286
 287 HKLAPI int hkl_lattice_get_1_B(const HklLattice *self, HklMatrix *B) HKL_ARG_NONNULL(1, 2);
 288
 289 HKLAPI int hkl_lattice_reciprocal(const HklLattice *self, HklLattice *reciprocal) HKL_ARG_NONNULL(1, 2);
 290
 291 /* HklSample */
 292
 293 HKLAPI HklSample *hkl_sample_new(const char *name) HKL_ARG_NONNULL(1);
 294
 295 HKLAPI HklSample *hkl_sample_new_copy(const HklSample *self) HKL_ARG_NONNULL(1);
 296
 297 HKLAPI void hkl_sample_free(HklSample *self) HKL_ARG_NONNULL(1);
 298
 299 HKLAPI const char *hkl_sample_name_get(const HklSample *self) HKL_ARG_NONNULL(1);
 300
 301 HKLAPI void hkl_sample_name_set(HklSample *self, const char *name) HKL_ARG_NONNULL(1, 2);
 302
 303 HKLAPI const HklLattice *hkl_sample_lattice_get(HklSample *self) HKL_ARG_NONNULL(1);
 304
 305 HKLAPI void hkl_sample_lattice_set(HklSample *self, const HklLattice *lattice) HKL_ARG_NONNULL(1, 2);
 306
 307 HKLAPI const HklParameter *hkl_sample_ux_get(const HklSample *self) HKL_ARG_NONNULL(1);
 308
 309 HKLAPI void hkl_sample_ux_set(HklSample *self, const HklParameter *ux) HKL_ARG_NONNULL(1, 2);
 310
 311 HKLAPI const HklParameter *hkl_sample_uy_get(const HklSample *self) HKL_ARG_NONNULL(1);
 312
 313 HKLAPI void hkl_sample_uy_set(HklSample *self, const HklParameter *uy) HKL_ARG_NONNULL(1, 2);
 314
 315 HKLAPI const HklParameter *hkl_sample_uz_get(const HklSample *self) HKL_ARG_NONNULL(1);
 316
 317 HKLAPI void hkl_sample_uz_set(HklSample *self, const HklParameter *uz) HKL_ARG_NONNULL(1, 2);
 318
 319 HKLAPI const HklMatrix *hkl_sample_U_get(const HklSample *self) HKL_ARG_NONNULL(1);
 320
 321 HKLAPI void hkl_sample_U_set(HklSample *self, const HklMatrix *U) HKL_ARG_NONNULL(1);
 322
 323 HKLAPI const HklMatrix *hkl_sample_UB_get(const HklSample *self) HKL_ARG_NONNULL(1);
 324
 325 HKLAPI double hkl_sample_UB_set(HklSample *self, const HklMatrix *UB) HKL_ARG_NONNULL(1, 2);
 326
 327 HKLAPI HklSampleReflection *hkl_sample_first_reflection_get(HklSample *self) HKL_ARG_NONNULL(1);
 328
 329 HKLAPI HklSampleReflection *hkl_sample_next_reflection_get(HklSample *self,
 330                                                            HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 331
 332 HKLAPI void hkl_sample_del_reflection(HklSample *self,
 333                                       HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 334
 335 HKLAPI void hkl_sample_add_reflection(HklSample *self,
 336                                       HklSampleReflection *reflection) HKL_ARG_NONNULL(1, 2);
 337
 338 HKLAPI int hkl_sample_compute_UB_busing_levy(HklSample *self,
 339                                              const HklSampleReflection *r1,
 340                                              const HklSampleReflection *r2) HKL_ARG_NONNULL(1, 2, 3);
 341
 342 HKLAPI double hkl_sample_get_reflection_mesured_angle(const HklSample *self,
 343                                                       const HklSampleReflection *r1,
 344                                                       const HklSampleReflection *r2) HKL_ARG_NONNULL(1, 2, 3);
 345
 346 HKLAPI double hkl_sample_get_reflection_theoretical_angle(const HklSample *self,
 347                                                           const HklSampleReflection *r1,
 348                                                           const HklSampleReflection *r2) HKL_ARG_NONNULL(1, 2, 3);
 349
 350 HKLAPI double hkl_sample_affine(HklSample *self) HKL_ARG_NONNULL(1);
 351
 352 /* hklSampleReflection */
 353
 354 HKLAPI HklSampleReflection *hkl_sample_reflection_new(const HklGeometry *geometry,
 355                                                       const HklDetector *detector,
 356                                                       double h, double k, double l) HKL_ARG_NONNULL(1, 2);
 357
 358 HKLAPI void hkl_sample_reflection_hkl_get(const HklSampleReflection *self,
 359                                           double *h, double *k, double *l) HKL_ARG_NONNULL(1, 2, 3, 4);
 360
 361 HKLAPI void hkl_sample_reflection_hkl_set(HklSampleReflection *self,
 362                                           double h, double k, double l) HKL_ARG_NONNULL(1);
 363
 364 HKLAPI int hkl_sample_reflection_flag_get(const HklSampleReflection *self) HKL_ARG_NONNULL(1);
 365
 366 HKLAPI void hkl_sample_reflection_flag_set(HklSampleReflection *self, int flag) HKL_ARG_NONNULL(1);
 367
 368 HKLAPI const HklGeometry *hkl_sample_reflection_geometry_get(HklSampleReflection *self) HKL_ARG_NONNULL(1);
 369
 370 HKLAPI void hkl_sample_reflection_geometry_set(HklSampleReflection *self,
 371                                                const HklGeometry *geometry) HKL_ARG_NONNULL(1, 2);
 372
 373 /**************/
 374 /* PseudoAxis */
 375 /**************/
 376
 377 typedef struct _HklPseudoAxis HklPseudoAxis;
 378 typedef struct _HklEngine HklEngine;
 379 typedef struct _HklEngineList HklEngineList;
 380
 381 typedef darray(const char *) darray_string;
 382 typedef darray(HklEngine *) darray_engine;
 383
 384 /* HklEngine */
 385
 386 HKLAPI const char *hkl_engine_name_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 387
 388 HKLAPI unsigned int hkl_engine_len(const HklEngine *self) HKL_ARG_NONNULL(1);
 389
 390 HKLAPI const darray_string *hkl_engine_pseudo_axes_names_get(HklEngine *self) HKL_ARG_NONNULL(1);
 391
 392 HKLAPI void hkl_engine_pseudo_axes_values_get(HklEngine *self,
 393                                               double values[], size_t n_values) HKL_ARG_NONNULL(1, 2);
 394
 395 HKLAPI unsigned int hkl_engine_pseudo_axes_values_set(HklEngine *self,
 396                                                       double values[], size_t n_values,
 397                                                       HklError **error) HKL_ARG_NONNULL(1, 2);
 398
 399 HKLAPI void hkl_engine_pseudo_axes_randomize(HklEngine *self) HKL_ARG_NONNULL(1);
 400
 401 HKLAPI const HklParameter *hkl_engine_pseudo_axis_get(const HklEngine *self,
 402                                                       const char *name) HKL_ARG_NONNULL(1, 2);
 403
 404 HKLAPI unsigned int hkl_engine_pseudo_axis_set(HklEngine *self,
 405                                                const HklParameter *parameter,
 406                                                HklError **error) HKL_ARG_NONNULL(1, 2);
 407
 408 HKLAPI const darray_string *hkl_engine_modes_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 409
 410 HKLAPI void hkl_engine_select_mode(HklEngine *self,
 411                                    const char *name) HKL_ARG_NONNULL(1, 2);
 412
 413 HKLAPI const darray_string *hkl_engine_parameters_get(const HklEngine *self) HKL_ARG_NONNULL(1);
 414
 415 HKLAPI unsigned int hkl_engine_parameters_set(HklEngine *self,
 416                                               double values[], size_t n_values,
 417                                               HklError **error) HKL_ARG_NONNULL(1, 2);
 418
 419 HKLAPI void hkl_engine_parameters_randomize(HklEngine *self) HKL_ARG_NONNULL(1);
 420
 421 HKLAPI const HklParameter *hkl_engine_parameter_get(const HklEngine *self,
 422                                                     const char *name) HKL_ARG_NONNULL(1, 2);
 423
 424 HKLAPI void hkl_engine_parameter_set(HklEngine *self,
 425                                      const HklParameter *parameter) HKL_ARG_NONNULL(1, 2);
 426
 427 HKLAPI HklEngineList *hkl_engine_engines_get(HklEngine *self) HKL_ARG_NONNULL(1);
 428
 429 HKLAPI int hkl_engine_initialize(HklEngine *self, HklError **error) HKL_ARG_NONNULL(1);
 430
 431 HKLAPI int hkl_engine_set(HklEngine *self, HklError **error) HKL_ARG_NONNULL(1);
 432
 433 HKLAPI int hkl_engine_get(HklEngine *self, HklError **error) HKL_ARG_NONNULL(1);
 434
 435 HKLAPI void hkl_engine_fprintf(FILE *f, const HklEngine *self) HKL_ARG_NONNULL(1, 2);
 436
 437 /* HklEngineList */
 438
 439 HKLAPI void hkl_engine_list_free(HklEngineList *self) HKL_ARG_NONNULL(1);
 440
 441 HKLAPI darray_engine *hkl_engine_list_engines_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 442
 443 HKLAPI HklGeometry *hkl_engine_list_geometry_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 444
 445 HKLAPI void hkl_engine_list_geometry_set(HklEngineList *self, const HklGeometry *geometry) HKL_ARG_NONNULL(1, 2);
 446
 447 HKLAPI const HklGeometryList *hkl_engine_list_geometries_get(const HklEngineList *self) HKL_ARG_NONNULL(1);
 448
 449 HKLAPI void hkl_engine_list_select_solution(HklEngineList *self,
 450                                             const HklGeometryListItem *item) HKL_ARG_NONNULL(1);
 451
 452 HKLAPI HklEngine *hkl_engine_list_engine_get_by_name(HklEngineList *self,
 453                                               const char *name) HKL_ARG_NONNULL(1, 2);
 454
 455 HKLAPI HklParameter *hkl_engine_list_pseudo_axis_get_by_name(const HklEngineList *self,
 456                                                              const char *name) HKL_ARG_NONNULL(1, 2);
 457
 458 HKLAPI void hkl_engine_list_init(HklEngineList *self,
 459                                  HklGeometry *geometry,
 460                                  HklDetector *detector,
 461                                  HklSample *sample) HKL_ARG_NONNULL(1, 2, 3, 4);
 462
 463 HKLAPI int hkl_engine_list_get(HklEngineList *self) HKL_ARG_NONNULL(1);
 464
 465 HKLAPI void hkl_engine_list_fprintf(FILE *f,
 466                                     const HklEngineList *self) HKL_ARG_NONNULL(1, 2);
 467
 468 /***********/
 469 /* Factory */
 470 /***********/
 471
 472 typedef struct _HklFactory HklFactory;
 473
 474 HKLAPI HklFactory **hkl_factory_get_all(unsigned int *n) HKL_ARG_NONNULL(1);
 475
 476 HKLAPI HklFactory *hkl_factory_get_by_name(const char *name) HKL_ARG_NONNULL(1);
 477
 478 HKLAPI const char *hkl_factory_name(const HklFactory *self) HKL_ARG_NONNULL(1);
 479
 480 HKLAPI const char **hkl_factory_axes_get(const HklFactory *self,
 481                                          size_t *length) HKL_ARG_NONNULL(1, 2);
 482
 483 HKLAPI HklGeometry *hkl_factory_create_new_geometry(const HklFactory *self) HKL_ARG_NONNULL(1);
 484
 485 HKLAPI HklEngineList *hkl_factory_create_new_engine_list(const HklFactory *self) HKL_ARG_NONNULL(1);
 486
 487 HKL_END_DECLS
 488
 489 #endif