0.4.1
Loading...
Searching...
No Matches
NAV::vendor::vectornav::TimeStatus Class Reference

The VPE status bitfield. More...

Public Member Functions

constexpr uint8_t dateOk () const
 TimeGps and GpsWeek are valid.
 
TimeStatusoperator= (const uint8_t &status)
 Assignment operator.
 
constexpr uint8_t & status ()
 Returns a reference to the status.
 
constexpr uint8_t timeOk () const
 GpsTow is valid.
 
 TimeStatus ()=default
 Default constructor.
 
 TimeStatus (uint8_t status)
 
constexpr uint8_t utcTimeValid () const
 UTC time is valid.
 

Private Attributes

uint8_t _status
 The storage field.
 

Detailed Description

The VPE status bitfield.

Bit | Name | Description 0 | timeOk | GpsTow is valid. 1 | dateOk | TimeGps and GpsWeek are valid. 2 | utcTimeValid | UTC time is valid.

Definition at line 42 of file VectorNavTypes.hpp.

Constructor & Destructor Documentation

◆ TimeStatus() [1/2]

NAV::vendor::vectornav::TimeStatus::TimeStatus ( uint8_t status)
inlineexplicit

Constructor

Parameters
[in]statusStatus to set

Definition at line 47 of file VectorNavTypes.hpp.

◆ TimeStatus() [2/2]

NAV::vendor::vectornav::TimeStatus::TimeStatus ( )
default

Default constructor.

Member Function Documentation

◆ dateOk()

uint8_t NAV::vendor::vectornav::TimeStatus::dateOk ( ) const
inlinenodiscardconstexpr

TimeGps and GpsWeek are valid.

Definition at line 72 of file VectorNavTypes.hpp.

◆ operator=()

TimeStatus & NAV::vendor::vectornav::TimeStatus::operator= ( const uint8_t & status)
inline

Assignment operator.

Parameters
[in]statusStatus to set

Definition at line 51 of file VectorNavTypes.hpp.

◆ status()

uint8_t & NAV::vendor::vectornav::TimeStatus::status ( )
inlinenodiscardconstexpr

Returns a reference to the status.

Definition at line 61 of file VectorNavTypes.hpp.

◆ timeOk()

uint8_t NAV::vendor::vectornav::TimeStatus::timeOk ( ) const
inlinenodiscardconstexpr

GpsTow is valid.

Definition at line 67 of file VectorNavTypes.hpp.

◆ utcTimeValid()

uint8_t NAV::vendor::vectornav::TimeStatus::utcTimeValid ( ) const
inlinenodiscardconstexpr

UTC time is valid.

Definition at line 77 of file VectorNavTypes.hpp.

Field Documentation

◆ _status

uint8_t NAV::vendor::vectornav::TimeStatus::_status
private

The storage field.

Definition at line 84 of file VectorNavTypes.hpp.


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