/usr/include/hkl/hkl-axis.h is in libhkl-dev 4.0.3-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | /* This file is part of the hkl library.
*
* The hkl library is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* The hkl library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with the hkl library. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright (C) 2003-2010 Synchrotron SOLEIL
* L'Orme des Merisiers Saint-Aubin
* BP 48 91192 GIF-sur-YVETTE CEDEX
*
* Authors: Picca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>
*/
#ifndef __HKL_AXIS_H__
#define __HKL_AXIS_H__
#include <hkl/hkl-macros.h>
#include <hkl/hkl-interval.h>
#include <hkl/hkl-vector.h>
#include <hkl/hkl-quaternion.h>
#include <hkl/hkl-parameter.h>
HKL_BEGIN_DECLS
typedef struct _HklAxis HklAxis;
struct _HklAxis {
HklParameter parent_instance;
HklVector axis_v;
HklQuaternion q;
};
/***********/
/* HklAxis */
/***********/
extern HklAxis *hkl_axis_new(char const *name, HklVector const *axis_v);
extern void hkl_axis_free(HklAxis *self);
extern void hkl_axis_init(HklAxis *axis, char const * name, HklVector const *axis_v);
extern char const *hkl_axis_get_name(HklAxis const *self);
extern int hkl_axis_get_changed(HklAxis const *self);
extern void hkl_axis_set_changed(HklAxis *self, int changed);
extern double hkl_axis_get_value(HklAxis const *self);
extern double hkl_axis_get_value_unit(HklAxis const *self);
extern double hkl_axis_get_value_closest(HklAxis const *self, HklAxis const *axis);
extern double hkl_axis_get_value_closest_unit(HklAxis const *self, HklAxis const *axis);
extern double hkl_axis_get_max(HklAxis const *self);
extern void hkl_axis_get_range_unit(HklAxis const *self, double *min, double *max);
extern void hkl_axis_set_value(HklAxis *self, double value);
extern void hkl_axis_set_value_smallest_in_range(HklAxis *self);
extern void hkl_axis_set_value_unit(HklAxis *self, double value);
extern void hkl_axis_set_range(HklAxis *self, double min, double max);
extern void hkl_axis_set_range_unit(HklAxis *self, double min, double max);
extern void hkl_axis_randomize(HklAxis *self);
/**
* @brief get the quaternion of an axis.
*
* @param axis
* @param q
*
* inline to speed computation.
*/
extern void hkl_axis_get_quaternion(HklAxis const *self, HklQuaternion *q);
extern int hkl_axis_is_value_compatible_with_range(HklAxis const *self);
extern int hkl_axis_is_valid(const HklAxis *self);
extern void hkl_axis_fprintf(FILE *f, HklAxis *self);
HKL_END_DECLS
#endif /* __HKL_AXIS_H__ */
|