0.2.0
Loading...
Searching...
No Matches
NAV::vendor::vectornav::VpeStatus Class Reference

The VPE status bitfield. More...

Public Member Functions

constexpr uint8_t accDisturbance () const
 Extract the acceleration disturbance from the vpe status.
 
constexpr uint8_t accSaturation () const
 Extract the acceleration saturation from the vpe status.
 
constexpr uint8_t attitudeQuality () const
 Extract the attitude quality from the vpe status.
 
constexpr uint8_t gyroSaturation () const
 Extract the gyro saturation from the vpe status.
 
constexpr uint8_t gyroSaturationRecovery () const
 Extract the gyro saturation recovery from the vpe status.
 
constexpr uint8_t knownAccelDisturbance () const
 Extract the known acceleration disturbance from the vpe status.
 
constexpr uint8_t knownMagDisturbance () const
 Extract the known magnetic disturbance from the vpe status.
 
constexpr uint8_t magDisturbance () const
 Extract the magnetic disturbance from the vpe status.
 
constexpr uint8_t magSaturation () const
 Extract the magnetic saturation from the vpe status.
 
VpeStatusoperator= (const uint16_t &status)
 Assignment operator.
 
constexpr uint16_t & status ()
 Returns a reference to the status.
 
 VpeStatus ()=default
 Default constructor.
 
 VpeStatus (uint16_t status)
 

Detailed Description

The VPE status bitfield.

Bit | Name | Description 0+1 | AttitudeQuality | Provides an indication of the quality of the attitude solution. 0 - Excellent, 1 - Good, 2 - Bad, 3 - Not tracking 2 | GyroSaturation | At least one gyro axis is currently saturated. 3 | GyroSaturationRecovery | Filter is in the process of recovering from a gyro saturation event. 4+5 | MagDisturbance | A magnetic DC disturbance has been detected. 0 – No magnetic disturbance. 1 to 3 – Magnetic disturbance is present. 6 | MagSaturation | At least one magnetometer axis is currently saturated. 7+8 | AccDisturbance | A strong acceleration disturbance has been detected. 0 – No acceleration disturbance. 1 to 3 – Acceleration disturbance has been detected. 9 | AccSaturation | At least one accelerometer axis is currently saturated. 11 | KnownMagDisturbance | A known magnetic disturbance has been reported by the user and the magnetometer is currently tuned out. 12 | KnownAccelDisturbance | A known acceleration disturbance has been reported by the user and the accelerometer is currently tuned out.

Constructor & Destructor Documentation

◆ VpeStatus()

NAV::vendor::vectornav::VpeStatus::VpeStatus ( uint16_t status)
inlineexplicit

Constructor

Parameters
[in]statusStatus to set

Member Function Documentation

◆ operator=()

VpeStatus & NAV::vendor::vectornav::VpeStatus::operator= ( const uint16_t & status)
inline

Assignment operator.

Parameters
[in]statusStatus to set

The documentation for this class was generated from the following file: