QtFit  0.1
Internal library development documentation
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
magnetometerdatamessage_p.h
Go to the documentation of this file.
1 /*
2  Copyright 2021 Paul Colby
3 
4  This file is part of QtFit.
5 
6  QtFit is free software: you can redistribute it and/or modify
7  it under the terms of the GNU Lesser General Public License as published by
8  the Free Software Foundation, either version 3 of the License, or
9  (at your option) any later version.
10 
11  QtFit is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU Lesser General Public License for more details.
15 
16  You should have received a copy of the GNU Lesser General Public License
17  along with QtFit. If not, see <http://www.gnu.org/licenses/>.
18 */
19 
20 /*!
21  * \file
22  * \note This file is automatcially generated. Any changes here are likely to be overwritten.
23  */
24 
25 /*!
26  * \file
27  * Declares the MagnetometerDataMessagePrivate class.
28  */
29 #ifndef QTFIT_MAGNETOMETERDATAMESSAGE_P_H
30 #define QTFIT_MAGNETOMETERDATAMESSAGE_P_H
31 
32 #include "abstractdatamessage_p.h"
33 
35 
37 
39 
40 public:
41  /*!
42  * The MagnetometerDataMessage FIT message's timestamp field.
43  *
44  * Whole second part of the timestamp
45  */
47 
48  /*!
49  * The MagnetometerDataMessage FIT message's timestampMs field.
50  *
51  * Millisecond part of the timestamp.
52  */
53  quint16 timestampMs;
54 
55  /*!
56  * The MagnetometerDataMessage FIT message's sampleTimeOffset field.
57  *
58  * Each time in the array describes the time at which the compass sample with the corrosponding
59  * index was taken. Limited to 30 samples in each message. The samples may span across seconds.
60  * Array size must match the number of samples in cmps_x and cmps_y and cmps_z
61  */
63 
64  /*!
65  * The MagnetometerDataMessage FIT message's magX field.
66  *
67  * These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples
68  * may span across seconds. A conversion will need to be done on this data once read.
69  */
70  quint16 magX;
71 
72  /*!
73  * The MagnetometerDataMessage FIT message's magY field.
74  *
75  * These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples
76  * may span across seconds. A conversion will need to be done on this data once read.
77  */
78  quint16 magY;
79 
80  /*!
81  * The MagnetometerDataMessage FIT message's magZ field.
82  *
83  * These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples
84  * may span across seconds. A conversion will need to be done on this data once read.
85  */
86  quint16 magZ;
87 
88  /*!
89  * The MagnetometerDataMessage FIT message's calibratedMagX field.
90  *
91  * Calibrated Magnetometer reading
92  */
94 
95  /*!
96  * The MagnetometerDataMessage FIT message's calibratedMagY field.
97  *
98  * Calibrated Magnetometer reading
99  */
101 
102  /*!
103  * The MagnetometerDataMessage FIT message's calibratedMagZ field.
104  *
105  * Calibrated Magnetometer reading
106  */
108 
112 
113 protected:
114  bool setField(const int fieldId, const QByteArray &data,
115  const FitBaseType baseType, const bool bigEndian) override;
116 
117 private:
118  Q_DECLARE_PUBLIC(MagnetometerDataMessage)
119  Q_DISABLE_COPY(MagnetometerDataMessagePrivate)
120 
121 };
122 
124 
125 #endif // QTFIT_MAGNETOMETERDATAMESSAGE_P_H
#define QTFIT_END_NAMESPACE
Macro for ending the QtFit library's top-most namespace (if one is defined).
Definition: QtFit_global.h:78
#define QTFIT_BEGIN_NAMESPACE
Macro for starting the QtFit library's top-most namespace (if one is defined).
Definition: QtFit_global.h:77
Declares the AbstractDataMessagePrivate class.
float calibratedMagY
The MagnetometerDataMessage FIT message's calibratedMagY field.
DateTime timestamp
The MagnetometerDataMessage FIT message's timestamp field.
quint16 timestampMs
The MagnetometerDataMessage FIT message's timestampMs field.
quint16 magY
The MagnetometerDataMessage FIT message's magY field.
quint16 magX
The MagnetometerDataMessage FIT message's magX field.
quint16 magZ
The MagnetometerDataMessage FIT message's magZ field.
quint16 sampleTimeOffset
The MagnetometerDataMessage FIT message's sampleTimeOffset field.
float calibratedMagZ
The MagnetometerDataMessage FIT message's calibratedMagZ field.
float calibratedMagX
The MagnetometerDataMessage FIT message's calibratedMagX field.
bool setField(const int fieldId, const QByteArray &data, const FitBaseType baseType, const bool bigEndian) override
The MagnetometerDataMessage class represents a FIT MagnetometerDataMessage data message.
FitBaseType
Garmin FIT FitBaseType type.
Definition: types.h:3388
DateTime
Seconds since UTC 00:00 Dec 31 1989.
Definition: types.h:237