Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
ManyAddresses< NumBanks > Class Template Reference

#include <Banks/BankAddresses.hpp>

Detailed Description

template<uint8_t NumBanks>
class Bankable::ManyAddresses::ManyAddresses< NumBanks >
Template Parameters
NumBanksThe number of bank settings the bank has.

Definition at line 106 of file BankAddresses.hpp.

+ Inheritance diagram for ManyAddresses< NumBanks >:
+ Collaboration diagram for ManyAddresses< NumBanks >:

Public Member Functions

 ManyAddresses (const Bank< NumBanks > &bank, const Array< MIDIAddress, NumBanks > &addresses)
 Constructor. More...
 
MIDIAddress getActiveAddress () const
 
setting_t getRawBankSetting () const
 Get the actual bank setting (no matter whether the element is locked or not). More...
 
setting_t getSelection () const
 Get the bank setting. More...
 
void lock ()
 Lock the bank setting. More...
 
void unlock ()
 Unlock the bank setting. More...
 

Protected Attributes

const OutputBankbank
 

Private Attributes

Array< MIDIAddress, NumBanks > addresses
 
setting_t lockedSetting = UNLOCKED
 

Static Private Attributes

static constexpr setting_t UNLOCKED = NO_SETTING
 

Constructor & Destructor Documentation

◆ ManyAddresses()

ManyAddresses ( const Bank< NumBanks > &  bank,
const Array< MIDIAddress, NumBanks > &  addresses 
)
inline

Constructor.

Parameters
bankThe bank to add this element to.
addressesThe list of alternative addresses.

Definition at line 116 of file BankAddresses.hpp.

Member Function Documentation

◆ getActiveAddress()

MIDIAddress getActiveAddress ( ) const
inline

Definition at line 120 of file BankAddresses.hpp.

◆ getRawBankSetting()

setting_t getRawBankSetting ( ) const
inlineinherited

Get the actual bank setting (no matter whether the element is locked or not).

Definition at line 30 of file BankableAddresses.hpp.

◆ getSelection()

setting_t getSelection ( ) const
inlineinherited

Get the bank setting.

If the element is locked, the bank setting from the moment it was locked is returned.

Definition at line 38 of file BankableAddresses.hpp.

◆ lock()

void lock ( )
inlineinherited

Lock the bank setting.

As long as it's locked, getSelection will return the current setting, independent from the actual bank setting.

Definition at line 48 of file BankableAddresses.hpp.

◆ unlock()

void unlock ( )
inlineinherited

Unlock the bank setting.

After unlocking, getSelection will return the actual bank setting again.

Definition at line 59 of file BankableAddresses.hpp.

Member Data Documentation

◆ addresses

Array<MIDIAddress, NumBanks> addresses
private

Definition at line 123 of file BankAddresses.hpp.

◆ bank

const OutputBank& bank
protectedinherited

Definition at line 62 of file BankableAddresses.hpp.

◆ UNLOCKED

constexpr setting_t UNLOCKED = NO_SETTING
staticconstexprprivateinherited

Definition at line 65 of file BankableAddresses.hpp.

◆ lockedSetting

setting_t lockedSetting = UNLOCKED
privateinherited

Definition at line 66 of file BankableAddresses.hpp.


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