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

#include <SysExBuffer.hpp>

Collaboration diagram for SysExBuffer:

Public Member Functions

void start ()
 Start a new SysEx message. More...
 
void end ()
 Finish the current SysEx message. More...
 
bool add (uint8_t data)
 Add a byte to the current SysEx message. More...
 
bool hasSpaceLeft () const
 Check if the buffer has at least 1 byte of free space available. More...
 
bool isReceiving () const
 Check if the buffer is receiving a SysEx message. More...
 
const uint8_t * getBuffer () const
 Get a pointer to the buffer. More...
 
size_t getLength () const
 Get the length of the SysEx message in the buffer. More...
 

Private Attributes

uint8_t SysExBuffer [SYSEX_BUFFER_SIZE]
 
size_t SysExLength = 0
 
bool receiving = false
 

Detailed Description

Definition at line 7 of file SysExBuffer.hpp.

Member Function Documentation

◆ start()

void SysExBuffer::start ( )

Start a new SysEx message.

Definition at line 5 of file SysExBuffer.cpp.

◆ end()

void SysExBuffer::end ( )

Finish the current SysEx message.

Definition at line 11 of file SysExBuffer.cpp.

◆ add()

bool SysExBuffer::add ( uint8_t  data)

Add a byte to the current SysEx message.

Definition at line 16 of file SysExBuffer.cpp.

◆ hasSpaceLeft()

bool SysExBuffer::hasSpaceLeft ( ) const

Check if the buffer has at least 1 byte of free space available.

Definition at line 24 of file SysExBuffer.cpp.

◆ isReceiving()

bool SysExBuffer::isReceiving ( ) const

Check if the buffer is receiving a SysEx message.

Definition at line 31 of file SysExBuffer.cpp.

◆ getBuffer()

const uint8_t * SysExBuffer::getBuffer ( ) const

Get a pointer to the buffer.

Definition at line 33 of file SysExBuffer.cpp.

◆ getLength()

size_t SysExBuffer::getLength ( ) const

Get the length of the SysEx message in the buffer.

Definition at line 35 of file SysExBuffer.cpp.

Member Data Documentation

◆ SysExBuffer

uint8_t SysExBuffer::SysExBuffer[SYSEX_BUFFER_SIZE]
private

Definition at line 9 of file SysExBuffer.hpp.

◆ SysExLength

size_t SysExBuffer::SysExLength = 0
private

Definition at line 10 of file SysExBuffer.hpp.

◆ receiving

bool SysExBuffer::receiving = false
private

Definition at line 11 of file SysExBuffer.hpp.


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