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 | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
Bankable::ManyAddresses::ManyAddresses< NumBanks > Class Template Reference

#include <BankAddresses.hpp>

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

Public Member Functions

 ManyAddresses (const Bank< NumBanks > &bank, const Array< MIDICNChannelAddress, NumBanks > &addresses)
 Constructor. More...
 
MIDICNChannelAddress 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< MIDICNChannelAddress, NumBanks > addresses
 
setting_t lockedSetting = UNLOCKED
 

Static Private Attributes

constexpr static setting_t UNLOCKED = NO_SETTING
 

Detailed Description

template<uint8_t NumBanks>
class Bankable::ManyAddresses::ManyAddresses< NumBanks >

Template Parameters
NumBanksThe number of bank settings the bank has.

Definition at line 72 of file BankAddresses.hpp.

Constructor & Destructor Documentation

◆ ManyAddresses()

template<uint8_t NumBanks>
Bankable::ManyAddresses::ManyAddresses< NumBanks >::ManyAddresses ( const Bank< NumBanks > &  bank,
const Array< MIDICNChannelAddress, NumBanks > &  addresses 
)
inline

Constructor.

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

Definition at line 82 of file BankAddresses.hpp.

Member Function Documentation

◆ getActiveAddress()

template<uint8_t NumBanks>
MIDICNChannelAddress Bankable::ManyAddresses::ManyAddresses< NumBanks >::getActiveAddress ( ) const
inline

Definition at line 86 of file BankAddresses.hpp.

◆ getRawBankSetting()

setting_t BankableMIDIOutput_Base::getRawBankSetting ( ) const
inlineinherited

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

Definition at line 26 of file BankableMIDIOutput.hpp.

◆ getSelection()

setting_t BankableMIDIOutput_Base::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 34 of file BankableMIDIOutput.hpp.

◆ lock()

void BankableMIDIOutput_Base::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 44 of file BankableMIDIOutput.hpp.

◆ unlock()

void BankableMIDIOutput_Base::unlock ( )
inlineinherited

Unlock the bank setting.

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

Definition at line 55 of file BankableMIDIOutput.hpp.

Member Data Documentation

◆ addresses

template<uint8_t NumBanks>
Array<MIDICNChannelAddress, NumBanks> Bankable::ManyAddresses::ManyAddresses< NumBanks >::addresses
private

Definition at line 91 of file BankAddresses.hpp.

◆ bank

const OutputBank& BankableMIDIOutput_Base::bank
protectedinherited

Definition at line 58 of file BankableMIDIOutput.hpp.

◆ UNLOCKED

constexpr static setting_t BankableMIDIOutput_Base::UNLOCKED = NO_SETTING
staticconstexprprivateinherited

Definition at line 61 of file BankableMIDIOutput.hpp.

◆ lockedSetting

setting_t BankableMIDIOutput_Base::lockedSetting = UNLOCKED
privateinherited

Definition at line 62 of file BankableMIDIOutput.hpp.


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