Control Surface  1.1.1
MIDI Control Surface library for Arduino
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
BankableMIDIOutput_Base Class Reference

#include <Banks/BankableMIDIOutput.hpp>

Inheritance diagram for BankableMIDIOutput_Base:
Collaboration diagram for BankableMIDIOutput_Base:

Public Member Functions

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 Member Functions

 BankableMIDIOutput_Base (const OutputBank &bank)
 Constructor. More...
 

Protected Attributes

const OutputBankbank
 

Private Attributes

setting_t lockedSetting = UNLOCKED
 

Static Private Attributes

constexpr static setting_t UNLOCKED = NO_SETTING
 

Detailed Description

Definition at line 11 of file BankableMIDIOutput.hpp.

Constructor & Destructor Documentation

◆ BankableMIDIOutput_Base()

BankableMIDIOutput_Base ( const OutputBank bank)
inlineprotected

Constructor.

Parameters
bankThe bank to add this element to.

Definition at line 19 of file BankableMIDIOutput.hpp.

Member Function Documentation

◆ getRawBankSetting()

setting_t getRawBankSetting ( ) const
inline

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 getSelection ( ) const
inline

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 lock ( )
inline

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 unlock ( )
inline

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

◆ bank

const OutputBank& bank
protected

Definition at line 58 of file BankableMIDIOutput.hpp.

◆ UNLOCKED

constexpr static setting_t UNLOCKED = NO_SETTING
staticconstexprprivate

Definition at line 61 of file BankableMIDIOutput.hpp.

◆ lockedSetting

setting_t lockedSetting = UNLOCKED
private

Definition at line 62 of file BankableMIDIOutput.hpp.


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