#include <MIDI_Outputs/Bankable/PBAbsoluteEncoder.hpp>

Detailed Description

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

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

This version can be banked.

Template Parameters

NumBanks The number of banks.

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

Inheritance diagram for PBAbsoluteEncoder< NumBanks >:

Collaboration diagram for PBAbsoluteEncoder< NumBanks >:

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
	PBAbsoluteEncoder (const BankConfig< NumBanks > &config, AHEncoder &&encoder, MIDIChannelCable address, int16_t speedMultiply=1, uint8_t pulsesPerStep=4)
	Construct a new Bankable PBAbsoluteEncoder object with the given pins, channel, speed factor, and number of pulses per step.

void	begin () override
	Initialize this updatable.

void	update () override
	Update this updatable.

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

void	forcedUpdate (setting_t bank)

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

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

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

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

void	setSpeedMultiply (int16_t speedMultiply)

int16_t	getSpeedMultiply () const

int16_t	resetPositionOffset ()

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

Public Attributes
Sender	sender

Protected Attributes
Enc	encoder

BankAddress	address

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

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

Derived *	next

Derived *	previous

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

static DoublyLinkedList< Derived >	updatables

Constructor & Destructor Documentation

◆ PBAbsoluteEncoder()

template<size_t NumBanks>

PBAbsoluteEncoder	(	const BankConfig< NumBanks > &	config,
		AHEncoder &&	encoder,
		MIDIChannelCable	address,
		int16_t	speedMultiply = 1,
		uint8_t	pulsesPerStep = 4 )

inline

Construct a new Bankable PBAbsoluteEncoder object with the given pins, 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 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 56 of file Bankable/PBAbsoluteEncoder.hpp.

Member Function Documentation

◆ begin()

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

◆ forcedUpdate() [1/2]

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

void forcedUpdate ( )

inlineinherited

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

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

◆ forcedUpdate() [2/2]

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

void forcedUpdate ( setting_t bank )

inlineinherited

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

◆ getValue() [1/2]

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

uint16_t getValue ( setting_t bank ) const

inlineinherited

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

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

◆ getValue() [2/2]

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

uint16_t getValue ( ) const

inlineinherited

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

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

◆ setValue() [1/2]

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

void setValue	(	uint16_t	value,
		setting_t	bank )

inlineinherited

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

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

◆ setValue() [2/2]

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

void setValue ( uint16_t value )

inlineinherited

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

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

◆ getMaxValue()

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

static int16_t getMaxValue ( )

inlinestaticinherited

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

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

◆ setSpeedMultiply()

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

void setSpeedMultiply ( int16_t speedMultiply )

inlineinherited

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

◆ getSpeedMultiply()

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

int16_t getSpeedMultiply ( ) const

inlineinherited

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

◆ resetPositionOffset()

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

int16_t resetPositionOffset ( )

inlineinherited

Definition at line 85 of file Bankable/Abstract/MIDIAbsoluteEncoder.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

◆ encoder

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

Enc encoder

protectedinherited

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

◆ address

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

BankAddress address

protectedinherited

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

◆ values

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

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

protectedinherited

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

◆ encstate

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

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

protectedinherited

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

◆ maxValue

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

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

staticconstexprprotectedinherited

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

◆ sender

template<class Enc , uint8_t NumBanks, class BankAddress , class Sender >

Sender sender

inherited

Definition at line 99 of file Bankable/Abstract/MIDIAbsoluteEncoder.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:

Bankable/PBAbsoluteEncoder.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

◆ PBAbsoluteEncoder()

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()

◆ resetPositionOffset()

◆ 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