JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
littlefoot::LittleFootRemoteHeap< ImplementationClass > Struct Template Reference

This class manages the synchronisation of a remote block of heap memory used by a littlefoot program running on a block. More...

#include <juce_LittleFootRemoteHeap.h>

Collaboration diagram for littlefoot::LittleFootRemoteHeap< ImplementationClass >:
Collaboration graph
[legend]

Classes

struct  ChangeMessage
 
struct  Diff
 

Public Member Functions

 LittleFootRemoteHeap (uint32 blockSizeToUse) noexcept
 
void clear () noexcept
 
uint8 getByte (size_t offset) noexcept
 
void handleACKFromDevice (ImplementationClass &bi, uint32 packetIndex) noexcept
 
void invalidateData () noexcept
 
bool isFullySynced () const noexcept
 
bool isProgramLoaded () noexcept
 
void resetDataRangeToUnknown (size_t offset, size_t size) noexcept
 
void resetDeviceStateToUnknown ()
 
void sendChanges (ImplementationClass &bi, bool forceSend)
 
void setBits (uint32 startBit, uint32 numBits, uint32 value) noexcept
 
void setByte (size_t offset, uint8 value) noexcept
 
void setBytes (size_t offset, const uint8 *data, size_t num) noexcept
 

Static Public Member Functions

static bool isAllZero (const uint8 *data, size_t size) noexcept
 

Public Attributes

const size_t blockSize
 

Static Public Attributes

static constexpr uint16 unknownByte = 0x100
 

Private Member Functions

void dumpStatus ()
 
uint16 * getLatestExpectedDataState () noexcept
 
int getTotalSizeOfMessagesSent () const noexcept
 

Private Attributes

uint16 deviceState [ImplementationClass::maxBlockSize] = { 0 }
 
uint32 lastPacketIndexReceived = 0
 
OwnedArray< ChangeMessage > messagesSent
 
bool needsSyncing = true
 
bool programLoaded = false
 
uint32 programSize = 0
 
bool programStateKnown = true
 
uint8 targetData [ImplementationClass::maxBlockSize] = { 0 }
 

Detailed Description

template<typename ImplementationClass>
struct littlefoot::LittleFootRemoteHeap< ImplementationClass >

This class manages the synchronisation of a remote block of heap memory used by a littlefoot program running on a block.

Data in the block can be changed by calling setByte, setBytes, setBits etc, and these changes will be flushed to the device when sendChanges is called.

{Blocks}

Constructor & Destructor Documentation

◆ LittleFootRemoteHeap()

template<typename ImplementationClass >
littlefoot::LittleFootRemoteHeap< ImplementationClass >::LittleFootRemoteHeap ( uint32  blockSizeToUse)
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDeviceStateToUnknown().

Member Function Documentation

◆ clear()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::clear ( )
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::invalidateData(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::targetData, and juce::zeromem().

◆ dumpStatus()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::dumpStatus ( )
inlineprivate

References DBG, juce::ignoreUnused(), int(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded(), and juce::roundToInt().

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges().

◆ getByte()

template<typename ImplementationClass >
uint8 littlefoot::LittleFootRemoteHeap< ImplementationClass >::getByte ( size_t  offset)
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::blockSize, jassertfalse, and littlefoot::LittleFootRemoteHeap< ImplementationClass >::targetData.

◆ getLatestExpectedDataState()

template<typename ImplementationClass >
uint16* littlefoot::LittleFootRemoteHeap< ImplementationClass >::getLatestExpectedDataState ( )
inlineprivatenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::deviceState, and littlefoot::LittleFootRemoteHeap< ImplementationClass >::messagesSent.

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDataRangeToUnknown(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges().

◆ getTotalSizeOfMessagesSent()

template<typename ImplementationClass >
int littlefoot::LittleFootRemoteHeap< ImplementationClass >::getTotalSizeOfMessagesSent ( ) const
inlineprivatenoexcept

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges().

◆ handleACKFromDevice()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice ( ImplementationClass &  bi,
uint32  packetIndex 
)
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::blockSize, littlefoot::LittleFootRemoteHeap< ImplementationClass >::deviceState, littlefoot::LittleFootRemoteHeap< ImplementationClass >::dumpStatus(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::lastPacketIndexReceived, littlefoot::LittleFootRemoteHeap< ImplementationClass >::messagesSent, littlefoot::LittleFootRemoteHeap< ImplementationClass >::needsSyncing, littlefoot::LittleFootRemoteHeap< ImplementationClass >::programStateKnown, littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDeviceStateToUnknown(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges().

◆ invalidateData()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::invalidateData ( )
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::needsSyncing, and littlefoot::LittleFootRemoteHeap< ImplementationClass >::programStateKnown.

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::clear(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDeviceStateToUnknown(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBits().

◆ isAllZero()

template<typename ImplementationClass >
static bool littlefoot::LittleFootRemoteHeap< ImplementationClass >::isAllZero ( const uint8 *  data,
size_t  size 
)
inlinestaticnoexcept

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges().

◆ isFullySynced()

template<typename ImplementationClass >
bool littlefoot::LittleFootRemoteHeap< ImplementationClass >::isFullySynced ( ) const
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::needsSyncing.

◆ isProgramLoaded()

template<typename ImplementationClass >
bool littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded ( )
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::blockSize, littlefoot::Program::checksumMatches(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::deviceState, littlefoot::Program::getProgramSize(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::programLoaded, littlefoot::LittleFootRemoteHeap< ImplementationClass >::programSize, and littlefoot::LittleFootRemoteHeap< ImplementationClass >::programStateKnown.

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::dumpStatus().

◆ resetDataRangeToUnknown()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDataRangeToUnknown ( size_t  offset,
size_t  size 
)
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::getLatestExpectedDataState(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::unknownByte.

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDeviceStateToUnknown().

◆ resetDeviceStateToUnknown()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDeviceStateToUnknown ( )
inline

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::invalidateData(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::messagesSent, and littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDataRangeToUnknown().

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::LittleFootRemoteHeap().

◆ sendChanges()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges ( ImplementationClass &  bi,
bool  forceSend 
)
inline

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::blockSize, littlefoot::LittleFootRemoteHeap< ImplementationClass >::Diff::createChangeMessage(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::dumpStatus(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::getLatestExpectedDataState(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::getTotalSizeOfMessagesSent(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::isAllZero(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::lastPacketIndexReceived, littlefoot::LittleFootRemoteHeap< ImplementationClass >::messagesSent, littlefoot::LittleFootRemoteHeap< ImplementationClass >::needsSyncing, and littlefoot::LittleFootRemoteHeap< ImplementationClass >::targetData.

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice().

◆ setBits()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBits ( uint32  startBit,
uint32  numBits,
uint32  value 
)
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::blockSize, littlefoot::LittleFootRemoteHeap< ImplementationClass >::invalidateData(), jassertfalse, juce::readLittleEndianBitsInBuffer(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::targetData, and juce::writeLittleEndianBitsInBuffer().

◆ setByte()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::setByte ( size_t  offset,
uint8  value 
)
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::blockSize, jassertfalse, littlefoot::LittleFootRemoteHeap< ImplementationClass >::needsSyncing, littlefoot::LittleFootRemoteHeap< ImplementationClass >::programSize, littlefoot::LittleFootRemoteHeap< ImplementationClass >::programStateKnown, and littlefoot::LittleFootRemoteHeap< ImplementationClass >::targetData.

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBytes().

◆ setBytes()

template<typename ImplementationClass >
void littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBytes ( size_t  offset,
const uint8 *  data,
size_t  num 
)
inlinenoexcept

References littlefoot::LittleFootRemoteHeap< ImplementationClass >::setByte().

Member Data Documentation

◆ blockSize

template<typename ImplementationClass >
const size_t littlefoot::LittleFootRemoteHeap< ImplementationClass >::blockSize

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::Diff::createChangeMessage(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::getByte(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBits(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::setByte().

◆ deviceState

template<typename ImplementationClass >
uint16 littlefoot::LittleFootRemoteHeap< ImplementationClass >::deviceState[ImplementationClass::maxBlockSize] = { 0 }
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::getLatestExpectedDataState(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded().

◆ lastPacketIndexReceived

template<typename ImplementationClass >
uint32 littlefoot::LittleFootRemoteHeap< ImplementationClass >::lastPacketIndexReceived = 0
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges().

◆ messagesSent

template<typename ImplementationClass >
OwnedArray<ChangeMessage> littlefoot::LittleFootRemoteHeap< ImplementationClass >::messagesSent
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::getLatestExpectedDataState(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDeviceStateToUnknown(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges().

◆ needsSyncing

template<typename ImplementationClass >
bool littlefoot::LittleFootRemoteHeap< ImplementationClass >::needsSyncing = true
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::invalidateData(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::isFullySynced(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::setByte().

◆ programLoaded

template<typename ImplementationClass >
bool littlefoot::LittleFootRemoteHeap< ImplementationClass >::programLoaded = false
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded().

◆ programSize

template<typename ImplementationClass >
uint32 littlefoot::LittleFootRemoteHeap< ImplementationClass >::programSize = 0
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::setByte().

◆ programStateKnown

template<typename ImplementationClass >
bool littlefoot::LittleFootRemoteHeap< ImplementationClass >::programStateKnown = true
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::handleACKFromDevice(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::invalidateData(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::isProgramLoaded(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::setByte().

◆ targetData

template<typename ImplementationClass >
uint8 littlefoot::LittleFootRemoteHeap< ImplementationClass >::targetData[ImplementationClass::maxBlockSize] = { 0 }
private

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::clear(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::getByte(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::sendChanges(), littlefoot::LittleFootRemoteHeap< ImplementationClass >::setBits(), and littlefoot::LittleFootRemoteHeap< ImplementationClass >::setByte().

◆ unknownByte

template<typename ImplementationClass >
constexpr uint16 littlefoot::LittleFootRemoteHeap< ImplementationClass >::unknownByte = 0x100
static

Referenced by littlefoot::LittleFootRemoteHeap< ImplementationClass >::resetDataRangeToUnknown().

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