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::EchoControl Struct Reference

#include <commands_aiding.hpp>

Classes

struct  Response
 

Public Types

enum  Mode : uint8_t { Mode::SUPPRESS_ACK = 0, Mode::STANDARD = 1, Mode::RESPONSE = 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 EchoControl create_sld_all (::mip::FunctionSelector function)
 

Public Attributes

FunctionSelector function = static_cast<FunctionSelector>(0)
 Parameters. More...
 
Mode mode = static_cast<Mode>(0)
 Controls data echoing. 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_ECHO_CONTROL
 
static constexpr const CompositeDescriptor DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
 
static constexpr const char * NAME = "EchoControl"
 
static constexpr const char * DOC_NAME = "Aiding Command Echo Control"
 
static constexpr const bool HAS_FUNCTION_SELECTOR = true
 

Member Enumeration Documentation

◆ Mode

Enumerator
SUPPRESS_ACK 

Suppresses the usual command ack field for aiding messages.

STANDARD 

Normal ack/nack behavior.

RESPONSE 

Echo the data back as a response.

Member Function Documentation

◆ asTuple() [1/2]

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

◆ asTuple() [2/2]

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

◆ create_sld_all()

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

◆ extract()

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

◆ insert()

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

Serialization.

Member Data Documentation

◆ DESCRIPTOR

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

◆ DESCRIPTOR_SET

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

Descriptors.

◆ DOC_NAME

constexpr const char* mip::commands_aiding::EchoControl::DOC_NAME = "Aiding Command Echo Control"
staticconstexpr

◆ FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_aiding::EchoControl::FIELD_DESCRIPTOR = ::mip::commands_aiding::CMD_ECHO_CONTROL
staticconstexpr

◆ function

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

Parameters.

◆ HAS_FUNCTION_SELECTOR

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

◆ mode

Mode mip::commands_aiding::EchoControl::mode = static_cast<Mode>(0)

Controls data echoing.

◆ NAME

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

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