#include <MIDI_Inputs/MCU/AssignmentDisplay.hpp>

Detailed Description

Class that receives and stores the text for the Mackie Control Universal 7-segment assignment display.

Definition at line 16 of file AssignmentDisplay.hpp.

Inheritance diagram for AssignmentDisplay:

Collaboration diagram for AssignmentDisplay:

Data access
void	getText (char *buffer, uint8_t offset=0, uint8_t length=LENGTH) const
	Copy the ASCII text into the given buffer.

char	getCharacterAt (uint8_t index) const
	Get the character at the given index.

void	getDecimalPoints (bool *buffer) const
	Copy the decimal points into the given buffer.

bool	getDecimalPointAt (uint8_t index) const
	Get the decimal point state at the given index.

Printing
size_t	printTo (Print &printer) const override
	Print out the text of the display to the given Print.

Detecting changes
bool	getDirty () const
	Check if the value was updated since the last time the dirty flag was cleared.

void	clearDirty ()
	Clear the dirty flag.

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

bool	isEnabled () const
	Check if this updatable is enabled.

void	moveDown ()
	Move down this element in the list.

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Public Types
using	Matcher

using	Parent

using	MessageType

Public Member Functions
	AssignmentDisplay (Channel channel=Channel_1)

void	reset () override
	Reset the input element to its initial state.

virtual void	handleUpdate (typename Matcher::Result match)=0

bool	updateWith (MessageType midimsg) override
	Receive a new MIDI message and update the internal state.

virtual void	begin ()
	Initialize the input element.

virtual void	update ()
	Update the value of the input element. Used for decaying VU meters etc.

Static Public Member Functions
static bool	updateAllWith (MessageType midimsg)
	Update all.

static void	updateAll ()
	Update all.

static void	beginAll ()
	Begin all.

static void	resetAll ()
	Reset all.

Public Attributes
bool	ignoreReset
	Don't reset the state when calling the `reset` method.

Protected Member Functions
void	handleUpdate (typename Matcher::Result match) override
	Update a single character.

void	fillWithSpaces ()

Protected Attributes
TwoByteRangeMIDIMatcher	matcher

Node *	next = nullptr

Node *	previous = nullptr

Static Protected Attributes
static DoublyLinkedList< MIDIInputElement< Type > >	updatables

Private Attributes
AH::Array< char, LENGTH >	text
	Non-ASCII and not null-terminated.

bool	dirty

Member Typedef Documentation

◆ Matcher

using Matcher

inherited

Definition at line 24 of file SevenSegmentDisplay.hpp.

◆ Parent

using Parent

inherited

Definition at line 25 of file SevenSegmentDisplay.hpp.

◆ MessageType

using MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ AssignmentDisplay()

AssignmentDisplay ( Channel channel = Channel_1 )

inline

Definition at line 18 of file AssignmentDisplay.hpp.

Member Function Documentation

◆ reset()

void reset ( )

inlineoverridevirtualinherited

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

Definition at line 32 of file SevenSegmentDisplay.hpp.

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotectedinherited

Update a single character.

Definition at line 41 of file SevenSegmentDisplay.hpp.

◆ handleUpdate() [2/2]

virtual void handleUpdate ( typename Matcher::Result match )

pure virtualinherited

◆ fillWithSpaces()

void fillWithSpaces ( )

inlineprotectedinherited

Definition at line 54 of file SevenSegmentDisplay.hpp.

◆ getText()

void getText	(	char *	buffer,
		uint8_t	offset = 0,
		uint8_t	length = LENGTH ) const

inlineinherited

Copy the ASCII text into the given buffer.

Parameters

[out]	buffer	The destination to write the text to. Will be null-terminated. Should have a size of at least `length`+1 bytes.
[in]	offset	The offset to start copying from (in the source text, the offset in the destination buffer is always zero).
[in]	length	The number of characters to copy.

Definition at line 73 of file SevenSegmentDisplay.hpp.

◆ getCharacterAt()

char getCharacterAt ( uint8_t index ) const

inlineinherited

Get the character at the given index.

Definition at line 88 of file SevenSegmentDisplay.hpp.

◆ getDecimalPoints()

void getDecimalPoints ( bool * buffer ) const

inlineinherited

Copy the decimal points into the given buffer.

Parameters

[out] buffer The destination to write the decimal points to. Should have a size of at least LENGTH bytes.

Definition at line 97 of file SevenSegmentDisplay.hpp.

◆ getDecimalPointAt()

bool getDecimalPointAt ( uint8_t index ) const

inlineinherited

Get the decimal point state at the given index.

Definition at line 106 of file SevenSegmentDisplay.hpp.

◆ printTo()

size_t printTo ( Print & printer ) const

inlineoverrideinherited

Print out the text of the display to the given Print.

Definition at line 114 of file SevenSegmentDisplay.hpp.

◆ getDirty()

bool getDirty ( ) const

inlineinherited

Check if the value was updated since the last time the dirty flag was cleared.

Definition at line 131 of file SevenSegmentDisplay.hpp.

◆ clearDirty()

void clearDirty ( )

inlineinherited

Clear the dirty flag.

Definition at line 133 of file SevenSegmentDisplay.hpp.

◆ updateWith()

bool updateWith ( MessageType midimsg )

inlineoverridevirtualinherited

Receive a new MIDI message and update the internal state.

Implements MIDIInputElement< Type >.

Definition at line 95 of file MIDIInputElement.hpp.

◆ begin()

template<MIDIMessageType Type>

virtual void begin ( )

inlinevirtualinherited

Initialize the input element.

Reimplemented in VPotRingLEDs, VPotRingLEDs< BankSize >, VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, NumLEDs >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeLEDs< Type, RangeLen >, NoteCCKPRangeLEDs< Type, BankSize, RangeLen >, LCD< BufferSize >, GenericProgramChangeSelector< N, Callback >, and GenericProgramChangeSelector< N, SelectorLEDsCallback< N > >.

Examples: Custom-MIDI-Input-Element.ino, Custom-Note-LED-Input-Element-Callback-FastLED.ino, and Custom-Note-LED-Input-Element-Callback.ino.

Definition at line 34 of file MIDIInputElement.hpp.

◆ update()

template<MIDIMessageType Type>

virtual void update ( )

inlinevirtualinherited

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

Reimplemented in VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, VU, and VU< BankSize >.

Definition at line 40 of file MIDIInputElement.hpp.

◆ updateAllWith()

template<MIDIMessageType Type>

static bool updateAllWith ( MessageType midimsg )

inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll()

template<MIDIMessageType Type>

static void updateAll ( )

inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

template<MIDIMessageType Type>

static void beginAll ( )

inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

template<MIDIMessageType Type>

static void resetAll ( )

inlinestaticinherited

Reset all.

Definition at line 67 of file MIDIInputElement.hpp.

◆ enable() [1/4]

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< MIDIInputElement< Type > > * element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< MIDIInputElement< Type > > & element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 130 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 106 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< MIDIInputElement< Type > > * element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< MIDIInputElement< Type > > & element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 141 of file Updatable.hpp.

◆ isEnabled()

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 120 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ text

AH::Array<char, LENGTH> text

privateinherited

Non-ASCII and not null-terminated.

Definition at line 138 of file SevenSegmentDisplay.hpp.

◆ dirty

bool dirty

privateinherited

Definition at line 139 of file SevenSegmentDisplay.hpp.

◆ ignoreReset

bool ignoreReset

inherited

Don't reset the state when calling the reset method.

This is the default, because in the original MCU, displays don't get reset when a Reset All Controllers message is received.

Definition at line 145 of file SevenSegmentDisplay.hpp.

◆ matcher

TwoByteRangeMIDIMatcher matcher

protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

template<class Node >

Node* next = nullptr

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

template<class Node >

Node* previous = nullptr

protectedinherited

Definition at line 321 of file LinkedList.hpp.

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

AssignmentDisplay.hpp

Detailed Description

Data access

Printing

Detecting changes

Enabling and disabling updatables

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Member Typedef Documentation

◆ Matcher

◆ Parent

◆ MessageType

Constructor & Destructor Documentation

◆ AssignmentDisplay()

Member Function Documentation

◆ reset()

◆ handleUpdate() [1/2]

◆ handleUpdate() [2/2]

◆ fillWithSpaces()

◆ getText()

◆ getCharacterAt()

◆ getDecimalPoints()

◆ getDecimalPointAt()

◆ printTo()

◆ getDirty()

◆ clearDirty()

◆ updateWith()

◆ begin()

◆ update()

◆ updateAllWith()

◆ updateAll()

◆ beginAll()

◆ resetAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ text

◆ dirty

◆ ignoreReset

◆ matcher

◆ updatables

◆ next

◆ previous