hkl.h

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