Source for reading Keyboard inputs. More...

#include <Keyboard.h>

Public Member Functions
	Keyboard ()
	Constructor sets up the terminal in non-canonical mode where input is available immediately without waiting for a newline. More...

	~Keyboard () override
	Destructor. More...

std::string	prefix () const noexcept final
	Prefix of output in the observation dictionary. More...

void	write (Dictionary &output) final
	Write output to a dictionary. More...

Public Member Functions inherited from vulp::observation::Source
virtual	~Source ()
	Destructor is virtual to deallocate lists of observers properly. More...

Detailed Description

Source for reading Keyboard inputs.

Note: This source reads from the standard input, and does not listen to Keyboard events. It can only read one key at a time.; Long key presses will yield an output boolean that goes to true, then false, then stays at true until the key is released. This behavior is tied to the key repetition delay of the keyboard: https://github.com/upkie/vulp/issues/49

Definition at line 71 of file Keyboard.h.

Constructor & Destructor Documentation

vulp::observation::sources::Keyboard::Keyboard ( )

Constructor sets up the terminal in non-canonical mode where input is available immediately without waiting for a newline.

Definition at line 7 of file Keyboard.cpp.

vulp::observation::sources::Keyboard::~Keyboard ( )

override

Destructor.

Definition at line 20 of file Keyboard.cpp.

std::string vulp::observation::sources::Keyboard::prefix ( ) const

inlinefinalvirtualnoexcept

Prefix of output in the observation dictionary.

Definition at line 82 of file Keyboard.h.

void vulp::observation::sources::Keyboard::write ( Dictionary & output )

finalvirtual

Write output to a dictionary.

Parameters

[out] output Dictionary to write observations to.

Definition at line 83 of file Keyboard.cpp.

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