UserInputHandlerClass Class Reference

Class used to enqueue and process user inputs. More...

#include <UserInputHandler.h>

Public Member Functions
void	EnqueueKeyInput (Keys_t userKeyInput)
	Enqueue the given key into the circular buffer for later processing.
void	EnqueueUsartInput (uint8_t userDataInput)
	Enqueue the given Usart character into the circular buffer for later processing.
void	EnqueueOnOffButtonInput (OnOffButtons_t userButtonInput)
	Enqueue the given on/off button into the circular buffer for later processing.
void	EnqueueTouchInput (uint16_t touchX, uint16_t touchY, TouchTypes touchType)
	Enqueue the given touch input into the circular buffer for later processing.
void	ProcessInputs ()
	Process all user inputs in the circular buffer until it is empty.

Private Attributes
CircularBuffer< UserInputData, USERINPUT_QUEUE_LENGTH >	_userInputRingBuffer
	Circular buffer holding all user inputs.

Detailed Description

Class used to enqueue and process user inputs.

Member Function Documentation

EnqueueKeyInput()

void UserInputHandlerClass::EnqueueKeyInput ( Keys_t userKeyInput )

inline

Enqueue the given key into the circular buffer for later processing.

The key is only enqueued and no further actions are taken.

Parameters

userKeyInput

Key that should be enqueued.

EnqueueOnOffButtonInput()

void UserInputHandlerClass::EnqueueOnOffButtonInput ( OnOffButtons_t userButtonInput )

inline

Enqueue the given on/off button into the circular buffer for later processing.

The button is only enqueued and no further actions are taken.

Parameters

userButtonInput

Button that should be enqueued.

EnqueueTouchInput()

void UserInputHandlerClass::EnqueueTouchInput ( uint16_t touchX, uint16_t touchY, TouchTypes touchType )

inline

Enqueue the given touch input into the circular buffer for later processing.

The touch input is only enqueued and no further actions are taken.

Parameters

touchX	X touch position that should be enqueued.
touchY	Y touch position that should be enqueued.
touchType	Touch type that should be enqueued.

EnqueueUsartInput()

void UserInputHandlerClass::EnqueueUsartInput ( uint8_t userDataInput )

inline

Enqueue the given Usart character into the circular buffer for later processing.

The character is only enqueued and no further actions are taken.

Parameters

userDataInput

Usart character that should be enqueued.

ProcessInputs()

void UserInputHandlerClass::ProcessInputs

(

)

Process all user inputs in the circular buffer until it is empty.

Keys are send to the ScreenManager, Usart characters to the SCPI parser.

---

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

• /github/workspace/PS_Fgen_FW/UserInputHandler/UserInputHandler.h
• /github/workspace/PS_Fgen_FW/UserInputHandler/UserInputHandler.cpp