tap::communication::serial::TerminalSerialCallbackInterface Class Reference

#include <terminal_serial.hpp>

Inheritance diagram for tap::communication::serial::TerminalSerialCallbackInterface:

Public Member Functions
virtual bool	terminalSerialCallback (char *inputLine, modm::IOStream &outputStream, bool streamingEnabled)=0
virtual void	terminalSerialStreamCallback (modm::IOStream &outputStream)=0

Detailed Description

If you would like to interact with the terminal, extend this class and implement the callback.

Member Function Documentation

terminalSerialCallback()

virtual bool tap::communication::serial::TerminalSerialCallbackInterface::terminalSerialCallback ( char *  inputLine, modm::IOStream &  outputStream, bool  streamingEnabled  )

pure virtual

Parameters

[in]	inputLine	The user input to be processed.
[out]	outputStream	The stream to write information to.
[in]	streamingEnabled	Set to true when the streaming is initially enabled. Subsequent interactions with the callback handler will be via terminalSerialStreamCallback until streaming has been disabled.

Returns

true if the inputLine was valid and was parsed correctly, false otherwise.

Implemented in tap::communication::sensors::imu::ImuTerminalSerialHandler, tap::control::SchedulerTerminalHandler, tap::motor::DjiMotorTerminalSerialHandler, and tap::errors::ErrorController.

terminalSerialStreamCallback()

virtual void tap::communication::serial::TerminalSerialCallbackInterface::terminalSerialStreamCallback ( modm::IOStream &  outputStream )

pure virtual

Called repeatedly by the TerminalSerial when in streaming mode.

Implemented in tap::errors::ErrorController, tap::communication::sensors::imu::ImuTerminalSerialHandler, tap::control::SchedulerTerminalHandler, and tap::motor::DjiMotorTerminalSerialHandler.

---

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

• fang-mcb-project/taproot/src/tap/communication/serial/terminal_serial.hpp