Control Surface new-input
MIDI Control Surface library for Arduino
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
UpdatableCRTP< Derived > Class Template Reference

#include <AH/Containers/Updatable.hpp>

Detailed Description

template<class Derived>
class AH::UpdatableCRTP< Derived >

A super class for object that have to be updated regularly.

All instances of this class are kept in a linked list, so it's easy to iterate over all of them to update them.

This version uses static polymorphism using the Curiously Recurring Template Pattern. This requires less virtual function calls.
(Only the destructor is virtual.)

Definition at line 32 of file Updatable.hpp.

+ Inheritance diagram for UpdatableCRTP< Derived >:
+ Collaboration diagram for UpdatableCRTP< Derived >:

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. More...
 
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. More...
 
static void enable (UpdatableCRTP &element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
template<class U , size_t N>
static void enable (U(&array)[N])
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
static void disable (UpdatableCRTP *element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 
static void disable (UpdatableCRTP &element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 
template<class U , size_t N>
static void disable (U(&array)[N])
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 

Public Member Functions

virtual ~UpdatableCRTP () __attribute__((no_sanitize("undefined")))
 Destructor: remove the updatable from the linked list of instances.
 

Protected Member Functions

 UpdatableCRTP () __attribute__((no_sanitize("undefined")))
 Constructor: create an Updatable and add it to the linked list of instances.
 
 UpdatableCRTP (const UpdatableCRTP &) __attribute__((no_sanitize("undefined")))
 
UpdatableCRTPoperator= (const UpdatableCRTP &)
 
 UpdatableCRTP (UpdatableCRTP &&) __attribute__((no_sanitize("undefined")))
 
UpdatableCRTPoperator= (UpdatableCRTP &&)
 

Protected Attributes

Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Member Function Documentation

◆ isEnabled()

bool isEnabled ( ) const
inline

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 124 of file Updatable.hpp.

◆ enable() [1/3]

static void enable ( UpdatableCRTP< Derived > *  element)
inlinestatic

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

Definition at line 129 of file Updatable.hpp.

◆ enable() [2/3]

static void enable ( UpdatableCRTP< Derived > &  element)
inlinestatic

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

Definition at line 131 of file Updatable.hpp.

◆ enable() [3/3]

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

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

Definition at line 134 of file Updatable.hpp.

◆ disable() [1/3]

static void disable ( UpdatableCRTP< Derived > *  element)
inlinestatic

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

Definition at line 140 of file Updatable.hpp.

◆ disable() [2/3]

static void disable ( UpdatableCRTP< Derived > &  element)
inlinestatic

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

Definition at line 142 of file Updatable.hpp.

◆ disable() [3/3]

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

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

Definition at line 145 of file Updatable.hpp.


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