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-2014 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
92 typedef darray(const char *) darray_string
;
98 typedef struct _HklMatrix HklMatrix
;
100 HKLAPI HklMatrix
*hkl_matrix_new(void);
102 HKLAPI HklMatrix
*hkl_matrix_new_full(double m11
, double m12
, double m13
,
103 double m21
, double m22
, double m23
,
104 double m31
, double m32
, double m33
);
106 HKLAPI HklMatrix
*hkl_matrix_new_euler(double euler_x
, double euler_y
, double euler_z
);
108 HKLAPI
double hkl_matrix_get(const HklMatrix
*self
, unsigned int i
, unsigned int j
) HKL_ARG_NONNULL(1);
110 HKLAPI
void hkl_matrix_free(HklMatrix
*self
) HKL_ARG_NONNULL(1);
112 HKLAPI
void hkl_matrix_init(HklMatrix
*self
,
113 double m11
, double m12
, double m13
,
114 double m21
, double m22
, double m23
,
115 double m31
, double m32
, double m33
) HKL_ARG_NONNULL(1);
117 HKLAPI
int hkl_matrix_cmp(const HklMatrix
*self
, const HklMatrix
*m
) HKL_ARG_NONNULL(1, 2);
119 HKLAPI
void hkl_matrix_times_matrix(HklMatrix
*self
, const HklMatrix
*m
) HKL_ARG_NONNULL(1, 2);
125 typedef enum _HklUnitEnum
135 typedef struct _HklParameter HklParameter
;
139 HKLAPI HklParameter
*hkl_parameter_new_copy(const HklParameter
*self
) HKL_ARG_NONNULL(1);
141 HKLAPI
void hkl_parameter_free(HklParameter
*self
) HKL_ARG_NONNULL(1);
143 HKLAPI
const char *hkl_parameter_name_get(const HklParameter
*self
) HKL_ARG_NONNULL(1);
145 HKLAPI
const char *hkl_parameter_default_unit_get(const HklParameter
*self
) HKL_ARG_NONNULL(1);
147 HKLAPI
const char *hkl_parameter_user_unit_get(const HklParameter
*self
) HKL_ARG_NONNULL(1);
149 HKLAPI
double hkl_parameter_value_get(const HklParameter
*self
,
150 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1);
152 HKLAPI
int hkl_parameter_value_set(HklParameter
*self
, double value
,
153 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
155 HKLAPI
void hkl_parameter_min_max_get(const HklParameter
*self
, double *min
, double *max
,
156 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2, 3);
158 HKLAPI
int hkl_parameter_min_max_set(HklParameter
*self
, double min
, double max
,
159 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
161 HKLAPI
int hkl_parameter_fit_get(const HklParameter
*self
) HKL_ARG_NONNULL(1);
163 HKLAPI
void hkl_parameter_fit_set(HklParameter
*self
, int fit
) HKL_ARG_NONNULL(1);
165 HKLAPI
void hkl_parameter_randomize(HklParameter
*self
) HKL_ARG_NONNULL(1);
171 typedef struct _HklDetector HklDetector
;
172 typedef enum _HklDetectorType
177 HKLAPI HklDetector
*hkl_detector_factory_new(HklDetectorType type
);
179 HKLAPI HklDetector
*hkl_detector_new_copy(const HklDetector
*src
) HKL_ARG_NONNULL(1);
181 HKLAPI
void hkl_detector_free(HklDetector
*self
) HKL_ARG_NONNULL(1);
183 HKLAPI
void hkl_detector_fprintf(FILE *f
, const HklDetector
*self
) HKL_ARG_NONNULL(1, 2);
189 typedef struct _HklGeometry HklGeometry
;
190 typedef struct _HklGeometryList HklGeometryList
;
191 typedef struct _HklGeometryListItem HklGeometryListItem
;
195 HKLAPI HklGeometry
*hkl_geometry_new_copy(const HklGeometry
*self
) HKL_ARG_NONNULL(1);
197 HKLAPI
void hkl_geometry_free(HklGeometry
*self
) HKL_ARG_NONNULL(1);
199 HKLAPI
int hkl_geometry_set(HklGeometry
*self
, const HklGeometry
*src
) HKL_ARG_NONNULL(1, 2);
201 HKLAPI
const darray_string
*hkl_geometry_axes_names_get(const HklGeometry
*self
) HKL_ARG_NONNULL(1);
203 HKLAPI
const HklParameter
*hkl_geometry_axis_get(const HklGeometry
*self
, const char *name
,
204 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
206 HKLAPI
int hkl_geometry_axis_set(HklGeometry
*self
, const char *name
,
207 const HklParameter
*axis
,
208 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
210 HKLAPI
void hkl_geometry_axes_values_get(const HklGeometry
*self
,
211 double values
[], size_t n_values
,
212 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2);
214 HKLAPI
int hkl_geometry_axes_values_set(HklGeometry
*self
,
215 double values
[], size_t n_values
,
216 HklUnitEnum unit_type
,
217 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
219 HKLAPI
const char *hkl_geometry_name_get(const HklGeometry
*self
) HKL_ARG_NONNULL(1);
221 HKLAPI
double hkl_geometry_wavelength_get(const HklGeometry
*self
,
222 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1);
224 HKLAPI
int hkl_geometry_wavelength_set(HklGeometry
*self
, double wavelength
,
225 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
227 HKLAPI
void hkl_geometry_randomize(HklGeometry
*self
) HKL_ARG_NONNULL(1);
229 /* TODO after bissecting it seems that this method is slow (to replace) */
230 HKLAPI
int hkl_geometry_set_values_v(HklGeometry
*self
, HklUnitEnum unit_type
,
231 GError
**error
, ...) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
233 HKLAPI
void hkl_geometry_fprintf(FILE *file
, const HklGeometry
*self
) HKL_ARG_NONNULL(1, 2);
235 /* HklGeometryList */
237 #define HKL_GEOMETRY_LIST_FOREACH(item, list) for((item)=hkl_geometry_list_items_first_get((list)); \
239 (item)=hkl_geometry_list_items_next_get((list), (item)))
241 HKLAPI
void hkl_geometry_list_free(HklGeometryList
*self
) HKL_ARG_NONNULL(1);
243 HKLAPI
size_t hkl_geometry_list_n_items_get(const HklGeometryList
*self
) HKL_ARG_NONNULL(1);
245 HKLAPI
const HklGeometryListItem
*hkl_geometry_list_items_first_get(const HklGeometryList
*self
) HKL_ARG_NONNULL(1);
247 HKLAPI
const HklGeometryListItem
*hkl_geometry_list_items_next_get(const HklGeometryList
*self
,
248 const HklGeometryListItem
*item
) HKL_ARG_NONNULL(1, 2);
250 /* HklGeometryListItem */
252 HKLAPI
const HklGeometry
*hkl_geometry_list_item_geometry_get(const HklGeometryListItem
*self
) HKL_ARG_NONNULL(1);
258 typedef struct _HklLattice HklLattice
;
259 typedef struct _HklSample HklSample
;
260 typedef struct _HklSampleReflection HklSampleReflection
;
264 HKLAPI HklLattice
*hkl_lattice_new(double a
, double b
, double c
,
265 double alpha
, double beta
, double gamma
,
266 GError
**error
) HKL_WARN_UNUSED_RESULT
;
268 HKLAPI HklLattice
*hkl_lattice_new_copy(const HklLattice
*self
) HKL_ARG_NONNULL(1);
270 HKLAPI HklLattice
*hkl_lattice_new_default(void);
272 HKLAPI
void hkl_lattice_free(HklLattice
*self
) HKL_ARG_NONNULL(1);
274 HKLAPI
const HklParameter
*hkl_lattice_a_get(const HklLattice
*self
) HKL_ARG_NONNULL(1);
276 HKLAPI
int hkl_lattice_a_set(HklLattice
*self
, const HklParameter
*parameter
,
277 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
279 HKLAPI
const HklParameter
*hkl_lattice_b_get(const HklLattice
*self
) HKL_ARG_NONNULL(1);
281 HKLAPI
int hkl_lattice_b_set(HklLattice
*self
, const HklParameter
*parameter
,
282 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
284 HKLAPI
const HklParameter
*hkl_lattice_c_get(const HklLattice
*self
) HKL_ARG_NONNULL(1);
286 HKLAPI
int hkl_lattice_c_set(HklLattice
*self
, const HklParameter
*parameter
,
287 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
289 HKLAPI
const HklParameter
*hkl_lattice_alpha_get(const HklLattice
*self
) HKL_ARG_NONNULL(1);
291 HKLAPI
int hkl_lattice_alpha_set(HklLattice
*self
, const HklParameter
*parameter
,
292 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
294 HKLAPI
const HklParameter
*hkl_lattice_beta_get(const HklLattice
*self
) HKL_ARG_NONNULL(1);
296 HKLAPI
int hkl_lattice_beta_set(HklLattice
*self
, const HklParameter
*parameter
,
297 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
299 HKLAPI
const HklParameter
*hkl_lattice_gamma_get(const HklLattice
*self
) HKL_ARG_NONNULL(1);
301 HKLAPI
int hkl_lattice_gamma_set(HklLattice
*self
, const HklParameter
*parameter
,
302 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
304 HKLAPI
int hkl_lattice_set(HklLattice
*self
,
305 double a
, double b
, double c
,
306 double alpha
, double beta
, double gamma
,
307 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
309 HKLAPI
void hkl_lattice_get(const HklLattice
*self
,
310 double *a
, double *b
, double *c
,
311 double *alpha
, double *beta
, double *gamma
,
312 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2, 3, 4, 5, 6, 7);
314 HKLAPI
int hkl_lattice_get_B(const HklLattice
*self
, HklMatrix
*B
) HKL_ARG_NONNULL(1, 2);
316 HKLAPI
int hkl_lattice_get_1_B(const HklLattice
*self
, HklMatrix
*B
) HKL_ARG_NONNULL(1, 2);
318 HKLAPI
int hkl_lattice_reciprocal(const HklLattice
*self
, HklLattice
*reciprocal
) HKL_ARG_NONNULL(1, 2);
322 HKLAPI HklSample
*hkl_sample_new(const char *name
) HKL_ARG_NONNULL(1);
324 HKLAPI HklSample
*hkl_sample_new_copy(const HklSample
*self
) HKL_ARG_NONNULL(1);
326 HKLAPI
void hkl_sample_free(HklSample
*self
) HKL_ARG_NONNULL(1);
328 HKLAPI
const char *hkl_sample_name_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
330 HKLAPI
void hkl_sample_name_set(HklSample
*self
, const char *name
) HKL_ARG_NONNULL(1, 2);
332 HKLAPI
const HklLattice
*hkl_sample_lattice_get(HklSample
*self
) HKL_ARG_NONNULL(1);
334 HKLAPI
void hkl_sample_lattice_set(HklSample
*self
, const HklLattice
*lattice
) HKL_ARG_NONNULL(1, 2);
336 HKLAPI
const HklParameter
*hkl_sample_ux_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
338 HKLAPI
int hkl_sample_ux_set(HklSample
*self
, const HklParameter
*ux
,
339 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
341 HKLAPI
const HklParameter
*hkl_sample_uy_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
343 HKLAPI
int hkl_sample_uy_set(HklSample
*self
, const HklParameter
*uy
,
344 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
346 HKLAPI
const HklParameter
*hkl_sample_uz_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
348 HKLAPI
int hkl_sample_uz_set(HklSample
*self
, const HklParameter
*uz
,
349 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
351 HKLAPI
const HklMatrix
*hkl_sample_U_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
353 HKLAPI
void hkl_sample_U_set(HklSample
*self
, const HklMatrix
*U
, GError
**error
) HKL_ARG_NONNULL(1);
355 HKLAPI
const HklMatrix
*hkl_sample_UB_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
357 HKLAPI
int hkl_sample_UB_set(HklSample
*self
, const HklMatrix
*UB
,
358 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
360 HKLAPI
size_t hkl_sample_n_reflections_get(const HklSample
*self
) HKL_ARG_NONNULL(1);
362 #define HKL_SAMPLE_REFLECTIONS_FOREACH(_item, _list) for((_item)=hkl_sample_reflections_first_get((_list)); \
364 (_item)=hkl_sample_reflections_next_get((_list), (_item)))
366 HKLAPI HklSampleReflection
*hkl_sample_reflections_first_get(HklSample
*self
) HKL_ARG_NONNULL(1);
368 HKLAPI HklSampleReflection
*hkl_sample_reflections_next_get(HklSample
*self
,
369 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2);
371 HKLAPI
void hkl_sample_del_reflection(HklSample
*self
,
372 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2);
374 HKLAPI
void hkl_sample_add_reflection(HklSample
*self
,
375 HklSampleReflection
*reflection
) HKL_ARG_NONNULL(1, 2);
377 HKLAPI
int hkl_sample_compute_UB_busing_levy(HklSample
*self
,
378 const HklSampleReflection
*r1
,
379 const HklSampleReflection
*r2
,
380 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
382 HKLAPI
double hkl_sample_get_reflection_mesured_angle(const HklSample
*self
,
383 const HklSampleReflection
*r1
,
384 const HklSampleReflection
*r2
) HKL_ARG_NONNULL(1, 2, 3);
386 HKLAPI
double hkl_sample_get_reflection_theoretical_angle(const HklSample
*self
,
387 const HklSampleReflection
*r1
,
388 const HklSampleReflection
*r2
) HKL_ARG_NONNULL(1, 2, 3);
390 HKLAPI
int hkl_sample_affine(HklSample
*self
, GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
392 /* HklSampleReflection */
394 HKLAPI HklSampleReflection
*hkl_sample_reflection_new(const HklGeometry
*geometry
,
395 const HklDetector
*detector
,
396 double h
, double k
, double l
,
397 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
399 HKLAPI
void hkl_sample_reflection_hkl_get(const HklSampleReflection
*self
,
400 double *h
, double *k
, double *l
) HKL_ARG_NONNULL(1, 2, 3, 4);
402 HKLAPI
int hkl_sample_reflection_hkl_set(HklSampleReflection
*self
,
403 double h
, double k
, double l
,
404 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
406 HKLAPI
int hkl_sample_reflection_flag_get(const HklSampleReflection
*self
) HKL_ARG_NONNULL(1);
408 HKLAPI
void hkl_sample_reflection_flag_set(HklSampleReflection
*self
, int flag
) HKL_ARG_NONNULL(1);
410 HKLAPI
const HklGeometry
*hkl_sample_reflection_geometry_get(HklSampleReflection
*self
) HKL_ARG_NONNULL(1);
412 HKLAPI
void hkl_sample_reflection_geometry_set(HklSampleReflection
*self
,
413 const HklGeometry
*geometry
) HKL_ARG_NONNULL(1, 2);
419 typedef struct _HklEngine HklEngine
;
420 typedef struct _HklEngineList HklEngineList
;
422 typedef darray(HklEngine
*) darray_engine
;
426 HKLAPI
const char *hkl_engine_name_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
428 HKLAPI
unsigned int hkl_engine_len(const HklEngine
*self
) HKL_ARG_NONNULL(1);
430 HKLAPI
const darray_string
*hkl_engine_pseudo_axes_names_get(HklEngine
*self
) HKL_ARG_NONNULL(1);
432 HKLAPI
int hkl_engine_pseudo_axes_values_get(HklEngine
*self
,
433 double values
[], size_t n_values
,
434 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
436 HKLAPI HklGeometryList
*hkl_engine_pseudo_axes_values_set(HklEngine
*self
,
437 double values
[], size_t n_values
,
438 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
440 HKLAPI
const HklParameter
*hkl_engine_pseudo_axis_get(const HklEngine
*self
,
442 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
444 typedef enum _HklEngineCapabilities
446 HKL_ENGINE_CAPABILITIES_READABLE
= 1u << 0,
447 HKL_ENGINE_CAPABILITIES_WRITABLE
= 1u << 1,
448 HKL_ENGINE_CAPABILITIES_INITIALIZABLE
= 1u << 2,
449 } HklEngineCapabilities
;
451 HKLAPI
unsigned int hkl_engine_capabilities_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
453 HKLAPI
int hkl_engine_initialized_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
455 HKLAPI
int hkl_engine_initialized_set(HklEngine
*self
, int initialized
,
456 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
458 HKLAPI
void hkl_engine_fprintf(FILE *f
, const HklEngine
*self
) HKL_ARG_NONNULL(1, 2);
462 HKLAPI
const darray_string
*hkl_engine_modes_names_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
464 HKLAPI
const char *hkl_engine_current_mode_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
466 HKLAPI
int hkl_engine_current_mode_set(HklEngine
*self
, const char *name
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
468 typedef enum _HklEngineAxesNamesGet
470 HKL_ENGINE_AXES_NAMES_GET_READ
,
471 HKL_ENGINE_AXES_NAMES_GET_WRITE
,
472 } HklEngineAxesNamesGet
;
474 HKLAPI
const darray_string
*hkl_engine_axes_names_get(const HklEngine
*self
,
475 HklEngineAxesNamesGet mode
) HKL_ARG_NONNULL(1);
477 HKLAPI
const darray_string
*hkl_engine_parameters_names_get(const HklEngine
*self
) HKL_ARG_NONNULL(1);
479 HKLAPI
const HklParameter
*hkl_engine_parameter_get(const HklEngine
*self
, const char *name
,
480 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
482 HKLAPI
int hkl_engine_parameter_set(HklEngine
*self
,
483 const char *name
, const HklParameter
*parameter
,
484 GError
**error
) HKL_ARG_NONNULL(1, 2, 3) HKL_WARN_UNUSED_RESULT
;
486 HKLAPI
void hkl_engine_parameters_values_get(const HklEngine
*self
,
487 double values
[], size_t n_values
,
488 HklUnitEnum unit_type
) HKL_ARG_NONNULL(1, 2);
490 HKLAPI
int hkl_engine_parameters_values_set(HklEngine
*self
,
491 double values
[], size_t n_values
,
492 HklUnitEnum unit_type
, GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
496 HKLAPI
void hkl_engine_list_free(HklEngineList
*self
) HKL_ARG_NONNULL(1);
498 HKLAPI darray_engine
*hkl_engine_list_engines_get(HklEngineList
*self
) HKL_ARG_NONNULL(1);
500 HKLAPI HklGeometry
*hkl_engine_list_geometry_get(HklEngineList
*self
) HKL_ARG_NONNULL(1);
502 HKLAPI
int hkl_engine_list_geometry_set(HklEngineList
*self
, const HklGeometry
*geometry
) HKL_ARG_NONNULL(1, 2);
504 HKLAPI
int hkl_engine_list_select_solution(HklEngineList
*self
,
505 const HklGeometryListItem
*item
) HKL_ARG_NONNULL(1);
507 HKLAPI HklEngine
*hkl_engine_list_engine_get_by_name(HklEngineList
*self
,
509 GError
**error
) HKL_ARG_NONNULL(1, 2) HKL_WARN_UNUSED_RESULT
;
511 HKLAPI
void hkl_engine_list_init(HklEngineList
*self
,
512 HklGeometry
*geometry
,
513 HklDetector
*detector
,
514 HklSample
*sample
) HKL_ARG_NONNULL(1, 2, 3, 4);
516 HKLAPI
int hkl_engine_list_get(HklEngineList
*self
) HKL_ARG_NONNULL(1);
518 HKLAPI
void hkl_engine_list_fprintf(FILE *f
,
519 const HklEngineList
*self
) HKL_ARG_NONNULL(1, 2);
525 typedef struct _HklFactory HklFactory
;
527 HKLAPI HklFactory
**hkl_factory_get_all(size_t *n
) HKL_ARG_NONNULL(1);
529 HKLAPI HklFactory
*hkl_factory_get_by_name(const char *name
,
530 GError
**error
) HKL_ARG_NONNULL(1) HKL_WARN_UNUSED_RESULT
;
532 HKLAPI
const char *hkl_factory_name_get(const HklFactory
*self
) HKL_ARG_NONNULL(1);
534 HKLAPI HklGeometry
*hkl_factory_create_new_geometry(const HklFactory
*self
) HKL_ARG_NONNULL(1);
536 HKLAPI HklEngineList
*hkl_factory_create_new_engine_list(const HklFactory
*self
) HKL_ARG_NONNULL(1);