MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
Public Member Functions | List of all members
mip::DescriptorId Class Reference

A combination of a MIP descriptor pair and u16 ID value. More...

#include <descriptor_id.hpp>

Public Member Functions

 DescriptorId ()
 
 DescriptorId (uint8_t desc_set, uint8_t field_desc, uint16_t index=0)
 
 DescriptorId (CompositeDescriptor desc, uint16_t index=0)
 
 DescriptorId (uint32_t id)
 
bool isNull () const
 
bool isMip () const
 
bool isNonMip () const
 
CompositeDescriptor descriptor () const
 
uint16_t index () const
 
uint32_t asU32 () const
 
bool operator== (const DescriptorId &other) const
 
bool operator!= (const DescriptorId &other) const
 
bool operator<= (const DescriptorId &other) const
 
bool operator>= (const DescriptorId &other) const
 
bool operator< (const DescriptorId &other) const
 
bool operator> (const DescriptorId &other) const
 

Detailed Description

A combination of a MIP descriptor pair and u16 ID value.

Used by CompositeResult as a way to identify both MIP and non-MIP entries.

Constructor & Destructor Documentation

◆ DescriptorId() [1/4]

mip::DescriptorId::DescriptorId ( )
inline

◆ DescriptorId() [2/4]

mip::DescriptorId::DescriptorId ( uint8_t  desc_set,
uint8_t  field_desc,
uint16_t  index = 0 
)
inline

◆ DescriptorId() [3/4]

mip::DescriptorId::DescriptorId ( CompositeDescriptor  desc,
uint16_t  index = 0 
)
inline

◆ DescriptorId() [4/4]

mip::DescriptorId::DescriptorId ( uint32_t  id)
inline

Member Function Documentation

◆ asU32()

uint32_t mip::DescriptorId::asU32 ( ) const
inline

◆ descriptor()

CompositeDescriptor mip::DescriptorId::descriptor ( ) const
inline

◆ index()

uint16_t mip::DescriptorId::index ( ) const
inline

◆ isMip()

bool mip::DescriptorId::isMip ( ) const
inline

◆ isNonMip()

bool mip::DescriptorId::isNonMip ( ) const
inline

◆ isNull()

bool mip::DescriptorId::isNull ( ) const
inline

◆ operator!=()

bool mip::DescriptorId::operator!= ( const DescriptorId other) const
inline

◆ operator<()

bool mip::DescriptorId::operator< ( const DescriptorId other) const
inline

◆ operator<=()

bool mip::DescriptorId::operator<= ( const DescriptorId other) const
inline

◆ operator==()

bool mip::DescriptorId::operator== ( const DescriptorId other) const
inline

◆ operator>()

bool mip::DescriptorId::operator> ( const DescriptorId other) const
inline

◆ operator>=()

bool mip::DescriptorId::operator>= ( const DescriptorId other) const
inline

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