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