mip::commands_3dm::EventControl Struct Reference

#include <commands_3dm.hpp>

Classes
struct	Response

Public Types
enum	Mode : uint8_t { Mode::DISABLED = 0, Mode::ENABLED = 1, Mode::TEST = 2, Mode::TEST_PULSE = 3 }

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

Static Public Member Functions
static EventControl	create_sld_all (::mip::FunctionSelector function)

Public Attributes
FunctionSelector	function = static_cast<FunctionSelector>(0)
	Parameters. More...
uint8_t	instance = 0
	Trigger instance to affect. 0 can be used to apply the mode to all configured triggers, except when the function selector is READ. More...
Mode	mode = static_cast<Mode>(0)
	How to change the trigger state. Except when instance is 0, the corresponding trigger must be configured, i.e. not have type 0. 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_EVENT_CONTROL
static constexpr const CompositeDescriptor	DESCRIPTOR = {DESCRIPTOR_SET, FIELD_DESCRIPTOR}
static constexpr const char *	NAME = "EventControl"
static constexpr const char *	DOC_NAME = "Event Control"
static constexpr const bool	HAS_FUNCTION_SELECTOR = true

Member Enumeration Documentation

Mode

enum mip::commands_3dm::EventControl::Mode : uint8_t

strong

Enumerator
DISABLED	Trigger is disabled.
ENABLED	Trigger is enabled and will work normally.
TEST	Forces the trigger to the active state for testing purposes.
TEST_PULSE	Trigger is forced to the active state for one event cycle only. After the test cycle, the mode reverts to the previous state (either enabled or disabled).

Member Function Documentation

asTuple() [1/2]

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

inline

asTuple() [2/2]

auto mip::commands_3dm::EventControl::asTuple ( )

inline

create_sld_all()

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

inlinestatic

insert()

void mip::commands_3dm::EventControl::insert

(

Serializer &

serializer

)

const

extract()

void mip::commands_3dm::EventControl::extract

(

Serializer &

serializer

)

Member Data Documentation

function

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

instance

uint8_t mip::commands_3dm::EventControl::instance = 0

mode

Mode mip::commands_3dm::EventControl::mode = static_cast<Mode>(0)

DESCRIPTOR_SET

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

staticconstexpr

FIELD_DESCRIPTOR

constexpr const uint8_t mip::commands_3dm::EventControl::FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_EVENT_CONTROL

staticconstexpr

DESCRIPTOR

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

staticconstexpr

NAME

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

staticconstexpr

DOC_NAME

constexpr const char* mip::commands_3dm::EventControl::DOC_NAME = "Event Control"

staticconstexpr

HAS_FUNCTION_SELECTOR

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

staticconstexpr

---

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