MRPT  1.9.9
xsstatusflag.h
Go to the documentation of this file.
1 /* +------------------------------------------------------------------------+
2  | Mobile Robot Programming Toolkit (MRPT) |
3  | https://www.mrpt.org/ |
4  | |
5  | Copyright (c) 2005-2019, Individual contributors, see AUTHORS file |
6  | See: https://www.mrpt.org/Authors - All rights reserved. |
7  | Released under BSD License. See: https://www.mrpt.org/License |
8  +------------------------------------------------------------------------+ */
9 #ifndef XSSTATUSFLAG_H
10 #define XSSTATUSFLAG_H
11 
12 /*! \addtogroup enums Global enumerations
13  @{
14 */
15 /*! \brief Status flags
16  \details These flags define the function of specific bits in the status
17  returned by
18  XsDataPacket::status()
19  \sa XsDataPacket::status()
20 */
21 
23 {
24  /** Is set when the self test result was ok */
26  /** Is set when the computed orientation is valid. The orientation may be
27  invalid during startup or when the sensor data is clipping during violent
28  (for the device) motion */
29  ,
31  /** Is set when the device has a GPS receiver and the receiver says that
32  there is a GPS position fix. */
33  ,
34  XSF_GpsValid = 0x04
35 
36  /** If all of these flags are set, the No Rotation algorithm is running */
37  ,
39  /** If only this flag is set (out of the XSF_NoRotationMask) then the No
40  Rotation algorithm was aborted */
41  ,
43  /** If only this flag is set (out of the XSF_NoRotationMask) then the No
44  Rotation algorithm is running but has rejected samples */
45  ,
47  /** If all these flags are set (out of the XSF_NoRotationMask) then the No
48  Rotation algorithm is running normally */
49  ,
51 
52  ,
53  XSF_ClipAccX = 0x00000100,
54  XSF_ClipAccY = 0x00000200,
55  XSF_ClipAccZ = 0x00000400,
56  XSF_ClipGyrX = 0x00000800,
57  XSF_ClipGyrY = 0x00001000,
58  XSF_ClipGyrZ = 0x00002000,
59  XSF_ClipMagX = 0x00004000,
60  XSF_ClipMagY = 0x00008000,
61  XSF_ClipMagZ = 0x00010000
62 
63  /** When set indicates a sync-in event has been triggered */
64  ,
65  XSF_SyncIn = 0x00200000
66  /** When set Indicates a sync-out event has been generated */
67  ,
68  XSF_SyncOut = 0x00400000
69 
70  /** Mask for the 3 bit filter mode field */
71  ,
72  XSF_FilterMode = 0x03800000
73 };
74 
75 /*! \brief Status flag bit offsets
76  \details Sometimes (rarely) it is necessary to know the bit offset instead
77  of the bit mask (ie when
78  shifting to only keep a subset of flags) for the status flags. This
79  enumeration provides these
80  offsets.
81  \sa XsStatusFlag
82 */
84 {
89 
90  ,
100 
101  ,
104 
105  ,
106  XSFO_FilterMode = 23 // bits 23 -> 23 + XSFO_FilterModeNrOfBits - 1
107  ,
108  XSFO_FilterModeNrOfBits = 3 // note: bit 26 is reserved for future use
109 };
110 
111 /*! @} */
114 
115 #endif // file guard
116 
117 //
118 //#define XS_STATUSFLAG_SELFTEST_OK 0x01
119 //#define XSF_OrientationValid 0x02
120 //#define XS_STATUSFLAG_GPSVALID 0x04
121 //#define XSF_NoRotationMask 0x18
122 //#define XSF_NoRotationRunningNormally 0x18
123 //#define XSF_NoRotationAborted 0x10
124 //#define XSF_NoRotationSamplesRejected 0x08
125 
126 //#define XS_STATUSFLAG_CLIP_ACC_X 0x000100
127 //#define XS_STATUSFLAG_CLIP_ACC_Y 0x000200
128 //#define XS_STATUSFLAG_CLIP_ACC_Z 0x000400
129 //#define XS_STATUSFLAG_CLIP_GYR_X 0x000800
130 //#define XS_STATUSFLAG_CLIP_GYR_Y 0x001000
131 //#define XS_STATUSFLAG_CLIP_GYR_Z 0x002000
132 //#define XS_STATUSFLAG_CLIP_MAG_X 0x004000
133 //#define XS_STATUSFLAG_CLIP_MAG_Y 0x008000
134 //#define XS_STATUSFLAG_CLIP_MAG_Z 0x010000
135 //#define XS_STATUSFLAG_CLIP_ACC_OFFSET 8
XsStatusFlagOffset
Status flag bit offsets.
Definition: xsstatusflag.h:83
XsStatusFlag
Status flags.
Definition: xsstatusflag.h:22
Is set when the self test result was ok.
Definition: xsstatusflag.h:25



Page generated by Doxygen 1.8.14 for MRPT 1.9.9 Git: 8fe78517f Sun Jul 14 19:43:28 2019 +0200 at lun oct 28 02:10:00 CET 2019