mode_param.h File Reference

Declarative parameter schema embedded in a .opm mode binary. More...

#include <cstdint>
#include "config_generated.h"
#include "modes/mode_api.h"

Namespaces
namespace	op
	Root namespace for the Operator SDK.

Enumerations
enum class	op::modes::op_params::Op : uint8_t {   Eq = 0 , Neq = 1 , Gte = 2 , Lte = 3 ,   Gt = 4 , Lt = 5 }
	Comparison for a parameter's visible_when gate. More...

Detailed Description

Declarative parameter schema embedded in a .opm mode binary.

A mode declares its parameters once as a data table of ParamSpec entries. The firmware reads that table to render a generic settings screen, persist the values, and move values between cores, so a mode gets a full parameter UI without writing any UI code. ParamSpec is packed and size-locked for ABI stability, and every value is stored as an int32_t.

Enumeration Type Documentation

Op

enum class op::modes::op_params::Op : uint8_t

strong

Comparison for a parameter's visible_when gate.

The gate compares the watched parameter's current value against the gate's target value using one of these operators. Written at the call site through the op::params::Op alias, for example op::params::Op::Eq.

Enumerator
Eq	Visible while the watched value equals the target.
Neq	Visible while the watched value differs from the target.
Gte	Visible while the watched value is greater than or equal to the target.
Lte	Visible while the watched value is less than or equal to the target.
Gt	Visible while the watched value is greater than the target.
Lt	Visible while the watched value is less than the target.