MIP_SDK  v3.0.0
MicroStrain Communications Library for embedded systems
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
mip::commands_aiding::MagneticField Struct Reference

#include <commands_aiding.hpp>

Classes

struct  ValidFlags
 

Public Types

typedef void Response
 

Public Member Functions

auto asTuple () const
 
auto asTuple ()
 
void insert (Serializer &serializer) const
 Serialization. More...
 
void extract (Serializer &serializer)
 

Public Attributes

Time time
 Parameters. More...
 
uint8_t frame_id = 0
 Source ID for this estimate (source_id == 0 indicates this sensor, source_id > 0 indicates an external estimate). More...
 
Vector3f magnetic_field
 [G] More...
 
Vector3f uncertainty
 [G] 1-sigma uncertainty. Cannot be 0 unless the corresponding valid flags are 0. More...
 
ValidFlags valid_flags
 Valid flags. Axes with 0 will be completely ignored. More...
 

Static Public Attributes

static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_aiding::DESCRIPTOR_SET
 Descriptors. More...
 
static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_aiding::CMD_MAGNETIC_FIELD
 
static constexpr const CompositeDescriptor DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
 
static constexpr const char * NAME = "MagneticField"
 
static constexpr const char * DOC_NAME = "Magnetic Field"
 
static constexpr const bool HAS_FUNCTION_SELECTOR = false
 

Member Typedef Documentation

◆ Response

Member Function Documentation

◆ asTuple() [1/2]

auto mip::commands_aiding::MagneticField::asTuple ( )
inline

◆ asTuple() [2/2]

auto mip::commands_aiding::MagneticField::asTuple ( ) const
inline

◆ extract()

void mip::commands_aiding::MagneticField::extract ( Serializer serializer)

◆ insert()

void mip::commands_aiding::MagneticField::insert ( Serializer serializer) const

Serialization.

Member Data Documentation

◆ DESCRIPTOR

constexpr const CompositeDescriptor mip::commands_aiding::MagneticField::DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
staticconstexpr

◆ DESCRIPTOR_SET

constexpr const uint8_t mip::commands_aiding::MagneticField::DESCRIPTOR_SET = ::mip::commands_aiding::DESCRIPTOR_SET
staticconstexpr

Descriptors.

◆ DOC_NAME

constexpr const char* mip::commands_aiding::MagneticField::DOC_NAME = "Magnetic Field"
staticconstexpr

◆ FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_aiding::MagneticField::FIELD_DESCRIPTOR = ::mip::commands_aiding::CMD_MAGNETIC_FIELD
staticconstexpr

◆ frame_id

uint8_t mip::commands_aiding::MagneticField::frame_id = 0

Source ID for this estimate (source_id == 0 indicates this sensor, source_id > 0 indicates an external estimate).

◆ HAS_FUNCTION_SELECTOR

constexpr const bool mip::commands_aiding::MagneticField::HAS_FUNCTION_SELECTOR = false
staticconstexpr

◆ magnetic_field

Vector3f mip::commands_aiding::MagneticField::magnetic_field

[G]

◆ NAME

constexpr const char* mip::commands_aiding::MagneticField::NAME = "MagneticField"
staticconstexpr

◆ time

Time mip::commands_aiding::MagneticField::time

Parameters.

Timestamp of the measurement.

◆ uncertainty

Vector3f mip::commands_aiding::MagneticField::uncertainty

[G] 1-sigma uncertainty. Cannot be 0 unless the corresponding valid flags are 0.

◆ valid_flags

ValidFlags mip::commands_aiding::MagneticField::valid_flags

Valid flags. Axes with 0 will be completely ignored.


The documentation for this struct was generated from the following files: