hkl/hkl-source-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) 2003-2019 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_SOURCE_PRIVATE_H__
  23 #define __HKL_SOURCE_PRIVATE_H__
  24
  25 #include <stdio.h>                      // for FILE
  26 #include "hkl-vector-private.h"         // for HklVector
  27 #include "hkl.h"                        // for G_BEGIN_DECLS, etc
  28
  29 G_BEGIN_DECLS
  30
  31 #define HKL_SOURCE_DEFAULT_WAVE_LENGTH (1.54)
  32
  33 typedef struct _HklSource HklSource;
  34
  35 struct _HklSource
  36 {
  37         double wave_length;
  38         HklVector direction;
  39 };
  40
  41 extern HklSource *hkl_source_dup(const HklSource *self);
  42
  43 extern void hkl_source_free(HklSource *self);
  44
  45 extern int hkl_source_init(HklSource *self, double wave_length,
  46                            double x, double y, double z);
  47
  48 extern int hkl_source_cmp(HklSource const *self, HklSource const *s);
  49
  50 extern void hkl_source_compute_ki(HklSource const *self, HklVector *ki);
  51
  52 extern double hkl_source_get_wavelength(HklSource const *self);
  53
  54 extern void hkl_source_fprintf(FILE *f, HklSource const *self);
  55
  56 G_END_DECLS
  57
  58 #endif /* __HKL_SOURCE_PRIVATE_H__ */