Class ErrorController
Defined in File error_controller.hpp
Inheritance Relationships
Base Type
public tap::communication::serial::TerminalSerialCallbackInterface
(Class TerminalSerialCallbackInterface)
Class Documentation
-
class ErrorController : public tap::communication::serial::TerminalSerialCallbackInterface
The ErrorController stores the errors that are currently active and allows the user to query errors via the terminal serial interface.
Use the
RAISE_ERROR
macro to add errors to the main ErrorController.Public Types
-
using error_index_t = modm::BoundedDeque<SystemError, ERROR_LIST_MAX_SIZE>::Index
Public Functions
-
inline ErrorController(Drivers *drivers)
-
~ErrorController() = default
-
void addToErrorList(const SystemError &error)
Adds the passed in error to the ErrorController if no identical errors are already in the ErrorController.
- Parameters:
error – [in] The SystemError to add to the ErrorController.
-
void init()
-
virtual bool terminalSerialCallback(char *inputLine, modm::IOStream &outputStream, bool) override
-
inline virtual void terminalSerialStreamCallback(modm::IOStream&) override
Public Static Attributes
-
static std::size_t ERROR_LIST_MAX_SIZE = 16
-
using error_index_t = modm::BoundedDeque<SystemError, ERROR_LIST_MAX_SIZE>::Index