mip::commands_3dm::EventAction Struct Reference

#include <commands_3dm.hpp>

Classes
struct	GpioParams
struct	MessageParams
union	Parameters
struct	Response

Public Types
enum	Type : uint8_t { Type::NONE = 0, Type::GPIO = 1, Type::MESSAGE = 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 EventAction	create_sld_all (::mip::FunctionSelector function)

Public Attributes
FunctionSelector	function = static_cast<FunctionSelector>(0)
	Parameters. More...
uint8_t	instance = 0
	Action number. When function is SAVE, LOAD, or DEFAULT, this can be 0 to apply to all instances. More...
uint8_t	trigger = 0
	Trigger ID number. More...
Type	type = static_cast<Type>(0)
	Type of action to configure. More...
Parameters	parameters

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_EVENT_ACTION_CONFIG
static constexpr const CompositeDescriptor	DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
static constexpr const char *	NAME = "EventAction"
static constexpr const char *	DOC_NAME = "Event Action Configuration"
static constexpr const bool	HAS_FUNCTION_SELECTOR = true

Member Enumeration Documentation

Type

enum mip::commands_3dm::EventAction::Type : uint8_t

strong

Enumerator
NONE	No action. Parameters should be empty.
GPIO	Control the state of a GPIO pin. See GpioParameters.
MESSAGE	Output a data packet. See MessageParameters.

Member Function Documentation

asTuple() [1/2]

auto mip::commands_3dm::EventAction::asTuple ( )

inline

asTuple() [2/2]

auto mip::commands_3dm::EventAction::asTuple ( ) const

inline

create_sld_all()

static EventAction mip::commands_3dm::EventAction::create_sld_all ( ::mip::FunctionSelector  function )

inlinestatic

extract()

void mip::commands_3dm::EventAction::extract

(

Serializer &

serializer

)

insert()

void mip::commands_3dm::EventAction::insert

(

Serializer &

serializer

)

const

Serialization.

Member Data Documentation

DESCRIPTOR

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

staticconstexpr

DESCRIPTOR_SET

constexpr const uint8_t mip::commands_3dm::EventAction::DESCRIPTOR_SET = ::mip::commands_3dm::DESCRIPTOR_SET

staticconstexpr

Descriptors.

DOC_NAME

constexpr const char* mip::commands_3dm::EventAction::DOC_NAME = "Event Action Configuration"

staticconstexpr

FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_3dm::EventAction::FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_EVENT_ACTION_CONFIG

staticconstexpr

function

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

Parameters.

HAS_FUNCTION_SELECTOR

constexpr const bool mip::commands_3dm::EventAction::HAS_FUNCTION_SELECTOR = true

staticconstexpr

instance

uint8_t mip::commands_3dm::EventAction::instance = 0

Action number. When function is SAVE, LOAD, or DEFAULT, this can be 0 to apply to all instances.

NAME

constexpr const char* mip::commands_3dm::EventAction::NAME = "EventAction"

staticconstexpr

parameters

Parameters mip::commands_3dm::EventAction::parameters

trigger

uint8_t mip::commands_3dm::EventAction::trigger = 0

Trigger ID number.

type

Type mip::commands_3dm::EventAction::type = static_cast<Type>(0)

Type of action to configure.

---

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

• src/cpp/mip/definitions/commands_3dm.hpp
• src/cpp/mip/definitions/commands_3dm.cpp