A class of MIDIOutputElements that read the analog input from a potentiometer or fader, and send out 14-bit MIDI Pitch Bend events. More...

#include <MIDI_Outputs/ManyAddresses/PBPotentiometer.hpp>

Inheritance diagram for PBPotentiometer< NumBanks >:

Collaboration diagram for PBPotentiometer< NumBanks >:

Public Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
	PBPotentiometer (const Bank< NumBanks > &bank, pin_t analogPin, const Array< MIDIChannelCN, NumBanks > &addresses)
	Create a new Bankable PBPotentiometer object with the given analog pin and channel. More...

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

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

void	map (MappingFunction fn)
	Specify a mapping function that is applied to the raw analog value before sending. More...

void	invert ()
	Invert the analog value. More...

analog_t	getRawValue () const
	Get the raw value of the analog input (this is the value without applying the filter or the mapping function first). More...

analog_t	getValue () const
	Get the value of the analog input (this is the value after first applying the mapping function). More...

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
PitchBendSender< 10 >	sender

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
ManyAddresses< NumBanks >	address

AH::FilteredAnalog< Sender::precision()>	filteredAnalog

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

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

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

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer 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 LockGuard &) const
	Check if this updatable is enabled. More...

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

void	moveDown (const LockGuard &)
	Move down this element in the list. 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...

Detailed Description

template<setting_t NumBanks>
class Bankable::ManyAddresses::PBPotentiometer< NumBanks >

A class of MIDIOutputElements that read the analog input from a potentiometer or fader, and send out 14-bit MIDI Pitch Bend events.

The analog input is filtered and hysteresis is applied for maximum stability.
The actual precision is "only" 10 bits, because this is the resolution of the built-in ADC, and this is the default resolution used by the Mackie Control Universal protocol.
This version can be banked using an arbitrary list of alternative addresses.

Template Parameters

NumBanks The number of variants/alternative addresses the element has.

Examples: One-Pot-Both-PB-and-CC.ino.

Definition at line 35 of file ManyAddresses/PBPotentiometer.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ PBPotentiometer()

PBPotentiometer	(	const Bank< NumBanks > &	bank,
		pin_t	analogPin,
		const Array< MIDIChannelCN, NumBanks > &	addresses
	)

inline

Create a new Bankable PBPotentiometer object with the given analog pin and channel.

Parameters

bank	The bank that selects the address to use.
analogPin	The analog input pin to read from.
addresses	The list of MIDI channels [CHANNEL_1, CHANNEL_16] and optional Cable Numbers [CABLE_1, CABLE_16].

Definition at line 51 of file ManyAddresses/PBPotentiometer.hpp.

Member Function Documentation

◆ begin()

void begin

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

Definition at line 111 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ update()

void update

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 112 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ map()

void map ( MappingFunction fn )

inlineinherited

Specify a mapping function that is applied to the raw analog value before sending.

Parameters

fn	A function pointer to the mapping function. This function should take the filtered analog value of \( 16 - \mathrm{ANALOG\_FILTER\_SHIFT\_FACTOR} \) bits as a parameter, and should return a value in the same range.

See also: FilteredAnalog::map

Definition at line 129 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ invert()

void invert

inlineinherited

Invert the analog value.

Definition at line 132 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ getRawValue()

analog_t getRawValue

inlineinherited

Get the raw value of the analog input (this is the value without applying the filter or the mapping function first).

Definition at line 138 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ getValue()

analog_t getValue

inlineinherited

Get the value of the analog input (this is the value after first applying the mapping function).

Definition at line 144 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.