#include <MIDI_Outputs/Bankable/CCAbsoluteEncoder.hpp>

Detailed Description

template<size_t NumBanks>
class Bankable::CCAbsoluteEncoder< NumBanks >

A class of MIDIOutputElements that read the input of a quadrature (rotary) encoder and send out absolute MIDI Control Change events.

This version can be banked.

Template Parameters

NumBanks The number of banks.

Definition at line 24 of file Bankable/CCAbsoluteEncoder.hpp.

Inheritance diagram for CCAbsoluteEncoder< NumBanks >:

Collaboration diagram for CCAbsoluteEncoder< NumBanks >:

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions
	CCAbsoluteEncoder (BankConfig< NumBanks > config, AHEncoder &&encoder, MIDIAddress address, int16_t speedMultiply=1, uint8_t pulsesPerStep=4)
	Construct a new Bankable CCAbsoluteEncoder object with the given pins, controller, channel, speed factor, and number of pulses per step. More...

void	begin () override
	Initialize this updatable. More...

void	update () override
	Update this updatable. More...

void	forcedUpdate ()
	Send the current value over MIDI, even if the position of the encoder didn't change. More...

void	forcedUpdate (setting_t bank)

uint16_t	getValue (setting_t bank) const
	Get the absolute value of the encoder in the given bank. More...

uint16_t	getValue () const
	Get the absolute value of the encoder in the active bank. More...

void	setValue (uint16_t value, setting_t bank)
	Set the absolute value of the encoder in the given bank. More...

void	setValue (uint16_t value)
	Set the absolute value of the encoder in the active bank. More...

void	setSpeedMultiply (int16_t speedMultiply)

int16_t	getSpeedMultiply () const

Static Public Member Functions
static int16_t	getMaxValue ()
	Get the maximum possible value that can be returned by getValue. More...

Public Attributes
Sender	sender

Protected Attributes
Enc	encoder

BankAddress	address

Array< int16_t, NumBanks >	values = {{}}

EncoderState< decltype(encoder.read())>	encstate

Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Static Protected Attributes
static constexpr int16_t	maxValue = uint16_t(1u << Sender::precision()) - 1

static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables

Constructor & Destructor Documentation

◆ CCAbsoluteEncoder()

CCAbsoluteEncoder	(	BankConfig< NumBanks >	config,
		AHEncoder &&	encoder,
		MIDIAddress	address,
		int16_t	speedMultiply = `1`,
		uint8_t	pulsesPerStep = `4`
	)

inline

Construct a new Bankable CCAbsoluteEncoder object with the given pins, controller, channel, speed factor, and number of pulses per step.

Parameters

config	The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
encoder	The Encoder object to use. Usually passed as a list of the two pins connected to the A and B outputs of the encoder, e.g. `{2, 3}`. The internal pull-up resistors will be enabled by the Encoder library.
address	The MIDI address containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
speedMultiply	A constant factor to increase the speed of the rotary encoder. The difference in position will just be multiplied by this factor.
pulsesPerStep	The number of pulses per physical click of the encoder. For a normal encoder, this is 4. If you want to increase the resolution, for the use of Jog wheels, for example, you can go as 1. Whereas a greater speedMultiply factor will increase the speed, increasing the number of pulsesPerStep will result in a lower speed.

Definition at line 58 of file Bankable/CCAbsoluteEncoder.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 35 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ forcedUpdate() [1/2]

void forcedUpdate ( )

inlineinherited

Send the current value over MIDI, even if the position of the encoder didn't change.

Definition at line 54 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ forcedUpdate() [2/2]

void forcedUpdate ( setting_t bank )

inlineinherited

Definition at line 57 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ getValue() [1/2]

uint16_t getValue ( setting_t bank ) const

inlineinherited

Get the absolute value of the encoder in the given bank.

Definition at line 64 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ getValue() [2/2]

uint16_t getValue ( ) const

inlineinherited

Get the absolute value of the encoder in the active bank.

Definition at line 68 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ setValue() [1/2]

void setValue	(	uint16_t	value,
		setting_t	bank
	)

inlineinherited

Set the absolute value of the encoder in the given bank.

Definition at line 73 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ setValue() [2/2]

void setValue ( uint16_t value )

inlineinherited

Set the absolute value of the encoder in the active bank.

Definition at line 77 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ getMaxValue()

static int16_t getMaxValue ( )

inlinestaticinherited

Get the maximum possible value that can be returned by getValue.

Definition at line 80 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ setSpeedMultiply()

void setSpeedMultiply ( int16_t speedMultiply )

inlineinherited

Definition at line 82 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ getSpeedMultiply()

int16_t getSpeedMultiply ( ) const

inlineinherited

Definition at line 85 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 190 of file Updatable.hpp.

◆ enable() [1/4]

void enable ( )

inlineinherited

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

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > * element )

inlinestaticinherited

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

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > & element )

inlinestaticinherited

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

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

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 134 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )

inlineinherited

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

Definition at line 110 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > * element )

inlinestaticinherited

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

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > & element )

inlinestaticinherited

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

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

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 145 of file Updatable.hpp.

◆ isEnabled()

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 124 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

Member Data Documentation

◆ encoder

Enc encoder

protectedinherited

Definition at line 88 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ address

BankAddress address

protectedinherited

Definition at line 89 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ values

Array<int16_t, NumBanks> values = {{}}

protectedinherited

Definition at line 90 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ encstate

EncoderState<decltype(encoder.read())> encstate

protectedinherited

Definition at line 91 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ maxValue

constexpr int16_t maxValue = uint16_t(1u << Sender::precision()) - 1

staticconstexprprotectedinherited

Definition at line 93 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ sender

Sender sender

inherited

Definition at line 96 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 325 of file LinkedList.hpp.

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

Bankable/CCAbsoluteEncoder.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ CCAbsoluteEncoder()

Member Function Documentation

◆ begin()

◆ update()

◆ forcedUpdate() [1/2]

◆ forcedUpdate() [2/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ getMaxValue()

◆ setSpeedMultiply()

◆ getSpeedMultiply()

◆ 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

◆ encoder

◆ address

◆ values

◆ encstate

◆ maxValue

◆ sender

◆ updatables

◆ next

◆ previous