#include <MIDI_Outputs/Abstract/MIDIFilteredAnalog.hpp>

Detailed Description

template<class Sender>
class MIDIFilteredAnalog< Sender >

A class for potentiometers and faders that send MIDI events.

The analog input is filtered and hysteresis is applied.

See also: FilteredAnalog

Definition at line 17 of file Abstract/MIDIFilteredAnalog.hpp.

Inheritance diagram for MIDIFilteredAnalog< Sender >:

Collaboration diagram for MIDIFilteredAnalog< Sender >:

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 () final override
	Initialize this updatable.

void	update () final override
	Update this updatable.

void	forcedUpdate ()
	Send the value of the analog input over MIDI, even if the value didn't change.

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

void	invert ()
	Invert the analog value.

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

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

MIDIAddress	getAddress () const
	Get the MIDI address.

void	setAddress (MIDIAddress address)
	Set the MIDI address.

Static Public Member Functions
static constexpr analog_t	getMaxRawValue ()
	Get the maximum value that can be returned from getRawValue.

Public Attributes
Sender	sender

Protected Member Functions
	MIDIFilteredAnalog (pin_t analogPin, MIDIAddress address, const Sender &sender)
	Construct a new MIDIFilteredAnalog.

Protected Attributes
Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Private Types
using	FilteredAnalog = AH::FilteredAnalog<Sender::precision()>

Private Attributes
FilteredAnalog	filteredAnalog

MIDIAddress	address

Member Typedef Documentation

◆ FilteredAnalog

template<class Sender >

using FilteredAnalog = AH::FilteredAnalog<Sender::precision()>

private

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

Constructor & Destructor Documentation

◆ MIDIFilteredAnalog()

template<class Sender >

MIDIFilteredAnalog	(	pin_t	analogPin,
		MIDIAddress	address,
		const Sender &	sender )

inlineprotected

Construct a new MIDIFilteredAnalog.

Parameters

analogPin	The analog input pin with the wiper of the potentiometer connected.
address	The MIDI address to send to.
sender	The MIDI sender to use.

Definition at line 30 of file Abstract/MIDIFilteredAnalog.hpp.

Member Function Documentation

◆ begin()

template<class Sender >

void begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 35 of file Abstract/MIDIFilteredAnalog.hpp.

◆ update()

template<class Sender >

void update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 37 of file Abstract/MIDIFilteredAnalog.hpp.

◆ forcedUpdate()

template<class Sender >

void forcedUpdate ( )

inline

Send the value of the analog input over MIDI, even if the value didn't change.

Definition at line 44 of file Abstract/MIDIFilteredAnalog.hpp.

◆ map()

template<class Sender >

void map ( MappingFunction fn )

inline

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 58 of file Abstract/MIDIFilteredAnalog.hpp.

◆ invert()

template<class Sender >

void invert ( )

inline

Invert the analog value.

Definition at line 61 of file Abstract/MIDIFilteredAnalog.hpp.

◆ getRawValue()

template<class Sender >

analog_t getRawValue ( ) const

inline

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

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

◆ getMaxRawValue()

template<class Sender >

static constexpr analog_t getMaxRawValue ( )

inlinestaticconstexpr

Get the maximum value that can be returned from getRawValue.

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

◆ getValue()

template<class Sender >

analog_t getValue ( ) const

inline

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

Definition at line 80 of file Abstract/MIDIFilteredAnalog.hpp.

◆ getAddress()

template<class Sender >

MIDIAddress getAddress ( ) const

inline

Get the MIDI address.

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

◆ setAddress()

template<class Sender >

void setAddress ( MIDIAddress address )

inline

Set the MIDI address.

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

◆ filteredAnalog

template<class Sender >

FilteredAnalog filteredAnalog

private

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

◆ address

template<class Sender >

MIDIAddress address

private

Definition at line 90 of file Abstract/MIDIFilteredAnalog.hpp.

◆ sender

template<class Sender >

Sender sender

Definition at line 93 of file Abstract/MIDIFilteredAnalog.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/MIDIFilteredAnalog.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Attributes

Member Typedef Documentation

◆ FilteredAnalog

Constructor & Destructor Documentation

◆ MIDIFilteredAnalog()

Member Function Documentation

◆ begin()

◆ update()

◆ forcedUpdate()

◆ map()

◆ invert()

◆ getRawValue()

◆ getMaxRawValue()

◆ getValue()

◆ getAddress()

◆ setAddress()

◆ 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

◆ filteredAnalog

◆ address

◆ sender

◆ updatables

◆ next

◆ previous