MIP_SDK  latest-2-g34f3e39
MicroStrain Communications Library for embedded systems
Public Types | Public Member Functions | Public Attributes | List of all members
mip::metadata::ParameterInfo::Condition Struct Reference

#include <mip_structures.hpp>

Public Types

enum  Type : uint8_t { Type::NONE = 0, Type::ENUM = 1 }
 

Public Member Functions

constexpr bool hasCondition () const
 

Public Attributes

Type type = Type::NONE
 Type of condition. More...
 
microstrain::Id paramIdx = {}
 Index of enum parameter identifying whether this parameter is enabled. More...
 
uint16_t value = 0
 Value of the enum parameter which activates this parameter. More...
 

Member Enumeration Documentation

◆ Type

Enumerator
NONE 

No condition, member always valid.

ENUM 

Enum value selector (e.g. for parameters in unions)

Member Function Documentation

◆ hasCondition()

constexpr bool mip::metadata::ParameterInfo::Condition::hasCondition ( ) const
inlineconstexpr

Member Data Documentation

◆ paramIdx

microstrain::Id mip::metadata::ParameterInfo::Condition::paramIdx = {}

Index of enum parameter identifying whether this parameter is enabled.

◆ type

Type mip::metadata::ParameterInfo::Condition::type = Type::NONE

Type of condition.

◆ value

uint16_t mip::metadata::ParameterInfo::Condition::value = 0

Value of the enum parameter which activates this parameter.


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