This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
Bankable::MIDIFilteredAnalog< BankAddress, Sender > Class Template Reference

A class for potentiometers and faders that send MIDI events (with only a channel, no address) and that can be added to a Bank. More...

#include <MIDIFilteredAnalog.hpp>

Inheritance diagram for Bankable::MIDIFilteredAnalog< BankAddress, Sender >:
Collaboration diagram for Bankable::MIDIFilteredAnalog< BankAddress, Sender >:

Public Member Functions

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...
 
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 ()
 Check if this updatable is enabled. More...
 

Static Public Member Functions

static void enable (Updatable *element)
 
static void enable (Updatable &element)
 
static void enable (U(&array)[N])
 
static void disable (Updatable< NormalUpdatable > *element)
 
static void disable (Updatable< NormalUpdatable > &element)
 
static void disable (U(&array)[N])
 
static void beginAll ()
 Begin all enabled instances of this class. More...
 
static void updateAll ()
 Update all enabled instances of this class. More...
 

Public Attributes

Sender sender
 

Protected Member Functions

 MIDIFilteredAnalog (const BankAddress &bankAddress, pin_t analogPin, const Sender &sender)
 Construct a new MIDIFilteredAnalog. More...
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Private Attributes

BankAddress address
 
FilteredAnalog< Sender::precision()> filteredAnalog
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class BankAddress, class Sender>
class Bankable::MIDIFilteredAnalog< BankAddress, Sender >

A class for potentiometers and faders that send MIDI events (with only a channel, no address) and that can be added to a Bank.

The analog input is filtered and hysteresis is applied.

See also
FilteredAnalog

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

Constructor & Destructor Documentation

◆ MIDIFilteredAnalog()

template<class BankAddress, class Sender>
Bankable::MIDIFilteredAnalog< BankAddress, Sender >::MIDIFilteredAnalog ( const BankAddress &  bankAddress,
pin_t  analogPin,
const Sender &  sender 
)
inlineprotected

Construct a new MIDIFilteredAnalog.

Parameters
bankAddressThe bankable MIDI address to send to.
analogPinThe analog input pin with the wiper of the potentiometer connected.
senderThe MIDI sender to use.

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

Member Function Documentation

◆ begin()

template<class BankAddress, class Sender>
void Bankable::MIDIFilteredAnalog< BankAddress, Sender >::begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

template<class BankAddress, class Sender>
void Bankable::MIDIFilteredAnalog< BankAddress, Sender >::update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

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

◆ map()

template<class BankAddress, class Sender>
void Bankable::MIDIFilteredAnalog< BankAddress, Sender >::map ( MappingFunction  fn)
inline

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

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

template<class BankAddress, class Sender>
void Bankable::MIDIFilteredAnalog< BankAddress, Sender >::invert ( )
inline

Invert the analog value.

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

◆ getRawValue()

template<class BankAddress, class Sender>
analog_t Bankable::MIDIFilteredAnalog< BankAddress, Sender >::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 138 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ getValue()

template<class BankAddress, class Sender>
analog_t Bankable::MIDIFilteredAnalog< BankAddress, Sender >::getValue ( ) const
inline

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.

◆ enable() [1/4]

void Updatable< NormalUpdatable >::enable ( )
inlineinherited

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

Definition at line 40 of file Updatable.hpp.

◆ enable() [2/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> &  element)
inlinestaticinherited

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

static void Updatable< NormalUpdatable >::enable ( U(&)  array[N])
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< NormalUpdatable >::disable ( )
inlineinherited

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

Definition at line 50 of file Updatable.hpp.

◆ disable() [2/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > *  element)
inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > &  element)
inlinestaticinherited

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

static void Updatable< NormalUpdatable >::disable ( U(&)  array[N])
inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< NormalUpdatable >::isEnabled ( )
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 64 of file Updatable.hpp.

◆ beginAll()

static void Updatable< NormalUpdatable >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll()

static void Updatable< NormalUpdatable >::updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

Member Data Documentation

◆ address

template<class BankAddress, class Sender>
BankAddress Bankable::MIDIFilteredAnalog< BankAddress, Sender >::address
private

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

◆ filteredAnalog

template<class BankAddress, class Sender>
FilteredAnalog<Sender::precision()> Bankable::MIDIFilteredAnalog< BankAddress, Sender >::filteredAnalog
private

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

◆ sender

template<class BankAddress, class Sender>
Sender Bankable::MIDIFilteredAnalog< BankAddress, Sender >::sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > Updatable< NormalUpdatable >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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