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 | Private Attributes | List of all members
MIDICNChannel Class Reference

A class for saving a MIDI channel and cable number. More...

#include <MIDICNChannelAddress.hpp>

Collaboration diagram for MIDICNChannel:

Public Member Functions

constexpr MIDICNChannel ()
 
constexpr MIDICNChannel (Channel channel, int cableNumber=0)
 
constexpr Channel getChannel () const
 Get the channel [1, 16]. More...
 
constexpr uint8_t getRawChannel () const
 Get the channel as an integer [0, 15]. More...
 
constexpr uint8_t getCableNumber () const
 Get the cable number [0, 15]. More...
 
constexpr bool isValid () const
 Check if the MIDI address is valid. More...
 
constexpr operator bool () const
 Check if the MIDI address is valid. More...
 

Static Public Member Functions

constexpr static MIDICNChannel invalid ()
 

Private Attributes

RawMIDICNChannelAddress addresses
 

Detailed Description

A class for saving a MIDI channel and cable number.

Definition at line 19 of file MIDICNChannelAddress.hpp.

Constructor & Destructor Documentation

◆ MIDICNChannel() [1/2]

constexpr MIDICNChannel::MIDICNChannel ( )
inlineconstexpr

Definition at line 23 of file MIDICNChannelAddress.hpp.

◆ MIDICNChannel() [2/2]

constexpr MIDICNChannel::MIDICNChannel ( Channel  channel,
int  cableNumber = 0 
)
inlineconstexpr

Definition at line 24 of file MIDICNChannelAddress.hpp.

Member Function Documentation

◆ getChannel()

constexpr Channel MIDICNChannel::getChannel ( ) const
inlineconstexpr

Get the channel [1, 16].

Definition at line 33 of file MIDICNChannelAddress.hpp.

◆ getRawChannel()

constexpr uint8_t MIDICNChannel::getRawChannel ( ) const
inlineconstexpr

Get the channel as an integer [0, 15].

Definition at line 38 of file MIDICNChannelAddress.hpp.

◆ getCableNumber()

constexpr uint8_t MIDICNChannel::getCableNumber ( ) const
inlineconstexpr

Get the cable number [0, 15].

Definition at line 41 of file MIDICNChannelAddress.hpp.

◆ isValid()

constexpr bool MIDICNChannel::isValid ( ) const
inlineconstexpr

Check if the MIDI address is valid.

Definition at line 44 of file MIDICNChannelAddress.hpp.

◆ operator bool()

constexpr MIDICNChannel::operator bool ( ) const
inlineexplicitconstexpr

Check if the MIDI address is valid.

See also
isValid

Definition at line 48 of file MIDICNChannelAddress.hpp.

◆ invalid()

constexpr static MIDICNChannel MIDICNChannel::invalid ( )
inlinestaticconstexpr
Examples
One-Pot-Both-PB-and-CC.ino.

Definition at line 50 of file MIDICNChannelAddress.hpp.

Member Data Documentation

◆ addresses

RawMIDICNChannelAddress MIDICNChannel::addresses
private

Definition at line 53 of file MIDICNChannelAddress.hpp.


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