table3d_axis_io Class Reference

table axis I/O support More...

#include <table3d_axis_io.h>

Static Public Member Functions
static constexpr const int16_byte *	get_converter (axis_domain domain)
	Obtain a converter instance for a given axis domain. More...
static byte	to_byte (axis_domain domain, int16_t value)
	Convert to a byte. More...
static int16_t	from_byte (axis_domain domain, byte in)
	Convert from a byte. More...

Detailed Description

table axis I/O support

Attention

Using constexpr class static variables seems to be the best combination of size and speed - constexpr implies inline, so we can't use it on traditional extern global variables.

Member Function Documentation

from_byte()

static int16_t table3d_axis_io::from_byte ( axis_domain  domain, byte  in  )

inlinestatic

Convert from a byte.

Useful for converting a single value. If converting multiple, probably faster to cache the converter rather than repeatedly calling this function.

Here is the call graph for this function:

Here is the caller graph for this function:

get_converter()

static constexpr const int16_byte * table3d_axis_io::get_converter ( axis_domain  domain )

inlinestaticconstexpr

Obtain a converter instance for a given axis domain.

Often we need to deal internally with values that fit in 16-bits but do not require much accuracy. E.g. RPM. For these values we can save storage space (EEPROM) by scaling to/from 8-bits using a fixed divisor.

The divisor is dependent on the domain. I.e all axes with the same domain use the same divisor

Conversion during I/O is orthogonal to other axis concerns, so is separated and encapsulated here.

Here is the caller graph for this function:

to_byte()

static byte table3d_axis_io::to_byte ( axis_domain  domain, int16_t  value  )

inlinestatic

Convert to a byte.

Useful for converting a single value. If converting multiple, probably faster to cache the converter rather than repeatedly calling this function.

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• speeduino/table3d_axis_io.h
• speeduino/table3d_axis_io.cpp