Control Surface new-input
MIDI Control Surface library for Arduino
Public Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
SingleAddress Class Reference

#include <Banks/BankAddresses.hpp>

Detailed Description

Examples
Custom-MIDI-Output-Element-Bankable.ino.

Definition at line 9 of file BankAddresses.hpp.

+ Inheritance diagram for SingleAddress:
+ Collaboration diagram for SingleAddress:

Public Member Functions

 SingleAddress (BaseOutputBankConfig config, MIDIAddress address)
 
MIDIAddress getBaseAddress () const
 
MIDIAddress getActiveAddress () const
 
RelativeMIDIAddress getAddressOffset () const
 Get the offset relative to the base address.
 
setting_t getRawBankSetting () const
 Get the actual bank setting (no matter whether the element is locked or not).
 
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

MIDIAddress address
 
const BankType type
 
setting_t lockedSetting = UNLOCKED
 

Static Private Attributes

constexpr static setting_t UNLOCKED = NO_SETTING
 

Member Function Documentation

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


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