A base class for all MIDIOutputElements that can be banked. More...
#include <Banks/BankableAddresses.hpp>
Inheritance diagram for OutputBankableMIDIAddress: Collaboration diagram for OutputBankableMIDIAddress:Public Member Functions | |
| OutputBankableMIDIAddress (const OutputBank &bank, BankType type) | |
| Create a new OutputBankableMIDIAddress object. More... | |
| OutputBankableMIDIAddress (BaseOutputBankConfig config) | |
| Create a new OutputBankableMIDIAddress object. More... | |
| RelativeMIDIAddress | getAddressOffset () const |
| Get the offset relative to the base address. More... | |
| 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 OutputBank & | bank |
Private Attributes | |
| const BankType | type |
| setting_t | lockedSetting = UNLOCKED |
Static Private Attributes | |
| constexpr static setting_t | UNLOCKED = NO_SETTING |
Detailed Description
A base class for all MIDIOutputElements that can be banked.
- Note
- These elements don't have to be updated when the bank setting is changed, because they poll the bank setting each time they send a MIDI event.
They are not added to the bank, they just keep a reference to the bank they're a part of.
- To prevent 'sticky' notes (i.e. a button is pressed, a note on is sent, the bank is changed, the button is released, and the note off is sent to a different address, causing the first note to keep on playing indefinitely), there must be a way to lock the bank setting while a note is playing. Then when it is no longer playing, the bank setting is unlocked.
Definition at line 81 of file BankableAddresses.hpp.
Constructor & Destructor Documentation
◆ OutputBankableMIDIAddress() [1/2]
|
inline |
Create a new OutputBankableMIDIAddress object.
- Parameters
-
bank The bank to add this element to. type What address type to change (address, channel or cable number).
Definition at line 91 of file BankableAddresses.hpp.
◆ OutputBankableMIDIAddress() [2/2]
|
inline |
Create a new OutputBankableMIDIAddress object.
- Parameters
-
config The bank and address type to change.
- See also
- OutputBankableMIDIAddress::OutputBankableMIDIAddress(Bank<N> &, BankType)
Definition at line 102 of file BankableAddresses.hpp.
Member Function Documentation
◆ getAddressOffset()
|
inline |
Get the offset relative to the base address.
Definition at line 108 of file BankableAddresses.hpp.
◆ getRawBankSetting()
|
inlineinherited |
Get the actual bank setting (no matter whether the element is locked or not).
Definition at line 26 of file BankableAddresses.hpp.
◆ getSelection()
|
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 BankableAddresses.hpp.
◆ 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 BankableAddresses.hpp.
◆ unlock()
|
inlineinherited |
Unlock the bank setting.
After unlocking, getSelection will return the actual bank setting again.
Definition at line 55 of file BankableAddresses.hpp.
Member Data Documentation
◆ type
|
private |
Definition at line 119 of file BankableAddresses.hpp.
◆ bank
|
protectedinherited |
Definition at line 58 of file BankableAddresses.hpp.
◆ UNLOCKED
|
staticconstexprprivateinherited |
Definition at line 61 of file BankableAddresses.hpp.
◆ lockedSetting
Definition at line 62 of file BankableAddresses.hpp.
The documentation for this class was generated from the following file:
