mip::commands_3dm::EventControl Struct Reference

#include <commands_3dm.hpp>

Classes
struct	Response

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

Public Attributes
FunctionSelector	function = static_cast<FunctionSelector>(0)
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 const uint8_t	DESCRIPTOR_SET = ::mip::commands_3dm::DESCRIPTOR_SET
static const uint8_t	FIELD_DESCRIPTOR = ::mip::commands_3dm::CMD_EVENT_CONTROL
static const bool	HAS_WRITE_FUNCTION = true
static const bool	HAS_READ_FUNCTION = true
static const bool	HAS_SAVE_FUNCTION = true
static const bool	HAS_LOAD_FUNCTION = true
static const bool	HAS_RESET_FUNCTION = 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 Data Documentation

DESCRIPTOR_SET

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

static

FIELD_DESCRIPTOR

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

static

function

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

HAS_LOAD_FUNCTION

const bool mip::commands_3dm::EventControl::HAS_LOAD_FUNCTION = true

static

HAS_READ_FUNCTION

const bool mip::commands_3dm::EventControl::HAS_READ_FUNCTION = true

static

HAS_RESET_FUNCTION

const bool mip::commands_3dm::EventControl::HAS_RESET_FUNCTION = true

static

HAS_SAVE_FUNCTION

const bool mip::commands_3dm::EventControl::HAS_SAVE_FUNCTION = true

static

HAS_WRITE_FUNCTION

const bool mip::commands_3dm::EventControl::HAS_WRITE_FUNCTION = true

static

instance

uint8_t mip::commands_3dm::EventControl::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.

mode

Mode mip::commands_3dm::EventControl::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.

---

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

• src/mip/definitions/commands_3dm.hpp