Public Member Functions | Protected Attributes | List of all members
XsStatus Class Reference

Status object. More...

#include <xsstatusflag.h>

Public Member Functions

bool anyAccClipped () const
 Return if any acc channel clipped. More...
 
bool anyGyrClipped () const
 Return if any gyr channel clipped. More...
 
bool anyMagClipped () const
 Return if any mag channel clipped. More...
 
void clear ()
 Clear status object. More...
 
XsStatusFlag get () const
 Return statusflag of status object. More...
 
XsStatus const & operator&= (int a)
 Binary AND operator. More...
 
XsStatus const & operator&= (XsStatus const &a)
 Binary AND operator. More...
 
XsStatus const & operator= (int a)
 Assignment operator. More...
 
XsStatus const & operator= (XsStatus const &a)
 Assignment operator. More...
 
XsStatus const & operator|= (int a)
 Binary OR operator. More...
 
XsStatus const & operator|= (XsStatus const &a)
 Binary OR operator. More...
 
void set (int a)
 Set statusflag of status object. More...
 
void set (uint32_t a)
 Set statusflag of status object. More...
 
void set (XsStatus const &a)
 Set statusflag of status object. More...
 
 XsStatus ()
 Status object constructor, clears all flags. More...
 
 XsStatus (const XsStatus &s)
 Status object constructor. More...
 
 XsStatus (int status)
 Status object constructor. More...
 

Protected Attributes

uint32_t m_status
 Statusflag. More...
 

Detailed Description

Status object.

Definition at line 182 of file xsstatusflag.h.

Constructor & Destructor Documentation

◆ XsStatus() [1/3]

XsStatus::XsStatus ( const XsStatus s)
inline

Status object constructor.

Parameters
sXsStatus object to copy from

Definition at line 188 of file xsstatusflag.h.

◆ XsStatus() [2/3]

XsStatus::XsStatus ( int  status)
inline

Status object constructor.

Parameters
statusstatus flags to set in the object

Definition at line 195 of file xsstatusflag.h.

◆ XsStatus() [3/3]

XsStatus::XsStatus ( )
inline

Status object constructor, clears all flags.

Definition at line 200 of file xsstatusflag.h.

Member Function Documentation

◆ anyAccClipped()

bool XsStatus::anyAccClipped ( ) const
inline

Return if any acc channel clipped.

Definition at line 295 of file xsstatusflag.h.

◆ anyGyrClipped()

bool XsStatus::anyGyrClipped ( ) const
inline

Return if any gyr channel clipped.

Definition at line 301 of file xsstatusflag.h.

◆ anyMagClipped()

bool XsStatus::anyMagClipped ( ) const
inline

Return if any mag channel clipped.

Definition at line 307 of file xsstatusflag.h.

◆ clear()

void XsStatus::clear ( )
inline

Clear status object.

Definition at line 313 of file xsstatusflag.h.

◆ get()

XsStatusFlag XsStatus::get ( ) const
inline

Return statusflag of status object.

Definition at line 205 of file xsstatusflag.h.

◆ operator&=() [1/2]

XsStatus const& XsStatus::operator&= ( int  a)
inline

Binary AND operator.

Parameters
aThe mask of flags to keep, clearing other flags
Returns
A reference to this object

Definition at line 288 of file xsstatusflag.h.

◆ operator&=() [2/2]

XsStatus const& XsStatus::operator&= ( XsStatus const &  a)
inline

Binary AND operator.

Parameters
aThe mask of flags to keep, clearing other flags
Returns
A reference to this object

Definition at line 278 of file xsstatusflag.h.

◆ operator=() [1/2]

XsStatus const& XsStatus::operator= ( int  a)
inline

Assignment operator.

Parameters
aThe full status flags to set
Returns
A reference to this object

Definition at line 248 of file xsstatusflag.h.

◆ operator=() [2/2]

XsStatus const& XsStatus::operator= ( XsStatus const &  a)
inline

Assignment operator.

Parameters
aThe Status object to copy from
Returns
A reference to this object

Definition at line 238 of file xsstatusflag.h.

◆ operator|=() [1/2]

XsStatus const& XsStatus::operator|= ( int  a)
inline

Binary OR operator.

Parameters
aThe status flags to set, leaving already set flags as they were
Returns
A reference to this object

Definition at line 268 of file xsstatusflag.h.

◆ operator|=() [2/2]

XsStatus const& XsStatus::operator|= ( XsStatus const &  a)
inline

Binary OR operator.

Parameters
aThe status flags to set, leaving already set flags as they were
Returns
A reference to this object

Definition at line 258 of file xsstatusflag.h.

◆ set() [1/3]

void XsStatus::set ( int  a)
inline

Set statusflag of status object.

Parameters
aThe full status flags to set

Definition at line 229 of file xsstatusflag.h.

◆ set() [2/3]

void XsStatus::set ( uint32_t  a)
inline

Set statusflag of status object.

Parameters
aThe full status flags to set

Definition at line 221 of file xsstatusflag.h.

◆ set() [3/3]

void XsStatus::set ( XsStatus const &  a)
inline

Set statusflag of status object.

Parameters
aThe Status object to copy from

Definition at line 213 of file xsstatusflag.h.

Member Data Documentation

◆ m_status

uint32_t XsStatus::m_status
protected

Statusflag.

Definition at line 319 of file xsstatusflag.h.


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


xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:22