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