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

A dictionary-local unit definition (ETG.2000 UnitType, Dictionary/UnitTypes). More...

#include <esi_unit.h>

Collaboration diagram for mm::etg::UnitType:
[legend]

Public Attributes

uint8_t notationIndex = 0
 The byte this definition overrides.
 
uint32_t index = 0
 Object index of the unit in the 0x0400.. area (informational).
 
std::string name
 Human-readable name, e.g. "Increments".
 
std::string symbol
 Rendered symbol, e.g. "Inc".
 

Detailed Description

A dictionary-local unit definition (ETG.2000 UnitType, Dictionary/UnitTypes).

An ESI may redefine, per dictionary, what a notation index means. This is not hypothetical: Synapticon's FSoE module dictionaries redefine notation index 0xB6 from the standard "rpm" to "Bit". A dictionary's own table therefore wins over the built-in ETG.1004 catalogue — see esiUnitSymbol.

Member Data Documentation

◆ index

uint32_t mm::etg::UnitType::index = 0

Object index of the unit in the 0x0400.. area (informational).

◆ name

std::string mm::etg::UnitType::name

Human-readable name, e.g. "Increments".

◆ notationIndex

uint8_t mm::etg::UnitType::notationIndex = 0

The byte this definition overrides.

◆ symbol

std::string mm::etg::UnitType::symbol

Rendered symbol, e.g. "Inc".


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