Checks.h File Reference

Declarations for the Checks module. More...

#include "Config.h"

Go to the source code of this file.

Functions
void	checkButtonSetup (Button *btn)
	Check the state of an individual button just setup. More...
void	checkButtonJustPressed (Button *btn)
	Check state of a pressed button just pressed. More...
void	checkButtonJustReleased (Button *btn)
	Check button that has just been released. More...
void	checkButtonJustHeld (Button *btn)
	Check button that has just been held. More...
void	checkButtonJustIdle (Button *btn)
	Check button that has just become or remains idle. More...
void	checkButtonJustClicked (Button *btn)
	Check button that has just been clicked. More...
void	checkButtonJustSingleClicked (Button *btn)
	Check button that has just been single-clicked. More...
void	checkButtonJustDoubleClicked (Button *btn)
	Check button that has just been double-clicked. More...
void	checkButtonIntegrity (Button *btn, ButtonState &state)
	Check integrity of Button invariants (always hold true). More...
void	displayButtonChanges (int index)
	Display button changes to Serial. More...
void	checkButtonListIntegrity ()
	Check integrity of ButtonList invariants (always hold true). More...

Variables
struct ButtonState	btnState [NUM_BUTTONS]
	Previous state for each button. More...

Detailed Description

Declarations for the Checks module.

Copyright

Copyright (c) 2022 John Scott

Definition in file Checks.h.

Function Documentation

checkButtonIntegrity()

void checkButtonIntegrity	(	Button *	btn,
		ButtonState &	state
	)

Check integrity of Button invariants (always hold true).

Parameters

btn	The button to check.
state	The tracked state of the button for comparison.

Definition at line 202 of file Checks.cpp.

checkButtonJustClicked()

void checkButtonJustClicked

(

Button *

btn

)

Check button that has just been clicked.

Parameters

btn	The button to check.

Definition at line 142 of file Checks.cpp.

checkButtonJustDoubleClicked()

void checkButtonJustDoubleClicked

(

Button *

btn

)

Check button that has just been double-clicked.

Parameters

btn	The button to check.

Definition at line 177 of file Checks.cpp.

checkButtonJustHeld()

void checkButtonJustHeld

(

Button *

btn

)

Check button that has just been held.

Parameters

btn	The button to check.

Definition at line 92 of file Checks.cpp.

checkButtonJustIdle()

void checkButtonJustIdle

(

Button *

btn

)

Check button that has just become or remains idle.

Parameters

btn	The button to check.

Definition at line 117 of file Checks.cpp.

checkButtonJustPressed()

void checkButtonJustPressed

(

Button *

btn

)

Check state of a pressed button just pressed.

Parameters

btn	The button to check.

Definition at line 42 of file Checks.cpp.

checkButtonJustReleased()

void checkButtonJustReleased

(

Button *

btn

)

Check button that has just been released.

Parameters

btn	The button to check.

Definition at line 67 of file Checks.cpp.

checkButtonJustSingleClicked()

void checkButtonJustSingleClicked

(

Button *

btn

)

Check button that has just been single-clicked.

Parameters

btn	The button to check.

Definition at line 167 of file Checks.cpp.

checkButtonListIntegrity()

void checkButtonListIntegrity

(

)

Check integrity of ButtonList invariants (always hold true).

Definition at line 286 of file Checks.cpp.

checkButtonSetup()

void checkButtonSetup

(

Button *

btn

)

Check the state of an individual button just setup.

Parameters

btn	The button to check.

Definition at line 17 of file Checks.cpp.

displayButtonChanges()

void displayButtonChanges

(

int

index

)

Display button changes to Serial.

Parameters

index

Which button in the button list to check.

Definition at line 347 of file Checks.cpp.

Variable Documentation

btnState

struct ButtonState btnState[NUM_BUTTONS]

extern

Previous state for each button.

Definition at line 9 of file Checks.cpp.