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 | Private Attributes | List of all members
OutputBank Class Reference

A class for changing the address of BankableMIDIOutputs. More...

#include <Bank.hpp>

Inheritance diagram for OutputBank:
Collaboration diagram for OutputBank:

Public Member Functions

 OutputBank (uint8_t tracksPerBank=1, setting_t initialSelection=0)
 Create a new OutputBank object. More...
 
void select (setting_t setting)
 Select the given bank setting. More...
 
virtual setting_t getSelection () const
 Get the current bank setting. More...
 
uint8_t getTracksPerBank () const
 Get the number of tracks per bank. More...
 
uint8_t getOffset () const
 Get the offset (number of banks times the index of the selected bank) More...
 

Private Attributes

uint8_t tracksPerBank
 
setting_t bankSetting
 

Detailed Description

A class for changing the address of BankableMIDIOutputs.

Definition at line 20 of file Bank.hpp.

Constructor & Destructor Documentation

◆ OutputBank()

OutputBank::OutputBank ( uint8_t  tracksPerBank = 1,
setting_t  initialSelection = 0 
)
inline

Create a new OutputBank object.

Parameters
tracksPerBankThe number of addresses/tracks to skip for each bank setting.
Must be strictly positive.
initialSelectionThe initial bank setting.

Definition at line 31 of file Bank.hpp.

Member Function Documentation

◆ select()

void OutputBank::select ( setting_t  setting)
inline

Select the given bank setting.

Parameters
settingThe new setting to select.

Definition at line 44 of file Bank.hpp.

◆ getSelection()

virtual setting_t OutputBank::getSelection ( ) const
inlinevirtual

Get the current bank setting.

Reimplemented in Transposer< MINIMUM_SEMITONES, MAXIMUM_SEMITONES >.

Definition at line 49 of file Bank.hpp.

◆ getTracksPerBank()

uint8_t OutputBank::getTracksPerBank ( ) const
inline

Get the number of tracks per bank.

This is the number of addresses/tracks to skip for each bank setting.

Definition at line 55 of file Bank.hpp.

◆ getOffset()

uint8_t OutputBank::getOffset ( ) const
inline

Get the offset (number of banks times the index of the selected bank)

Definition at line 61 of file Bank.hpp.

Member Data Documentation

◆ tracksPerBank

uint8_t OutputBank::tracksPerBank
private

Definition at line 64 of file Bank.hpp.

◆ bankSetting

setting_t OutputBank::bankSetting
private

Definition at line 65 of file Bank.hpp.


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