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

#include <commands_3dm.hpp>

Public Types

enum  Action : uint8_t { Action::OVERWRITE = 0, Action::MERGE = 1, Action::ADD = 2 }
 
typedef void Response
 

Public Member Functions

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

Public Attributes

Action action = static_cast<Action>(0)
 Parameters. More...
 
uint8_t reserved = 0
 Reserved. Set to 0x00. More...
 

Static Public Attributes

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_CONFIGURE_FACTORY_STREAMING
 
static constexpr const CompositeDescriptor DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
 
static constexpr const char * NAME = "FactoryStreaming"
 
static constexpr const char * DOC_NAME = "FactoryStreaming"
 
static constexpr const bool HAS_FUNCTION_SELECTOR = false
 

Member Typedef Documentation

◆ Response

Member Enumeration Documentation

◆ Action

Enumerator
OVERWRITE 

Replaces the message format(s), removing any existing descriptors.

MERGE 

Merges support descriptors into existing format(s). May reorder descriptors.

ADD 

Adds descriptors to the current message format(s) without changing existing descriptors. May result in duplicates.

Member Function Documentation

◆ asTuple() [1/2]

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

◆ asTuple() [2/2]

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

◆ extract()

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

◆ insert()

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

Serialization.

Member Data Documentation

◆ action

Action mip::commands_3dm::FactoryStreaming::action = static_cast<Action>(0)

Parameters.

◆ DESCRIPTOR

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

◆ DESCRIPTOR_SET

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

Descriptors.

◆ DOC_NAME

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

◆ FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_3dm::FactoryStreaming::FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_CONFIGURE_FACTORY_STREAMING
staticconstexpr

◆ HAS_FUNCTION_SELECTOR

constexpr const bool mip::commands_3dm::FactoryStreaming::HAS_FUNCTION_SELECTOR = false
staticconstexpr

◆ NAME

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

◆ reserved

uint8_t mip::commands_3dm::FactoryStreaming::reserved = 0

Reserved. Set to 0x00.


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