hkl/hkl-binding-private.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) 2012-2017 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_BINDING_PRIVATE_H__
  23 #define __HKL_BINDING_PRIVATE_H__
  24
  25 #include <glib.h>                       // for GError, GHashTable, etc
  26 #include <sys/types.h>                  // for uint
  27 #include "hkl.h"                        // for HKLAPI, HklGeometry, etc
  28
  29 G_BEGIN_DECLS
  30
  31 /*****************/
  32 /* HklQuaternion */
  33 /*****************/
  34
  35 HKLAPI HklMatrix *hkl_quaternion_to_matrix_binding(const HklQuaternion *self) HKL_ARG_NONNULL(1);
  36
  37 /**************/
  38 /* HklFactory */
  39 /**************/
  40
  41 HKLAPI GHashTable *hkl_factories(void);
  42
  43 /***************/
  44 /* HklGeometry */
  45 /***************/
  46
  47 HKLAPI const char **hkl_geometry_axis_names_get_binding(const HklGeometry *self,
  48                                                         size_t *length) HKL_ARG_NONNULL(1, 2);
  49
  50
  51 HKLAPI double* hkl_geometry_axis_values_get_binding(const HklGeometry *self, unsigned int *len,
  52                                                     HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2);
  53
  54 HKLAPI HklQuaternion *hkl_geometry_sample_rotation_get_binding(const HklGeometry *self,
  55                                                                const HklSample *sample) HKL_ARG_NONNULL(1, 2);
  56
  57 HKLAPI HklQuaternion *hkl_geometry_detector_rotation_get_binding(const HklGeometry *self,
  58                                                                  const HklDetector *detector) HKL_ARG_NONNULL(1, 2);
  59
  60 /*******************/
  61 /* HklGeometryList */
  62 /*******************/
  63
  64 HKLAPI GSList* hkl_geometry_list_items(HklGeometryList *self) HKL_ARG_NONNULL(1);
  65
  66 /*************/
  67 /* HklEngine */
  68 /*************/
  69
  70 HKLAPI const char **hkl_engine_modes_names_get_binding(const HklEngine *self,
  71                                                        size_t *length) HKL_ARG_NONNULL(1, 2);
  72
  73 HKLAPI const char **hkl_engine_pseudo_axis_names_get_binding(HklEngine *self,
  74                                                              size_t *length) HKL_ARG_NONNULL(1, 2);
  75
  76 HKLAPI const char **hkl_engine_parameters_names_get_binding(const HklEngine *self,
  77                                                             size_t *length) HKL_ARG_NONNULL(1, 2);
  78
  79 HKLAPI double *hkl_engine_parameters_values_get_binding(const HklEngine *self, guint *len,
  80                                                         HklUnitEnum unit_type) HKL_ARG_NONNULL(1, 2);
  81
  82 HKLAPI const char **hkl_engine_axis_names_get_binding(const HklEngine *self,
  83                                                       HklEngineAxisNamesGet mode,
  84                                                       size_t *length) HKL_ARG_NONNULL(1, 3);
  85
  86 HKLAPI double *hkl_engine_pseudo_axis_values_get_binding(const HklEngine *self,
  87                                                          guint *len, HklUnitEnum unit_type);
  88
  89 /***************************/
  90 /* HklPSeudoAxisEngineList */
  91 /***************************/
  92
  93 HKLAPI GSList* hkl_engine_list_engines_get_as_gslist(HklEngineList *self);
  94
  95 /*************/
  96 /* HklSample */
  97 /*************/
  98
  99 HKLAPI GSList *hkl_sample_reflections_get(const HklSample *self);
 100
 101 HKLAPI HklSampleReflection *hkl_sample_add_reflection_binding(HklSample *self,
 102                                                               const HklGeometry *geometry,
 103                                                               const HklDetector *detector,
 104                                                               double h, double k, double l,
 105                                                               GError **error);
 106
 107 G_END_DECLS
 108
 109 #endif /* __HKL_BINDING_PRIVATE_H__ */