1 /* This file is part of the hkl library.
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.
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.
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/>.
16 * Copyright (C) 2003-2017 Synchrotron SOLEIL
17 * L'Orme des Merisiers Saint-Aubin
18 * BP 48 91192 GIF-sur-YVETTE CEDEX
20 * Authors: Picca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>
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
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)
37 # define HKL_DEPRECATED
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"))
45 # define HKL_DEPRECATED_FOR(f) HKL_DEPRECATED
49 #define HKL_EPSILON 1e-6
50 #define HKL_DEGTORAD (M_PI/180.)
51 #define HKL_RADTODEG (180./M_PI)
54 #define HKL_TAU (2. * M_PI)
55 /* #define HKL_TAU 1 */
63 # define HKLAPI __attribute__ ((visibility("default")))
70 * @brief Used to export functions(by changing visibility).
75 #if (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3))
76 # define HKL_ARG_NONNULL(...) __attribute__ ((__nonnull__(__VA_ARGS__)))
78 # define HKL_ARG_NONNULL(...)
81 # if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)
82 # define HKL_WARN_UNUSED_RESULT __attribute__ ((__warn_unused_result__))
84 # define HKL_WARN_UNUSED_RESULT
88 #define _darray(type) type *item; size_t size; size_t alloc
96 typedef struct _HklVector HklVector
;
103 #define HKL_VECTOR_X {{1, 0, 0}}
104 #define HKL_VECTOR_Y {{0, 1, 0}}
105 #define HKL_VECTOR_Z {{0, 0, 1}}
107 HKLAPI
void hkl_vector_init(HklVector
*self
, double x
, double y
, double z
);
113 typedef struct _HklQuaternion HklQuaternion
;
114 typedef struct _HklMatrix HklMatrix
; /* forwarded declaration */
116 struct _HklQuaternion
121 typedef darray(const char *) darray_string
;
123 HKLAPI
void hkl_quaternion_to_matrix(const HklQuaternion
*self
, HklMatrix
*m
) HKL_ARG_NONNULL(1, 2);
129 HKLAPI HklMatrix
*hkl_matrix_new(void) HKL_WARN_UNUSED_RESULT
;
131 HKLAPI HklMatrix
*hkl_matrix_new_full(double m11
, double m12
, double m13
,
132 double m21
, double m22
, double m23
,
133 double m31
, double m32
, double m33
) HKL_WARN_UNUSED_RESULT
;
135 HKLAPI HklMatrix
*hkl_matrix_new_euler(double euler_x
, double euler_y
, double euler_z
) HKL_WARN_UNUSED_RESULT
;
137 HKLAPI
double hkl_matrix_get(const HklMatrix
*self
, unsigned int i
, unsigned int j
) HKL_ARG_NONNULL(1);
139 HKLAPI
void hkl_matrix_free(HklMatrix
*self
) HKL_ARG_NONNULL(1);
141 HKLAPI
void hkl_matrix_init(HklMatrix
*self
,
142 double m11
, double m12
, double m13
,
143 double m21
, double m22
, double m23
,
144 double m31
, double m32
, double m33
) HKL_ARG_NONNULL(1);
146 HKLAPI
int hkl_matrix_cmp(const HklMatrix
*self
, const HklMatrix
*m
) HKL_ARG_NONNULL(1, 2);
148 HKLAPI
void hkl_matrix_times_matrix(HklMatrix
*self
, const HklMatrix
*m
) HKL_ARG_NONNULL(1, 2);
154 typedef enum _HklUnitEnum
164 typedef struct _HklParameter HklParameter
;
168 HKLAPI HklParameter
*hkl_parameter_new_copy(const HklParameter
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
170 HKLAPI
void hkl_parameter_free(HklParameter
*self
) HKL_ARG_NONNULL(1);
172 HKLAPI
const char *hkl_parameter_name_get(const HklParameter
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
174 HKLAPI
const char *hkl_parameter_default_unit_get(const HklParameter
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
176 HKLAPI
const char *hkl_parameter_user_unit_get(const HklParameter
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
178 HKLAPI
double hkl_parameter_value_get(const HklParameter
*self
,
179 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1);
181 HKLAPI
int hkl_parameter_value_set(HklParameter
*self
, double value
,
182 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
184 HKLAPI
void hkl_parameter_min_max_get(const HklParameter
*self
, double *min
, double *max
,
185 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2, 3);
187 HKLAPI
int hkl_parameter_min_max_set(HklParameter
*self
, double min
, double max
,
188 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
190 HKLAPI
int hkl_parameter_fit_get(const HklParameter
*self
) HKL_ARG_NONNULL(1);
192 HKLAPI
void hkl_parameter_fit_set(HklParameter
*self
, int fit
) HKL_ARG_NONNULL(1);
194 HKLAPI
void hkl_parameter_randomize(HklParameter
*self
) HKL_ARG_NONNULL(1);
196 /* getter and setter specific to certain type of HklParameter */
198 HKLAPI
const HklVector
*hkl_parameter_axis_v_get(const HklParameter
*self
) HKL_ARG_NONNULL(1)HKL_WARN_UNUSED_RESULT
;
200 HKLAPI
const HklQuaternion
*hkl_parameter_quaternion_get(const HklParameter
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
202 HKLAPI
const char *hkl_parameter_description_get(const HklParameter
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
208 typedef struct _HklDetector HklDetector
;
209 typedef enum _HklDetectorType
214 HKLAPI HklDetector
*hkl_detector_factory_new(HklDetectorType type
) HKL_WARN_UNUSED_RESULT
;
216 HKLAPI HklDetector
*hkl_detector_new_copy(const HklDetector
*src
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
218 HKLAPI
void hkl_detector_free(HklDetector
*self
) HKL_ARG_NONNULL(1);
220 HKLAPI
void hkl_detector_fprintf(FILE *f
, const HklDetector
*self
) HKL_ARG_NONNULL(1, 2);
226 typedef struct _HklGeometry HklGeometry
;
227 typedef struct _HklGeometryList HklGeometryList
;
228 typedef struct _HklGeometryListItem HklGeometryListItem
;
229 typedef struct _HklSample HklSample
; /* forwarded declaration */
233 HKLAPI HklGeometry
*hkl_geometry_new_copy(const HklGeometry
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
235 HKLAPI
void hkl_geometry_free(HklGeometry
*self
) HKL_ARG_NONNULL(1);
237 HKLAPI
int hkl_geometry_set(HklGeometry
*self
, const HklGeometry
*src
) HKL_ARG_NONNULL(1, 2);
239 HKLAPI
const darray_string
*hkl_geometry_axis_names_get(const HklGeometry
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
241 HKLAPI
const HklParameter
*hkl_geometry_axis_get(const HklGeometry
*self
, const char *name
,
242 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
244 HKLAPI
int hkl_geometry_axis_set(HklGeometry
*self
, const char *name
,
245 const HklParameter
*axis
,
246 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
248 HKLAPI
void hkl_geometry_axis_values_get(const HklGeometry
*self
,
249 double values
[], size_t n_values
,
250 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2);
252 HKLAPI
int hkl_geometry_axis_values_set(HklGeometry
*self
,
253 double values
[], size_t n_values
,
254 HklUnitEnum unit_type
,
255 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
257 HKLAPI
const char *hkl_geometry_name_get(const HklGeometry
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
259 HKLAPI
double hkl_geometry_wavelength_get(const HklGeometry
*self
,
260 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1);
262 HKLAPI
int hkl_geometry_wavelength_set(HklGeometry
*self
, double wavelength
,
263 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
265 HKLAPI
void hkl_geometry_randomize(HklGeometry
*self
) HKL_ARG_NONNULL(1);
267 /* TODO after bissecting it seems that this method is slow (to replace) */
268 HKLAPI
int hkl_geometry_set_values_v(HklGeometry
*self
, HklUnitEnum unit_type
,
269 GError
**error
, ...) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
271 HKLAPI HklQuaternion
hkl_geometry_sample_rotation_get(const HklGeometry
*self
,
272 const HklSample
*sample
) HKL_ARG_NONNULL(1, 2);
274 HKLAPI HklQuaternion
hkl_geometry_detector_rotation_get(const HklGeometry
*self
,
275 const HklDetector
*detector
) HKL_ARG_NONNULL(1, 2);
277 HKLAPI
void hkl_geometry_fprintf(FILE *file
, const HklGeometry
*self
) HKL_ARG_NONNULL(1, 2);
279 /* HklGeometryList */
281 #define HKL_GEOMETRY_LIST_FOREACH(item, list) for((item)=hkl_geometry_list_items_first_get((list)); \
283 (item)=hkl_geometry_list_items_next_get((list), (item)))
285 HKLAPI
void hkl_geometry_list_free(HklGeometryList
*self
) HKL_ARG_NONNULL(1);
287 HKLAPI
size_t hkl_geometry_list_n_items_get(const HklGeometryList
*self
) HKL_ARG_NONNULL(1);
289 HKLAPI
const HklGeometryListItem
*hkl_geometry_list_items_first_get(const HklGeometryList
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
291 HKLAPI
const HklGeometryListItem
*hkl_geometry_list_items_next_get(const HklGeometryList
*self
,
292 const HklGeometryListItem
*item
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
294 /* HklGeometryListItem */
296 HKLAPI
const HklGeometry
*hkl_geometry_list_item_geometry_get(const HklGeometryListItem
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
302 typedef struct _HklLattice HklLattice
;
303 typedef struct _HklSampleReflection HklSampleReflection
;
307 HKLAPI HklLattice
*hkl_lattice_new(double a
, double b
, double c
,
308 double alpha
, double beta
, double gamma
,
309 GError
**error
) HKL_WARN_UNUSED_RESULT
;
311 HKLAPI HklLattice
*hkl_lattice_new_copy(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
313 HKLAPI HklLattice
*hkl_lattice_new_default(void) HKL_WARN_UNUSED_RESULT
;
315 HKLAPI
void hkl_lattice_free(HklLattice
*self
) HKL_ARG_NONNULL(1);
317 HKLAPI
const HklParameter
*hkl_lattice_a_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
319 HKLAPI
int hkl_lattice_a_set(HklLattice
*self
, const HklParameter
*parameter
,
320 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
322 HKLAPI
const HklParameter
*hkl_lattice_b_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
324 HKLAPI
int hkl_lattice_b_set(HklLattice
*self
, const HklParameter
*parameter
,
325 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
327 HKLAPI
const HklParameter
*hkl_lattice_c_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
329 HKLAPI
int hkl_lattice_c_set(HklLattice
*self
, const HklParameter
*parameter
,
330 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
332 HKLAPI
const HklParameter
*hkl_lattice_alpha_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
334 HKLAPI
int hkl_lattice_alpha_set(HklLattice
*self
, const HklParameter
*parameter
,
335 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
337 HKLAPI
const HklParameter
*hkl_lattice_beta_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
339 HKLAPI
int hkl_lattice_beta_set(HklLattice
*self
, const HklParameter
*parameter
,
340 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
342 HKLAPI
const HklParameter
*hkl_lattice_gamma_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
344 HKLAPI
int hkl_lattice_gamma_set(HklLattice
*self
, const HklParameter
*parameter
,
345 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
347 HKLAPI
const HklParameter
*hkl_lattice_volume_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
349 HKLAPI
int hkl_lattice_set(HklLattice
*self
,
350 double a
, double b
, double c
,
351 double alpha
, double beta
, double gamma
,
352 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
354 HKLAPI
void hkl_lattice_get(const HklLattice
*self
,
355 double *a
, double *b
, double *c
,
356 double *alpha
, double *beta
, double *gamma
,
357 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2, 3, 4, 5, 6, 7);
359 HKLAPI
int hkl_lattice_get_B(const HklLattice
*self
, HklMatrix
*B
) HKL_ARG_NONNULL(1, 2);
361 HKLAPI
int hkl_lattice_get_1_B(const HklLattice
*self
, HklMatrix
*B
) HKL_ARG_NONNULL(1, 2);
363 HKLAPI
int hkl_lattice_reciprocal(const HklLattice
*self
, HklLattice
*reciprocal
) HKL_ARG_NONNULL(1, 2);
367 HKLAPI HklSample
*hkl_sample_new(const char *name
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
369 HKLAPI HklSample
*hkl_sample_new_copy(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
371 HKLAPI
void hkl_sample_free(HklSample
*self
) HKL_ARG_NONNULL(1);
373 HKLAPI
const char *hkl_sample_name_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
375 HKLAPI
void hkl_sample_name_set(HklSample
*self
, const char *name
) HKL_ARG_NONNULL(1, 2);
377 HKLAPI
const HklLattice
*hkl_sample_lattice_get(HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
379 HKLAPI
void hkl_sample_lattice_set(HklSample
*self
, const HklLattice
*lattice
) HKL_ARG_NONNULL(1, 2);
381 HKLAPI
const HklParameter
*hkl_sample_ux_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
383 HKLAPI
int hkl_sample_ux_set(HklSample
*self
, const HklParameter
*ux
,
384 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
386 HKLAPI
const HklParameter
*hkl_sample_uy_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
388 HKLAPI
int hkl_sample_uy_set(HklSample
*self
, const HklParameter
*uy
,
389 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
391 HKLAPI
const HklParameter
*hkl_sample_uz_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
393 HKLAPI
int hkl_sample_uz_set(HklSample
*self
, const HklParameter
*uz
,
394 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
396 HKLAPI
const HklMatrix
*hkl_sample_U_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
398 HKLAPI
void hkl_sample_U_set(HklSample
*self
, const HklMatrix
*U
, GError
**error
) HKL_ARG_NONNULL(1);
400 HKLAPI
const HklMatrix
*hkl_sample_UB_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
402 HKLAPI
int hkl_sample_UB_set(HklSample
*self
, const HklMatrix
*UB
,
403 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
405 HKLAPI
size_t hkl_sample_n_reflections_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
407 #define HKL_SAMPLE_REFLECTIONS_FOREACH(_item, _list) for((_item)=hkl_sample_reflections_first_get((_list)); \
409 (_item)=hkl_sample_reflections_next_get((_list), (_item)))
411 HKLAPI HklSampleReflection
*hkl_sample_reflections_first_get(HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
413 HKLAPI HklSampleReflection
*hkl_sample_reflections_next_get(HklSample
*self
,
414 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
416 HKLAPI
void hkl_sample_del_reflection(HklSample
*self
,
417 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2);
419 HKLAPI
void hkl_sample_add_reflection(HklSample
*self
,
420 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2);
422 HKLAPI
int hkl_sample_compute_UB_busing_levy(HklSample
*self
,
423 const HklSampleReflection
*r1
,
424 const HklSampleReflection
*r2
,
425 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
427 HKLAPI
double hkl_sample_get_reflection_measured_angle(const HklSample
*self
,
428 const HklSampleReflection
*r1
,
429 const HklSampleReflection
*r2
) HKL_ARG_NONNULL(1, 2, 3);
431 HKLAPI
double hkl_sample_get_reflection_theoretical_angle(const HklSample
*self
,
432 const HklSampleReflection
*r1
,
433 const HklSampleReflection
*r2
) HKL_ARG_NONNULL(1, 2, 3);
435 HKLAPI
int hkl_sample_affine(HklSample
*self
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
437 /* HklSampleReflection */
439 HKLAPI HklSampleReflection
*hkl_sample_reflection_new(const HklGeometry
*geometry
,
440 const HklDetector
*detector
,
441 double h
, double k
, double l
,
442 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
444 HKLAPI
void hkl_sample_reflection_hkl_get(const HklSampleReflection
*self
,
445 double *h
, double *k
, double *l
) HKL_ARG_NONNULL(1, 2, 3, 4);
447 HKLAPI
int hkl_sample_reflection_hkl_set(HklSampleReflection
*self
,
448 double h
, double k
, double l
,
449 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
451 HKLAPI
int hkl_sample_reflection_flag_get(const HklSampleReflection
*self
) HKL_ARG_NONNULL(1);
453 HKLAPI
void hkl_sample_reflection_flag_set(HklSampleReflection
*self
, int flag
) HKL_ARG_NONNULL(1);
455 HKLAPI
const HklGeometry
*hkl_sample_reflection_geometry_get(HklSampleReflection
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
457 HKLAPI
void hkl_sample_reflection_geometry_set(HklSampleReflection
*self
,
458 const HklGeometry
*geometry
) HKL_ARG_NONNULL(1, 2);
464 typedef struct _HklEngine HklEngine
;
465 typedef struct _HklEngineList HklEngineList
;
467 typedef darray(HklEngine
*) darray_engine
;
471 HKLAPI
const char *hkl_engine_name_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
473 HKLAPI
unsigned int hkl_engine_len(const HklEngine
*self
) HKL_ARG_NONNULL(1);
475 HKLAPI
const darray_string
*hkl_engine_pseudo_axis_names_get(HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
477 HKLAPI
int hkl_engine_pseudo_axis_values_get(HklEngine
*self
,
478 double values
[], size_t n_values
,
479 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
481 HKLAPI HklGeometryList
*hkl_engine_pseudo_axis_values_set(HklEngine
*self
,
482 double values
[], size_t n_values
,
483 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
485 HKLAPI
const HklParameter
*hkl_engine_pseudo_axis_get(const HklEngine
*self
,
487 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
489 typedef enum _HklEngineCapabilities
491 HKL_ENGINE_CAPABILITIES_READABLE
= 1u << 0,
492 HKL_ENGINE_CAPABILITIES_WRITABLE
= 1u << 1,
493 HKL_ENGINE_CAPABILITIES_INITIALIZABLE
= 1u << 2,
494 } HklEngineCapabilities
;
496 HKLAPI
unsigned int hkl_engine_capabilities_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
498 HKLAPI
int hkl_engine_initialized_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
500 HKLAPI
int hkl_engine_initialized_set(HklEngine
*self
, int initialized
,
501 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
503 HKLAPI
void hkl_engine_fprintf(FILE *f
, const HklEngine
*self
) HKL_ARG_NONNULL(1, 2);
507 HKLAPI
const darray_string
*hkl_engine_modes_names_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
509 HKLAPI
const char *hkl_engine_current_mode_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
511 HKLAPI
int hkl_engine_current_mode_set(HklEngine
*self
, const char *name
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
513 typedef enum _HklEngineAxisNamesGet
515 HKL_ENGINE_AXIS_NAMES_GET_READ
,
516 HKL_ENGINE_AXIS_NAMES_GET_WRITE
,
517 } HklEngineAxisNamesGet
;
519 HKLAPI
const darray_string
*hkl_engine_axis_names_get(const HklEngine
*self
,
520 HklEngineAxisNamesGet mode
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
522 HKLAPI
const darray_string
*hkl_engine_parameters_names_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
524 HKLAPI
const HklParameter
*hkl_engine_parameter_get(const HklEngine
*self
, const char *name
,
525 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
527 HKLAPI
int hkl_engine_parameter_set(HklEngine
*self
,
528 const char *name
, const HklParameter
*parameter
,
529 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
531 HKLAPI
void hkl_engine_parameters_values_get(const HklEngine
*self
,
532 double values
[], size_t n_values
,
533 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2);
535 HKLAPI
int hkl_engine_parameters_values_set(HklEngine
*self
,
536 double values
[], size_t n_values
,
537 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
539 typedef enum _HklEngineDependencies
541 HKL_ENGINE_DEPENDENCIES_AXES
= 1u << 0,
542 HKL_ENGINE_DEPENDENCIES_ENERGY
= 1u << 1,
543 HKL_ENGINE_DEPENDENCIES_SAMPLE
= 1u << 2,
544 } HklEngineDependencies
;
546 HKLAPI
unsigned int hkl_engine_dependencies_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
551 HKLAPI
void hkl_engine_list_free(HklEngineList
*self
) HKL_ARG_NONNULL(1);
553 HKLAPI darray_engine
*hkl_engine_list_engines_get(HklEngineList
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
555 HKLAPI HklGeometry
*hkl_engine_list_geometry_get(HklEngineList
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
557 HKLAPI
int hkl_engine_list_geometry_set(HklEngineList
*self
, const HklGeometry
*geometry
) HKL_ARG_NONNULL(1, 2);
559 HKLAPI
int hkl_engine_list_select_solution(HklEngineList
*self
,
560 const HklGeometryListItem
*item
) HKL_ARG_NONNULL(1);
562 HKLAPI HklEngine
*hkl_engine_list_engine_get_by_name(HklEngineList
*self
,
564 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
566 HKLAPI
void hkl_engine_list_init(HklEngineList
*self
,
567 HklGeometry
*geometry
,
568 HklDetector
*detector
,
569 HklSample
*sample
) HKL_ARG_NONNULL(1, 2, 3, 4);
571 HKLAPI
int hkl_engine_list_get(HklEngineList
*self
) HKL_ARG_NONNULL(1);
573 HKLAPI
void hkl_engine_list_fprintf(FILE *f
,
574 const HklEngineList
*self
) HKL_ARG_NONNULL(1, 2);
580 typedef struct _HklFactory HklFactory
;
582 HKLAPI HklFactory
**hkl_factory_get_all(size_t *n
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
584 HKLAPI HklFactory
*hkl_factory_get_by_name(const char *name
,
585 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
587 HKLAPI
const char *hkl_factory_name_get(const HklFactory
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
589 HKLAPI HklGeometry
*hkl_factory_create_new_geometry(const HklFactory
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
591 HKLAPI HklEngineList
*hkl_factory_create_new_engine_list(const HklFactory
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;