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 | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
MIDIInputElementSysEx Class Referenceabstract

Class for objects that listen for incoming MIDI SysEx events. More...

#include <MIDIInputElementSysEx.hpp>

Inheritance diagram for MIDIInputElementSysEx:
Collaboration diagram for MIDIInputElementSysEx:

Public Member Functions

virtual ~MIDIInputElementSysEx ()
 Destructor. More...
 
virtual void begin ()
 Initialize the input element. More...
 
virtual void reset ()
 Reset the input element to its initial state. More...
 
virtual void update ()
 Update the value of the input element. Used for decaying VU meters etc. More...
 

Static Public Member Functions

static void beginAll ()
 Initialize all MIDIInputElementSysEx elements. More...
 
static void updateAll ()
 Update all MIDIInputElementSysEx elements. More...
 
static void resetAll ()
 Reset all MIDIInputElementSysEx elements to their initial state. More...
 
static void updateAllWith (SysExMessage midimsg)
 Update all MIDIInputElementSysEx elements with a new MIDI message. More...
 

Protected Member Functions

 MIDIInputElementSysEx (uint8_t CN=0)
 Constructor. More...
 

Protected Attributes

MIDIInputElementSysExnext
 
MIDIInputElementSysExprevious
 

Private Member Functions

bool updateWith (SysExMessage midimsg)
 
virtual bool updateImpl (SysExMessage midimsg)=0
 
void moveDown ()
 Move down this element in the linked list of elements. More...
 

Private Attributes

uint8_t CN
 

Static Private Attributes

static DoublyLinkedList< MIDIInputElementSysExelements
 

Detailed Description

Class for objects that listen for incoming MIDI SysEx events.

Definition at line 20 of file MIDIInputElementSysEx.hpp.

Constructor & Destructor Documentation

◆ MIDIInputElementSysEx()

MIDIInputElementSysEx::MIDIInputElementSysEx ( uint8_t  CN = 0)
inlineprotected

Constructor.

Todo:
Documentation.

Definition at line 26 of file MIDIInputElementSysEx.hpp.

◆ ~MIDIInputElementSysEx()

virtual MIDIInputElementSysEx::~MIDIInputElementSysEx ( )
inlinevirtual

Destructor.

Todo:
Documentation.

Definition at line 37 of file MIDIInputElementSysEx.hpp.

Member Function Documentation

◆ begin()

virtual void MIDIInputElementSysEx::begin ( )
inlinevirtual

Initialize the input element.

Definition at line 43 of file MIDIInputElementSysEx.hpp.

◆ reset()

virtual void MIDIInputElementSysEx::reset ( )
inlinevirtual

Reset the input element to its initial state.

Definition at line 46 of file MIDIInputElementSysEx.hpp.

◆ update()

virtual void MIDIInputElementSysEx::update ( )
inlinevirtual

Update the value of the input element. Used for decaying VU meters etc.

Definition at line 49 of file MIDIInputElementSysEx.hpp.

◆ beginAll()

static void MIDIInputElementSysEx::beginAll ( )
inlinestatic

Initialize all MIDIInputElementSysEx elements.

See also
MIDIInputElementSysEx::begin

Definition at line 56 of file MIDIInputElementSysEx.hpp.

◆ updateAll()

static void MIDIInputElementSysEx::updateAll ( )
inlinestatic

Update all MIDIInputElementSysEx elements.

See also
MIDIInputElementSysEx::update

Definition at line 67 of file MIDIInputElementSysEx.hpp.

◆ resetAll()

static void MIDIInputElementSysEx::resetAll ( )
inlinestatic

Reset all MIDIInputElementSysEx elements to their initial state.

See also
MIDIInputElementSysEx::reset

Definition at line 78 of file MIDIInputElementSysEx.hpp.

◆ updateAllWith()

static void MIDIInputElementSysEx::updateAllWith ( SysExMessage  midimsg)
inlinestatic

Update all MIDIInputElementSysEx elements with a new MIDI message.

See also
MIDIInputElementSysEx::updateWith

Definition at line 90 of file MIDIInputElementSysEx.hpp.

◆ updateWith()

bool MIDIInputElementSysEx::updateWith ( SysExMessage  midimsg)
inlineprivate
Todo:
Documentation.

Definition at line 103 of file MIDIInputElementSysEx.hpp.

◆ updateImpl()

virtual bool MIDIInputElementSysEx::updateImpl ( SysExMessage  midimsg)
privatepure virtual
Todo:
Documentation.

Implemented in MCU::LCD< BufferSize >.

◆ moveDown()

void MIDIInputElementSysEx::moveDown ( )
inlineprivate

Move down this element in the linked list of elements.

This means that the element will be checked earlier on the next iteration.

Definition at line 116 of file MIDIInputElementSysEx.hpp.

Member Data Documentation

◆ CN

uint8_t MIDIInputElementSysEx::CN
private

Definition at line 121 of file MIDIInputElementSysEx.hpp.

◆ elements

DoublyLinkedList< MIDIInputElementSysEx > MIDIInputElementSysEx::elements
staticprivate

Definition at line 123 of file MIDIInputElementSysEx.hpp.

◆ next

Definition at line 301 of file LinkedList.hpp.

◆ previous

MIDIInputElementSysEx * DoublyLinkable< MIDIInputElementSysEx >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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