Control Surface main
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
RealTimeMessage Struct Reference

#include <MIDI_Parsers/MIDI_MessageTypes.hpp>

Detailed Description

Examples
MIDI-Input-Callback.ino, MIDI-Input.ino, MIDI_Pipes-Filter.ino, and Mackie-Control-Universal-Reverse-Engineering.ino.

Definition at line 352 of file MIDI_MessageTypes.hpp.

+ Collaboration diagram for RealTimeMessage:

Public Member Functions

 RealTimeMessage (uint8_t message, Cable cable=Cable_1)
 Constructor. More...
 
 RealTimeMessage (MIDIMessageType message, Cable cable=Cable_1)
 Constructor. More...
 
bool operator== (RealTimeMessage other) const
 
bool operator!= (RealTimeMessage other) const
 
void setMessageType (MIDIMessageType type)
 Set the MIDI message type. More...
 
MIDIMessageType getMessageType () const
 Get the MIDI message type. More...
 
Cable getCable () const
 Get the MIDI USB cable number of the message. More...
 
void setCable (Cable cable)
 Set the MIDI USB cable number of the message. More...
 
bool isValid () const
 Check whether the header is a valid header for a Real-Time message. More...
 

Public Attributes

uint8_t message
 
Cable cable
 

Static Public Attributes

static constexpr auto TimingClock = MIDIMessageType::TimingClock
 
static constexpr auto UndefinedRealTime1
 
static constexpr auto Start = MIDIMessageType::Start
 
static constexpr auto Continue = MIDIMessageType::Continue
 
static constexpr auto Stop = MIDIMessageType::Stop
 
static constexpr auto UndefinedRealTime2
 
static constexpr auto ActiveSensing = MIDIMessageType::ActiveSensing
 
static constexpr auto RESET = MIDIMessageType::SystemReset
 

Constructor & Destructor Documentation

◆ RealTimeMessage() [1/2]

RealTimeMessage ( uint8_t  message,
Cable  cable = Cable_1 
)
inline

Constructor.

Definition at line 354 of file MIDI_MessageTypes.hpp.

◆ RealTimeMessage() [2/2]

RealTimeMessage ( MIDIMessageType  message,
Cable  cable = Cable_1 
)
inline

Constructor.

Definition at line 358 of file MIDI_MessageTypes.hpp.

Member Function Documentation

◆ operator==()

bool operator== ( RealTimeMessage  other) const
inline

Definition at line 364 of file MIDI_MessageTypes.hpp.

◆ operator!=()

bool operator!= ( RealTimeMessage  other) const
inline

Definition at line 367 of file MIDI_MessageTypes.hpp.

◆ setMessageType()

void setMessageType ( MIDIMessageType  type)
inline

Set the MIDI message type.

Definition at line 370 of file MIDI_MessageTypes.hpp.

◆ getMessageType()

MIDIMessageType getMessageType ( ) const
inline

Get the MIDI message type.

Definition at line 374 of file MIDI_MessageTypes.hpp.

◆ getCable()

Cable getCable ( ) const
inline

Get the MIDI USB cable number of the message.

Definition at line 379 of file MIDI_MessageTypes.hpp.

◆ setCable()

void setCable ( Cable  cable)
inline

Set the MIDI USB cable number of the message.

Definition at line 381 of file MIDI_MessageTypes.hpp.

◆ isValid()

bool isValid ( ) const
inline

Check whether the header is a valid header for a Real-Time message.

Definition at line 384 of file MIDI_MessageTypes.hpp.

Member Data Documentation

◆ message

uint8_t message

◆ cable

Cable cable

◆ TimingClock

constexpr auto TimingClock = MIDIMessageType::TimingClock
staticconstexpr

Definition at line 386 of file MIDI_MessageTypes.hpp.

◆ UndefinedRealTime1

constexpr auto UndefinedRealTime1
staticconstexpr
Initial value:

Definition at line 387 of file MIDI_MessageTypes.hpp.

◆ Start

constexpr auto Start = MIDIMessageType::Start
staticconstexpr

Definition at line 389 of file MIDI_MessageTypes.hpp.

◆ Continue

constexpr auto Continue = MIDIMessageType::Continue
staticconstexpr

Definition at line 390 of file MIDI_MessageTypes.hpp.

◆ Stop

constexpr auto Stop = MIDIMessageType::Stop
staticconstexpr

Definition at line 391 of file MIDI_MessageTypes.hpp.

◆ UndefinedRealTime2

constexpr auto UndefinedRealTime2
staticconstexpr
Initial value:

Definition at line 392 of file MIDI_MessageTypes.hpp.

◆ ActiveSensing

constexpr auto ActiveSensing = MIDIMessageType::ActiveSensing
staticconstexpr

Definition at line 394 of file MIDI_MessageTypes.hpp.

◆ RESET

constexpr auto RESET = MIDIMessageType::SystemReset
staticconstexpr

Definition at line 395 of file MIDI_MessageTypes.hpp.


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