Main MRPT website > C++ reference for MRPT 1.5.6
xsstatusflag.h
Go to the documentation of this file.
1 /* +---------------------------------------------------------------------------+
2  | Mobile Robot Programming Toolkit (MRPT) |
3  | http://www.mrpt.org/ |
4  | |
5  | Copyright (c) 2005-2017, Individual contributors, see AUTHORS file |
6  | See: http://www.mrpt.org/Authors - All rights reserved. |
7  | Released under BSD License. See details in http://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 returned by
17  XsDataPacket::status()
18  \sa XsDataPacket::status()
19 */
20 
22  XSF_SelfTestOk = 0x01 //!< Is set when the self test result was ok
23  ,XSF_OrientationValid = 0x02 //!< Is set when the computed orientation is valid. The orientation may be invalid during startup or when the sensor data is clipping during violent (for the device) motion
24  ,XSF_GpsValid = 0x04 //!< Is set when the device has a GPS receiver and the receiver says that there is a GPS position fix.
25 
26  ,XSF_NoRotationMask = 0x18 //!< If all of these flags are set, the No Rotation algorithm is running
27  ,XSF_NoRotationAborted = 0x10 //!< If only this flag is set (out of the XSF_NoRotationMask) then the No Rotation algorithm was aborted
28  ,XSF_NoRotationSamplesRejected = 0x08 //!< If only this flag is set (out of the XSF_NoRotationMask) then the No Rotation algorithm is running but has rejected samples
29  ,XSF_NoRotationRunningNormally = 0x18 //!< If all these flags are set (out of the XSF_NoRotationMask) then the No Rotation algorithm is running normally
30 
31  ,XSF_ClipAccX = 0x00000100
32  ,XSF_ClipAccY = 0x00000200
33  ,XSF_ClipAccZ = 0x00000400
34  ,XSF_ClipGyrX = 0x00000800
35  ,XSF_ClipGyrY = 0x00001000
36  ,XSF_ClipGyrZ = 0x00002000
37  ,XSF_ClipMagX = 0x00004000
38  ,XSF_ClipMagY = 0x00008000
39  ,XSF_ClipMagZ = 0x00010000
40 
41  ,XSF_SyncIn = 0x00200000 //!< When set indicates a sync-in event has been triggered
42  ,XSF_SyncOut = 0x00400000 //!< When set Indicates a sync-out event has been generated
43 
44  ,XSF_FilterMode = 0x03800000 //!< Mask for the 3 bit filter mode field
45 };
46 
47 /*! \brief Status flag bit offsets
48  \details Sometimes (rarely) it is necessary to know the bit offset instead of the bit mask (ie when
49  shifting to only keep a subset of flags) for the status flags. This enumeration provides these
50  offsets.
51  \sa XsStatusFlag
52 */
58 
68 
71 
72  ,XSFO_FilterMode = 23 // bits 23 -> 23 + XSFO_FilterModeNrOfBits - 1
73  ,XSFO_FilterModeNrOfBits = 3 // note: bit 26 is reserved for future use
74 };
75 
76 /*! @} */
79 
80 #endif // file guard
81 
82 //
83 //#define XS_STATUSFLAG_SELFTEST_OK 0x01
84 //#define XSF_OrientationValid 0x02
85 //#define XS_STATUSFLAG_GPSVALID 0x04
86 //#define XSF_NoRotationMask 0x18
87 //#define XSF_NoRotationRunningNormally 0x18
88 //#define XSF_NoRotationAborted 0x10
89 //#define XSF_NoRotationSamplesRejected 0x08
90 
91 //#define XS_STATUSFLAG_CLIP_ACC_X 0x000100
92 //#define XS_STATUSFLAG_CLIP_ACC_Y 0x000200
93 //#define XS_STATUSFLAG_CLIP_ACC_Z 0x000400
94 //#define XS_STATUSFLAG_CLIP_GYR_X 0x000800
95 //#define XS_STATUSFLAG_CLIP_GYR_Y 0x001000
96 //#define XS_STATUSFLAG_CLIP_GYR_Z 0x002000
97 //#define XS_STATUSFLAG_CLIP_MAG_X 0x004000
98 //#define XS_STATUSFLAG_CLIP_MAG_Y 0x008000
99 //#define XS_STATUSFLAG_CLIP_MAG_Z 0x010000
100 //#define XS_STATUSFLAG_CLIP_ACC_OFFSET 8
Is set when the computed orientation is valid. The orientation may be invalid during startup or when ...
Definition: xsstatusflag.h:23
If all of these flags are set, the No Rotation algorithm is running.
Definition: xsstatusflag.h:26
XsStatusFlagOffset
Status flag bit offsets.
Definition: xsstatusflag.h:53
If all these flags are set (out of the XSF_NoRotationMask) then the No Rotation algorithm is running ...
Definition: xsstatusflag.h:29
When set indicates a sync-in event has been triggered.
Definition: xsstatusflag.h:41
XsStatusFlag
Status flags.
Definition: xsstatusflag.h:21
If only this flag is set (out of the XSF_NoRotationMask) then the No Rotation algorithm is running bu...
Definition: xsstatusflag.h:28
Mask for the 3 bit filter mode field.
Definition: xsstatusflag.h:44
When set Indicates a sync-out event has been generated.
Definition: xsstatusflag.h:42
If only this flag is set (out of the XSF_NoRotationMask) then the No Rotation algorithm was aborted...
Definition: xsstatusflag.h:27
Is set when the device has a GPS receiver and the receiver says that there is a GPS position fix...
Definition: xsstatusflag.h:24
Is set when the self test result was ok.
Definition: xsstatusflag.h:22



Page generated by Doxygen 1.8.6 for MRPT 1.5.6 Git: 4c65e84 Tue Apr 24 08:18:17 2018 +0200 at mar abr 24 08:26:17 CEST 2018