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

#include <commands_3dm.hpp>

Classes

struct  Response
 

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

FunctionSelector function = static_cast<FunctionSelector>(0)
 Parameters. More...
 
uint8_t desc_set = 0
 The descriptor set of the stream to control. When function is SAVE, LOAD, or DEFAULT, can be ALL_STREAMS(0) to apply to all descriptor sets. On Generation 5 products, this must be one of the above legacy constants. More...
 
bool enable = 0
 True or false to enable or disable the stream. More...
 

Static Public Attributes

static constexpr const uint8_t LEGACY_IMU_STREAM = 0x01
 
static constexpr const uint8_t LEGACY_GNSS_STREAM = 0x02
 
static constexpr const uint8_t LEGACY_FILTER_STREAM = 0x03
 
static constexpr const uint8_t ALL_STREAMS = 0x00
 
static constexpr const uint8_t DESCRIPTOR_SET = ::mip::commands_3dm::DESCRIPTOR_SET
 Descriptors. More...
 
static constexpr const uint8_t FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_CONTROL_DATA_STREAM
 
static constexpr const CompositeDescriptor DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
 
static constexpr const char * NAME = "DatastreamControl"
 
static constexpr const char * DOC_NAME = "DatastreamControl"
 
static constexpr const bool HAS_FUNCTION_SELECTOR = true
 

Member Function Documentation

◆ asTuple() [1/2]

auto mip::commands_3dm::DatastreamControl::asTuple ( )
inline

◆ asTuple() [2/2]

auto mip::commands_3dm::DatastreamControl::asTuple ( ) const
inline

◆ create_sld_all()

static DatastreamControl mip::commands_3dm::DatastreamControl::create_sld_all ( ::mip::FunctionSelector  function)
inlinestatic

◆ extract()

void mip::commands_3dm::DatastreamControl::extract ( Serializer serializer)

◆ insert()

void mip::commands_3dm::DatastreamControl::insert ( Serializer serializer) const

Serialization.

Member Data Documentation

◆ ALL_STREAMS

constexpr const uint8_t mip::commands_3dm::DatastreamControl::ALL_STREAMS = 0x00
staticconstexpr

◆ desc_set

uint8_t mip::commands_3dm::DatastreamControl::desc_set = 0

The descriptor set of the stream to control. When function is SAVE, LOAD, or DEFAULT, can be ALL_STREAMS(0) to apply to all descriptor sets. On Generation 5 products, this must be one of the above legacy constants.

◆ DESCRIPTOR

constexpr const CompositeDescriptor mip::commands_3dm::DatastreamControl::DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
staticconstexpr

◆ DESCRIPTOR_SET

constexpr const uint8_t mip::commands_3dm::DatastreamControl::DESCRIPTOR_SET = ::mip::commands_3dm::DESCRIPTOR_SET
staticconstexpr

Descriptors.

◆ DOC_NAME

constexpr const char* mip::commands_3dm::DatastreamControl::DOC_NAME = "DatastreamControl"
staticconstexpr

◆ enable

bool mip::commands_3dm::DatastreamControl::enable = 0

True or false to enable or disable the stream.

◆ FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_3dm::DatastreamControl::FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_CONTROL_DATA_STREAM
staticconstexpr

◆ function

FunctionSelector mip::commands_3dm::DatastreamControl::function = static_cast<FunctionSelector>(0)

Parameters.

◆ HAS_FUNCTION_SELECTOR

constexpr const bool mip::commands_3dm::DatastreamControl::HAS_FUNCTION_SELECTOR = true
staticconstexpr

◆ LEGACY_FILTER_STREAM

constexpr const uint8_t mip::commands_3dm::DatastreamControl::LEGACY_FILTER_STREAM = 0x03
staticconstexpr

◆ LEGACY_GNSS_STREAM

constexpr const uint8_t mip::commands_3dm::DatastreamControl::LEGACY_GNSS_STREAM = 0x02
staticconstexpr

◆ LEGACY_IMU_STREAM

constexpr const uint8_t mip::commands_3dm::DatastreamControl::LEGACY_IMU_STREAM = 0x01
staticconstexpr

◆ NAME

constexpr const char* mip::commands_3dm::DatastreamControl::NAME = "DatastreamControl"
staticconstexpr

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