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

#include <commands_aiding.hpp>

Classes

struct  Response
 
union  Rotation
 

Public Types

enum  Format : uint8_t { Format::EULER = 1, Format::QUATERNION = 2 }
 

Public Member Functions

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

Static Public Member Functions

static FrameConfig create_sld_all (::mip::FunctionSelector function)
 

Public Attributes

FunctionSelector function = static_cast<FunctionSelector>(0)
 Parameters. More...
 
uint8_t frame_id = 0
 Reference frame number. Limit 4. More...
 
Format format = static_cast<Format>(0)
 Format of the transformation. More...
 
bool tracking_enabled = 0
 If enabled, the Kalman filter will track errors. More...
 
Vector3f translation
 Translation X, Y, and Z. More...
 
Rotation rotation
 Rotation as specified by format. 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_FRAME_CONFIG
 
static constexpr const CompositeDescriptor DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
 
static constexpr const char * NAME = "FrameConfig"
 
static constexpr const char * DOC_NAME = "Frame Configuration"
 
static constexpr const bool HAS_FUNCTION_SELECTOR = true
 

Member Enumeration Documentation

◆ Format

Enumerator
EULER 

Translation vector followed by euler angles (roll, pitch, yaw).

QUATERNION 

Translation vector followed by quaternion (w, x, y, z).

Member Function Documentation

◆ asTuple() [1/2]

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

◆ asTuple() [2/2]

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

◆ create_sld_all()

static FrameConfig mip::commands_aiding::FrameConfig::create_sld_all ( ::mip::FunctionSelector  function)
inlinestatic

◆ extract()

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

◆ insert()

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

Serialization.

Member Data Documentation

◆ DESCRIPTOR

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

◆ DESCRIPTOR_SET

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

Descriptors.

◆ DOC_NAME

constexpr const char* mip::commands_aiding::FrameConfig::DOC_NAME = "Frame Configuration"
staticconstexpr

◆ FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_aiding::FrameConfig::FIELD_DESCRIPTOR = ::mip::commands_aiding::CMD_FRAME_CONFIG
staticconstexpr

◆ format

Format mip::commands_aiding::FrameConfig::format = static_cast<Format>(0)

Format of the transformation.

◆ frame_id

uint8_t mip::commands_aiding::FrameConfig::frame_id = 0

Reference frame number. Limit 4.

◆ function

FunctionSelector mip::commands_aiding::FrameConfig::function = static_cast<FunctionSelector>(0)

Parameters.

◆ HAS_FUNCTION_SELECTOR

constexpr const bool mip::commands_aiding::FrameConfig::HAS_FUNCTION_SELECTOR = true
staticconstexpr

◆ NAME

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

◆ rotation

Rotation mip::commands_aiding::FrameConfig::rotation

Rotation as specified by format.

◆ tracking_enabled

bool mip::commands_aiding::FrameConfig::tracking_enabled = 0

If enabled, the Kalman filter will track errors.

◆ translation

Vector3f mip::commands_aiding::FrameConfig::translation

Translation X, Y, and Z.


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