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

One operation mode of one device. More...

#include <operation_modes.h>

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

Public Attributes

int value = 0
 The 0x6060 / 0x6061 value.
 
std::string name
 PascalCase identifier, as toString spells it.
 
std::string label
 The profile's or the vendor's own wording.
 
OperationModeKind kind {OperationModeKind::kStandard}
 
std::optional< int > bit
 
std::string abbreviation
 The profile's short form ("csp", "hm", …); empty for manufacturer modes and NoMode.
 
std::optional< bool > supported
 
bool deprecated = false
 Whether the firmware marks the mode deprecated. Only a manufacturer mode carries this.
 

Detailed Description

One operation mode of one device.

Member Data Documentation

◆ abbreviation

std::string mm::node::OperationModeInfo::abbreviation

The profile's short form ("csp", "hm", …); empty for manufacturer modes and NoMode.

◆ bit

std::optional<int> mm::node::OperationModeInfo::bit

The 0x6502 bit that advertises this mode, when one does. Absent for every manufacturer mode and for NoMode, which is always legal and so has no bit.

◆ deprecated

bool mm::node::OperationModeInfo::deprecated = false

Whether the firmware marks the mode deprecated. Only a manufacturer mode carries this.

◆ kind

OperationModeKind mm::node::OperationModeInfo::kind {OperationModeKind::kStandard}

◆ label

std::string mm::node::OperationModeInfo::label

The profile's or the vendor's own wording.

◆ name

std::string mm::node::OperationModeInfo::name

PascalCase identifier, as toString spells it.

◆ supported

std::optional<bool> mm::node::OperationModeInfo::supported

Whether the drive says it supports this mode. Absent, rather than false, for every manufacturer mode: 0x6502 reserves bits 16-31 for the vendor without defining them, so a drive that implements a vendor mode has no way to say so that this code could read. Absent means "the drive does not answer that question", which is not the same as no.

◆ value

int mm::node::OperationModeInfo::value = 0

The 0x6060 / 0x6061 value.


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