MaxMatrix
Drive chained 8x8 LED dot matrix modules with MAX7219.
Loading...
Searching...
No Matches
MaxMatrixError.h File Reference

Why a call did not do what it was asked. More...

#include "Arduino.h"
#include "MaxMatrixAttributes.h"
#include "MaxMatrixConfig.h"

Go to the source code of this file.

Classes

class  max_matrix::Status
 What a function that can fail returns when it has no value to return. More...
class  max_matrix::Result< ValueType >
 What a getter of a single value returns: the value, or why there is none. More...

Macros

#define MAXMATRIX_REPORT_ERROR(Api, Call)
 Passes on what Call returns, after reporting its error, if it has one, under Api.

Enumerations

enum class  max_matrix::Error : uint8_t {
  kOk = 0 , kOutOfRange , kUnknownChar , kNoText ,
  kNotANumber , kUnknownCommand , kLineTooLong , kNotAFont
}
 Why a call did not do what it was asked; one byte, so that it returns in a register. More...

Detailed Description

Why a call did not do what it was asked.

The error a function of the library returns, alone or together with the value of a getter. What was weighed against it, error domains among them, is in docu/ErrorHandling.md.

Macro Definition Documentation

◆ MAXMATRIX_REPORT_ERROR

#define MAXMATRIX_REPORT_ERROR ( Api,
Call )
Value:
(Call)

Passes on what Call returns, after reporting its error, if it has one, under Api.

With MAXMATRIX_DEV_ERROR_DETECT at STD_OFF it is the bare call: no report, no name in flash, no Serial.

Parameters
ApiThe name of the facade function, as a string literal.
CallThe call of the part below, which returns a Status or a Result.
See also
ReportError()

Enumeration Type Documentation

◆ Error

enum class max_matrix::Error : uint8_t
strong

Why a call did not do what it was asked; one byte, so that it returns in a register.

Enumerator
kOk 

No error.

kOutOfRange 

A coordinate, module, intensity or number beyond its range.

kUnknownChar 

The font has no char for it.

kNoText 

The text is null, or the text of a command empty.

kNotANumber 

The value of a command is empty or holds anything but digits.

kUnknownCommand 

No command has this name.

kLineTooLong 

A command line did not fit into MAXMATRIX_COMMAND_LINE_LENGTH.

kNotAFont 

The font is null, does not start as Font says, or its chars do not fill its array.