Encoding Class Reference

Base class for encoding operations. More...

#include <Encoding.h>

Inheritance diagram for Encoding:

Static Public Member Functions
static void	customDelay (unsigned long timeInMs)
	Custom delay function to provide a non-blocking delay.
static bool	validIndex (int number, Hand hand)
	Checks whether the given pin number is valid for the specified hand.

Detailed Description

Base class for encoding operations.

This class provides the basic functions for encoding used by its child classes.

Member Function Documentation

customDelay()

static void Encoding::customDelay ( unsigned long timeInMs )

inlinestatic

Custom delay function to provide a non-blocking delay.

This function allows for a non-blocking delay (unlike the blocking delay() function in Arduino), so the program can continue execution while waiting.

Parameters

timeInMs

The delay duration in milliseconds.

validIndex()

static bool Encoding::validIndex ( int number, Hand hand )

inlinestatic

Checks whether the given pin number is valid for the specified hand.

This function validates whether the pin number belongs to the correct hand (left or right) based on the actuator configuration.

Parameters

number	The pin number to be validated.
hand	The hand (left or right) for which the validation is being done.

Returns

True if the pin is valid for the hand; false otherwise.

---

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

• src/Models/EncodingScheme/Encoding.h