#include <MIDI_Outputs/Abstract/MIDIIncrementDecrementButtons.hpp>

Detailed Description

template<class RelativeSender, class ResetSender>
class MIDIIncrementDecrementButtons< RelativeSender, ResetSender >

An abstract class for two buttons that send incremental MIDI events.

Definition at line 15 of file Abstract/MIDIIncrementDecrementButtons.hpp.

Inheritance diagram for MIDIIncrementDecrementButtons< RelativeSender, ResetSender >:

Collaboration diagram for MIDIIncrementDecrementButtons< RelativeSender, ResetSender >:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

bool	isEnabled () const
	Check if this updatable is enabled.

void	moveDown ()
	Move down this element in the list.

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

template<class U , size_t N>
static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

template<class U , size_t N>
static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class.

static void	updateAll ()
	Update all enabled instances of this class.

Public Member Functions
void	begin () override
	Initialize this updatable.

void	update () override
	Update this updatable.

void	send (long delta, MIDIAddress address)

void	reset ()

void	invert ()

AH::IncrementDecrementButtons::State	getButtonsState () const

MIDIAddress	getAddress () const
	Get the MIDI address.

void	setAddress (MIDIAddress address)
	Set the MIDI address.

MIDIAddress	getResetAddress () const
	Get the MIDI address of the reset action.

void	setResetAddress (MIDIAddress address)
	Set the MIDI address of the reset action.

Public Attributes
RelativeSender	relativeSender

ResetSender	resetSender

Protected Member Functions
	MIDIIncrementDecrementButtons (const AH::IncrementDecrementButtons &buttons, MIDIAddress address, uint8_t multiplier, MIDIAddress resetAddress, const RelativeSender &relativeSender, const ResetSender &resetSender)
	Construct a new MIDIIncrementDecrementButtons.

Protected Attributes
Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Private Attributes
AH::IncrementDecrementButtons	buttons

MIDIAddress	address

uint8_t	multiplier

MIDIAddress	resetAddress

Constructor & Destructor Documentation

◆ MIDIIncrementDecrementButtons()

template<class RelativeSender , class ResetSender >

MIDIIncrementDecrementButtons	(	const AH::IncrementDecrementButtons &	buttons,
		MIDIAddress	address,
		uint8_t	multiplier,
		MIDIAddress	resetAddress,
		const RelativeSender &	relativeSender,
		const ResetSender &	resetSender )

inlineprotected

Construct a new MIDIIncrementDecrementButtons.

Definition at line 22 of file Abstract/MIDIIncrementDecrementButtons.hpp.

Member Function Documentation

◆ begin()

template<class RelativeSender , class ResetSender >

void begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 32 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ update()

template<class RelativeSender , class ResetSender >

void update ( )

inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 34 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ send()

template<class RelativeSender , class ResetSender >

void send	(	long	delta,
		MIDIAddress	address )

inline

Definition at line 53 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ reset()

template<class RelativeSender , class ResetSender >

void reset ( )

inline

Definition at line 57 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ invert()

template<class RelativeSender , class ResetSender >

void invert ( )

inline

See also: AH::Button::invert()

Definition at line 65 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ getButtonsState()

template<class RelativeSender , class ResetSender >

AH::IncrementDecrementButtons::State getButtonsState ( ) const

inline

Definition at line 67 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ getAddress()

template<class RelativeSender , class ResetSender >

MIDIAddress getAddress ( ) const

inline

Get the MIDI address.

Definition at line 72 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ setAddress()

template<class RelativeSender , class ResetSender >

void setAddress ( MIDIAddress address )

inline

Set the MIDI address.

Definition at line 74 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ getResetAddress()

template<class RelativeSender , class ResetSender >

MIDIAddress getResetAddress ( ) const

inline

Get the MIDI address of the reset action.

Definition at line 77 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ setResetAddress()

template<class RelativeSender , class ResetSender >

void setResetAddress ( MIDIAddress address )

inline

Set the MIDI address of the reset action.

Definition at line 79 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ beginAll()

template<class T = NormalUpdatable>

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

◆ enable() [2/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

template<class Derived >

template<class U , size_t N>

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 130 of file Updatable.hpp.

◆ disable() [1/4]

template<class Derived >

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 106 of file Updatable.hpp.

◆ disable() [2/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

template<class Derived >

template<class U , size_t N>

static void disable ( U(&) array[N] )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 141 of file Updatable.hpp.

◆ isEnabled()

template<class Derived >

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 120 of file Updatable.hpp.

◆ moveDown()

template<class Derived >

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ buttons

template<class RelativeSender , class ResetSender >

AH::IncrementDecrementButtons buttons

private

Definition at line 82 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ address

template<class RelativeSender , class ResetSender >

MIDIAddress address

private

Definition at line 83 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ multiplier

template<class RelativeSender , class ResetSender >

uint8_t multiplier

private

Definition at line 84 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ resetAddress

template<class RelativeSender , class ResetSender >

MIDIAddress resetAddress

private

Definition at line 85 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ relativeSender

template<class RelativeSender , class ResetSender >

RelativeSender relativeSender

Definition at line 88 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ resetSender

template<class RelativeSender , class ResetSender >

ResetSender resetSender

Definition at line 89 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ updatables

template<class Derived >

DoublyLinkedList< Derived > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

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

Abstract/MIDIIncrementDecrementButtons.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ MIDIIncrementDecrementButtons()

Member Function Documentation

◆ begin()

◆ update()

◆ send()

◆ reset()

◆ invert()

◆ getButtonsState()

◆ getAddress()

◆ setAddress()

◆ getResetAddress()

◆ setResetAddress()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ buttons

◆ address

◆ multiplier

◆ resetAddress

◆ relativeSender

◆ resetSender

◆ updatables

◆ next

◆ previous