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 Member Functions | Private Member Functions | Static Private Member Functions | List of all members
MCU::IVPotRing Class Referenceabstract

#include <VPotRing.hpp>

Inheritance diagram for MCU::IVPotRing:
Collaboration diagram for MCU::IVPotRing:

Public Member Functions

uint8_t getPosition () const
 Return the position of the V-Pot ring. [0, 11]. More...
 
bool getCenterLed () const
 Return the status of the center LED of the V-Pot ring. More...
 
uint8_t getMode () const
 Return the mode of the V-Pot ring: 0 = single dot, 1 = boost/cut, 2 = wrap, 3 = spread. More...
 
uint8_t getStartOn () const
 Get the first segment that should be on. More...
 
uint8_t getStartOff () const
 Get the first segment that should be off. More...
 

Protected Member Functions

 IVPotRing ()=default
 

Private Member Functions

virtual uint8_t getValue () const =0
 

Static Private Member Functions

static uint8_t getPosition (uint8_t value)
 Extract the position from the raw value. More...
 
static bool getCenterLed (uint8_t value)
 Extract the center LED state from the raw value. More...
 
static uint8_t getMode (uint8_t value)
 Extract the mode from the raw value. More...
 

Detailed Description

Todo:
I'm terrible at naming things.

Definition at line 26 of file VPotRing.hpp.

Constructor & Destructor Documentation

◆ IVPotRing()

MCU::IVPotRing::IVPotRing ( )
protecteddefault

Member Function Documentation

◆ getPosition() [1/2]

uint8_t MCU::IVPotRing::getPosition ( ) const
inline

Return the position of the V-Pot ring. [0, 11].

Definition at line 32 of file VPotRing.hpp.

◆ getCenterLed() [1/2]

bool MCU::IVPotRing::getCenterLed ( ) const
inline

Return the status of the center LED of the V-Pot ring.

Definition at line 34 of file VPotRing.hpp.

◆ getMode() [1/2]

uint8_t MCU::IVPotRing::getMode ( ) const
inline

Return the mode of the V-Pot ring: 0 = single dot, 1 = boost/cut, 2 = wrap, 3 = spread.

Definition at line 37 of file VPotRing.hpp.

◆ getStartOn()

uint8_t MCU::IVPotRing::getStartOn ( ) const
inline

Get the first segment that should be on.

Definition at line 40 of file VPotRing.hpp.

◆ getStartOff()

uint8_t MCU::IVPotRing::getStartOff ( ) const
inline

Get the first segment that should be off.

Definition at line 56 of file VPotRing.hpp.

◆ getValue()

virtual uint8_t MCU::IVPotRing::getValue ( ) const
privatepure virtual

◆ getPosition() [2/2]

static uint8_t MCU::IVPotRing::getPosition ( uint8_t  value)
inlinestaticprivate

Extract the position from the raw value.

Definition at line 72 of file VPotRing.hpp.

◆ getCenterLed() [2/2]

static bool MCU::IVPotRing::getCenterLed ( uint8_t  value)
inlinestaticprivate

Extract the center LED state from the raw value.

Definition at line 77 of file VPotRing.hpp.

◆ getMode() [2/2]

static uint8_t MCU::IVPotRing::getMode ( uint8_t  value)
inlinestaticprivate

Extract the mode from the raw value.

Definition at line 79 of file VPotRing.hpp.


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