Motion Master 6.0.0-alpha.86
Next-generation motion control software
Loading...
Searching...
No Matches
mm::node::IntegroVariantOption Struct Reference

One entry of the Integro runtime-variant option catalogue. More...

#include <integro_variant.h>

Collaboration diagram for mm::node::IntegroVariantOption:
[legend]

Public Attributes

uint16_t id = 0
 The code as it appears in the file.
 
std::string_view category
 What the option selects, e.g. "Fieldbus Protocol".
 
std::string_view meaning
 Which choice within that category, e.g. "EtherCAT".
 
std::span< const std::string_view > socVariables
 
std::span< const uint16_t > incompatibleOptionIds
 
std::span< const std::string_view > mpnSegmentCodes
 

Detailed Description

One entry of the Integro runtime-variant option catalogue.

The catalogue is data with no behaviour attached: nothing here acts on socVariables or incompatibleOptionIds — the drive is what enforces them — but they are what make a decoded file legible, so they travel with the entry rather than being looked up somewhere else.

Member Data Documentation

◆ category

std::string_view mm::node::IntegroVariantOption::category

What the option selects, e.g. "Fieldbus Protocol".

◆ id

uint16_t mm::node::IntegroVariantOption::id = 0

The code as it appears in the file.

◆ incompatibleOptionIds

std::span<const uint16_t> mm::node::IntegroVariantOption::incompatibleOptionIds

The other options in this option's category, where the category selects exactly one of them. Empty for an independent flag such as "disable DI1".

A file selects one option per category. A file that selects two from the same category is a development device, set up so one unit can be tested in several configurations.

◆ meaning

std::string_view mm::node::IntegroVariantOption::meaning

Which choice within that category, e.g. "EtherCAT".

◆ mpnSegmentCodes

std::span<const std::string_view> mm::node::IntegroVariantOption::mpnSegmentCodes

Segments of the part number this option corresponds to, e.g. EC for EtherCAT. Empty for an option that is not distinguished in the part number.

◆ socVariables

std::span<const std::string_view> mm::node::IntegroVariantOption::socVariables

The drive's own configuration values this option sets, e.g. adc_phase_current_sensor_gain. Empty for an option the fieldbus firmware acts on rather than the SoC.


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