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-2019 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
;
204 HKLAPI
void hkl_parameter_fprintf(FILE *f
, const HklParameter
*self
) HKL_ARG_NONNULL(1, 2);
210 typedef struct _HklDetector HklDetector
;
211 typedef enum _HklDetectorType
216 HKLAPI HklDetector
*hkl_detector_factory_new(HklDetectorType type
) HKL_WARN_UNUSED_RESULT
;
218 HKLAPI HklDetector
*hkl_detector_new_copy(const HklDetector
*src
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
220 HKLAPI
void hkl_detector_free(HklDetector
*self
) HKL_ARG_NONNULL(1);
222 HKLAPI
void hkl_detector_fprintf(FILE *f
, const HklDetector
*self
) HKL_ARG_NONNULL(1, 2);
228 typedef struct _HklGeometry HklGeometry
;
229 typedef struct _HklGeometryList HklGeometryList
;
230 typedef struct _HklGeometryListItem HklGeometryListItem
;
231 typedef struct _HklSample HklSample
; /* forwarded declaration */
235 HKLAPI HklGeometry
*hkl_geometry_new_copy(const HklGeometry
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
237 HKLAPI
void hkl_geometry_free(HklGeometry
*self
) HKL_ARG_NONNULL(1);
239 HKLAPI
int hkl_geometry_set(HklGeometry
*self
, const HklGeometry
*src
) HKL_ARG_NONNULL(1, 2);
241 HKLAPI
const darray_string
*hkl_geometry_axis_names_get(const HklGeometry
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
243 HKLAPI
const HklParameter
*hkl_geometry_axis_get(const HklGeometry
*self
, const char *name
,
244 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
246 HKLAPI
int hkl_geometry_axis_set(HklGeometry
*self
, const char *name
,
247 const HklParameter
*axis
,
248 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
250 HKLAPI
void hkl_geometry_axis_values_get(const HklGeometry
*self
,
251 double values
[], size_t n_values
,
252 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2);
254 HKLAPI
int hkl_geometry_axis_values_set(HklGeometry
*self
,
255 double values
[], size_t n_values
,
256 HklUnitEnum unit_type
,
257 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
259 HKLAPI
const char *hkl_geometry_name_get(const HklGeometry
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
261 HKLAPI
double hkl_geometry_wavelength_get(const HklGeometry
*self
,
262 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1);
264 HKLAPI
int hkl_geometry_wavelength_set(HklGeometry
*self
, double wavelength
,
265 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
267 HKLAPI
void hkl_geometry_randomize(HklGeometry
*self
) HKL_ARG_NONNULL(1);
269 /* TODO after bissecting it seems that this method is slow (to replace) */
270 HKLAPI
int hkl_geometry_set_values_v(HklGeometry
*self
, HklUnitEnum unit_type
,
271 GError
**error
, ...) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
273 HKLAPI HklQuaternion
hkl_geometry_sample_rotation_get(const HklGeometry
*self
,
274 const HklSample
*sample
) HKL_ARG_NONNULL(1, 2);
276 HKLAPI HklQuaternion
hkl_geometry_detector_rotation_get(const HklGeometry
*self
,
277 const HklDetector
*detector
) HKL_ARG_NONNULL(1, 2);
279 HKLAPI
void hkl_geometry_fprintf(FILE *file
, const HklGeometry
*self
) HKL_ARG_NONNULL(1, 2);
281 /* HklGeometryList */
283 #define HKL_GEOMETRY_LIST_FOREACH(item, list) for((item)=hkl_geometry_list_items_first_get((list)); \
285 (item)=hkl_geometry_list_items_next_get((list), (item)))
287 HKLAPI
void hkl_geometry_list_free(HklGeometryList
*self
) HKL_ARG_NONNULL(1);
289 HKLAPI
size_t hkl_geometry_list_n_items_get(const HklGeometryList
*self
) HKL_ARG_NONNULL(1);
291 HKLAPI
const HklGeometryListItem
*hkl_geometry_list_items_first_get(const HklGeometryList
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
293 HKLAPI
const HklGeometryListItem
*hkl_geometry_list_items_next_get(const HklGeometryList
*self
,
294 const HklGeometryListItem
*item
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
296 /* HklGeometryListItem */
298 HKLAPI
const HklGeometry
*hkl_geometry_list_item_geometry_get(const HklGeometryListItem
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
304 typedef struct _HklLattice HklLattice
;
305 typedef struct _HklSampleReflection HklSampleReflection
;
309 HKLAPI HklLattice
*hkl_lattice_new(double a
, double b
, double c
,
310 double alpha
, double beta
, double gamma
,
311 GError
**error
) HKL_WARN_UNUSED_RESULT
;
313 HKLAPI HklLattice
*hkl_lattice_new_copy(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
315 HKLAPI HklLattice
*hkl_lattice_new_default(void) HKL_WARN_UNUSED_RESULT
;
317 HKLAPI
void hkl_lattice_free(HklLattice
*self
) HKL_ARG_NONNULL(1);
319 HKLAPI
const HklParameter
*hkl_lattice_a_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
321 HKLAPI
int hkl_lattice_a_set(HklLattice
*self
, const HklParameter
*parameter
,
322 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
324 HKLAPI
const HklParameter
*hkl_lattice_b_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
326 HKLAPI
int hkl_lattice_b_set(HklLattice
*self
, const HklParameter
*parameter
,
327 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
329 HKLAPI
const HklParameter
*hkl_lattice_c_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
331 HKLAPI
int hkl_lattice_c_set(HklLattice
*self
, const HklParameter
*parameter
,
332 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
334 HKLAPI
const HklParameter
*hkl_lattice_alpha_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
336 HKLAPI
int hkl_lattice_alpha_set(HklLattice
*self
, const HklParameter
*parameter
,
337 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
339 HKLAPI
const HklParameter
*hkl_lattice_beta_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
341 HKLAPI
int hkl_lattice_beta_set(HklLattice
*self
, const HklParameter
*parameter
,
342 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
344 HKLAPI
const HklParameter
*hkl_lattice_gamma_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
346 HKLAPI
int hkl_lattice_gamma_set(HklLattice
*self
, const HklParameter
*parameter
,
347 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
349 HKLAPI
const HklParameter
*hkl_lattice_volume_get(const HklLattice
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
351 HKLAPI
int hkl_lattice_set(HklLattice
*self
,
352 double a
, double b
, double c
,
353 double alpha
, double beta
, double gamma
,
354 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
356 HKLAPI
void hkl_lattice_get(const HklLattice
*self
,
357 double *a
, double *b
, double *c
,
358 double *alpha
, double *beta
, double *gamma
,
359 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2, 3, 4, 5, 6, 7);
361 HKLAPI
int hkl_lattice_get_B(const HklLattice
*self
, HklMatrix
*B
) HKL_ARG_NONNULL(1, 2);
363 HKLAPI
int hkl_lattice_get_1_B(const HklLattice
*self
, HklMatrix
*B
) HKL_ARG_NONNULL(1, 2);
365 HKLAPI
int hkl_lattice_reciprocal(const HklLattice
*self
, HklLattice
*reciprocal
) HKL_ARG_NONNULL(1, 2);
369 HKLAPI HklSample
*hkl_sample_new(const char *name
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
371 HKLAPI HklSample
*hkl_sample_new_copy(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
373 HKLAPI
void hkl_sample_free(HklSample
*self
) HKL_ARG_NONNULL(1);
375 HKLAPI
const char *hkl_sample_name_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
377 HKLAPI
void hkl_sample_name_set(HklSample
*self
, const char *name
) HKL_ARG_NONNULL(1, 2);
379 HKLAPI
const HklLattice
*hkl_sample_lattice_get(HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
381 HKLAPI
void hkl_sample_lattice_set(HklSample
*self
, const HklLattice
*lattice
) HKL_ARG_NONNULL(1, 2);
383 HKLAPI
const HklParameter
*hkl_sample_ux_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
385 HKLAPI
int hkl_sample_ux_set(HklSample
*self
, const HklParameter
*ux
,
386 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
388 HKLAPI
const HklParameter
*hkl_sample_uy_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
390 HKLAPI
int hkl_sample_uy_set(HklSample
*self
, const HklParameter
*uy
,
391 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
393 HKLAPI
const HklParameter
*hkl_sample_uz_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
395 HKLAPI
int hkl_sample_uz_set(HklSample
*self
, const HklParameter
*uz
,
396 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
398 HKLAPI
const HklMatrix
*hkl_sample_U_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
400 HKLAPI
void hkl_sample_U_set(HklSample
*self
, const HklMatrix
*U
, GError
**error
) HKL_ARG_NONNULL(1);
402 HKLAPI
const HklMatrix
*hkl_sample_UB_get(const HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
404 HKLAPI
int hkl_sample_UB_set(HklSample
*self
, const HklMatrix
*UB
,
405 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
407 HKLAPI
size_t hkl_sample_n_reflections_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
409 #define HKL_SAMPLE_REFLECTIONS_FOREACH(_item, _list) for((_item)=hkl_sample_reflections_first_get((_list)); \
411 (_item)=hkl_sample_reflections_next_get((_list), (_item)))
413 HKLAPI HklSampleReflection
*hkl_sample_reflections_first_get(HklSample
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
415 HKLAPI HklSampleReflection
*hkl_sample_reflections_next_get(HklSample
*self
,
416 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
418 HKLAPI
void hkl_sample_del_reflection(HklSample
*self
,
419 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2);
421 HKLAPI
void hkl_sample_add_reflection(HklSample
*self
,
422 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2);
424 HKLAPI
int hkl_sample_compute_UB_busing_levy(HklSample
*self
,
425 const HklSampleReflection
*r1
,
426 const HklSampleReflection
*r2
,
427 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
429 HKLAPI
double hkl_sample_get_reflection_measured_angle(const HklSample
*self
,
430 const HklSampleReflection
*r1
,
431 const HklSampleReflection
*r2
) HKL_ARG_NONNULL(1, 2, 3);
433 HKLAPI
double hkl_sample_get_reflection_theoretical_angle(const HklSample
*self
,
434 const HklSampleReflection
*r1
,
435 const HklSampleReflection
*r2
) HKL_ARG_NONNULL(1, 2, 3);
437 HKLAPI
int hkl_sample_affine(HklSample
*self
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
439 /* HklSampleReflection */
441 HKLAPI HklSampleReflection
*hkl_sample_reflection_new(const HklGeometry
*geometry
,
442 const HklDetector
*detector
,
443 double h
, double k
, double l
,
444 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
446 HKLAPI
void hkl_sample_reflection_hkl_get(const HklSampleReflection
*self
,
447 double *h
, double *k
, double *l
) HKL_ARG_NONNULL(1, 2, 3, 4);
449 HKLAPI
int hkl_sample_reflection_hkl_set(HklSampleReflection
*self
,
450 double h
, double k
, double l
,
451 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
453 HKLAPI
int hkl_sample_reflection_flag_get(const HklSampleReflection
*self
) HKL_ARG_NONNULL(1);
455 HKLAPI
void hkl_sample_reflection_flag_set(HklSampleReflection
*self
, int flag
) HKL_ARG_NONNULL(1);
457 HKLAPI
const HklGeometry
*hkl_sample_reflection_geometry_get(HklSampleReflection
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
459 HKLAPI
void hkl_sample_reflection_geometry_set(HklSampleReflection
*self
,
460 const HklGeometry
*geometry
) HKL_ARG_NONNULL(1, 2);
466 typedef struct _HklEngine HklEngine
;
467 typedef struct _HklEngineList HklEngineList
;
469 typedef darray(HklEngine
*) darray_engine
;
473 HKLAPI
const char *hkl_engine_name_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
475 HKLAPI
unsigned int hkl_engine_len(const HklEngine
*self
) HKL_ARG_NONNULL(1);
477 HKLAPI
const darray_string
*hkl_engine_pseudo_axis_names_get(HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
479 HKLAPI
int hkl_engine_pseudo_axis_values_get(HklEngine
*self
,
480 double values
[], size_t n_values
,
481 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
483 HKLAPI HklGeometryList
*hkl_engine_pseudo_axis_values_set(HklEngine
*self
,
484 double values
[], size_t n_values
,
485 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
487 HKLAPI
const HklParameter
*hkl_engine_pseudo_axis_get(const HklEngine
*self
,
489 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
491 typedef enum _HklEngineCapabilities
493 HKL_ENGINE_CAPABILITIES_READABLE
= 1u << 0,
494 HKL_ENGINE_CAPABILITIES_WRITABLE
= 1u << 1,
495 HKL_ENGINE_CAPABILITIES_INITIALIZABLE
= 1u << 2,
496 } HklEngineCapabilities
;
498 HKLAPI
unsigned int hkl_engine_capabilities_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
500 HKLAPI
int hkl_engine_initialized_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
502 HKLAPI
int hkl_engine_initialized_set(HklEngine
*self
, int initialized
,
503 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
505 HKLAPI
void hkl_engine_fprintf(FILE *f
, const HklEngine
*self
) HKL_ARG_NONNULL(1, 2);
509 HKLAPI
const darray_string
*hkl_engine_modes_names_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
511 HKLAPI
const char *hkl_engine_current_mode_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
513 HKLAPI
int hkl_engine_current_mode_set(HklEngine
*self
, const char *name
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
515 typedef enum _HklEngineAxisNamesGet
517 HKL_ENGINE_AXIS_NAMES_GET_READ
,
518 HKL_ENGINE_AXIS_NAMES_GET_WRITE
,
519 } HklEngineAxisNamesGet
;
521 HKLAPI
const darray_string
*hkl_engine_axis_names_get(const HklEngine
*self
,
522 HklEngineAxisNamesGet mode
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
524 HKLAPI
const darray_string
*hkl_engine_parameters_names_get(const HklEngine
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
526 HKLAPI
const HklParameter
*hkl_engine_parameter_get(const HklEngine
*self
, const char *name
,
527 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
529 HKLAPI
int hkl_engine_parameter_set(HklEngine
*self
,
530 const char *name
, const HklParameter
*parameter
,
531 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
533 HKLAPI
void hkl_engine_parameters_values_get(const HklEngine
*self
,
534 double values
[], size_t n_values
,
535 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2);
537 HKLAPI
int hkl_engine_parameters_values_set(HklEngine
*self
,
538 double values
[], size_t n_values
,
539 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
541 typedef enum _HklEngineDependencies
543 HKL_ENGINE_DEPENDENCIES_AXES
= 1u << 0,
544 HKL_ENGINE_DEPENDENCIES_ENERGY
= 1u << 1,
545 HKL_ENGINE_DEPENDENCIES_SAMPLE
= 1u << 2,
546 } HklEngineDependencies
;
548 HKLAPI
unsigned int hkl_engine_dependencies_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
553 HKLAPI
void hkl_engine_list_free(HklEngineList
*self
) HKL_ARG_NONNULL(1);
555 HKLAPI darray_engine
*hkl_engine_list_engines_get(HklEngineList
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
557 HKLAPI HklGeometry
*hkl_engine_list_geometry_get(HklEngineList
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
559 HKLAPI
int hkl_engine_list_geometry_set(HklEngineList
*self
, const HklGeometry
*geometry
) HKL_ARG_NONNULL(1, 2);
561 HKLAPI
int hkl_engine_list_select_solution(HklEngineList
*self
,
562 const HklGeometryListItem
*item
) HKL_ARG_NONNULL(1);
564 HKLAPI HklEngine
*hkl_engine_list_engine_get_by_name(HklEngineList
*self
,
566 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
568 HKLAPI
void hkl_engine_list_init(HklEngineList
*self
,
569 HklGeometry
*geometry
,
570 HklDetector
*detector
,
571 HklSample
*sample
) HKL_ARG_NONNULL(1, 2, 3, 4);
573 HKLAPI
int hkl_engine_list_get(HklEngineList
*self
) HKL_ARG_NONNULL(1);
575 HKLAPI
const darray_string
*hkl_engine_list_parameters_names_get(const HklEngineList
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
577 HKLAPI
const HklParameter
*hkl_engine_list_parameter_get(const HklEngineList
*self
, const char *name
,
578 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
580 HKLAPI
int hkl_engine_list_parameter_set(HklEngineList
*self
,
581 const char *name
, const HklParameter
*parameter
,
582 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
584 HKLAPI
void hkl_engine_list_parameters_values_get(const HklEngineList
*self
,
585 double values
[], size_t n_values
,
586 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2);
588 HKLAPI
int hkl_engine_list_parameters_values_set(HklEngineList
*self
,
589 double values
[], size_t n_values
,
590 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
592 HKLAPI
void hkl_engine_list_fprintf(FILE *f
,
593 const HklEngineList
*self
) HKL_ARG_NONNULL(1, 2);
599 typedef struct _HklFactory HklFactory
;
601 HKLAPI HklFactory
**hkl_factory_get_all(size_t *n
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
603 HKLAPI HklFactory
*hkl_factory_get_by_name(const char *name
,
604 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
606 HKLAPI
const char *hkl_factory_name_get(const HklFactory
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
608 HKLAPI HklGeometry
*hkl_factory_create_new_geometry(const HklFactory
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
610 HKLAPI HklEngineList
*hkl_factory_create_new_engine_list(const HklFactory
*self
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;