Public Member Functions | List of all members
BlocksProtocol::HostPacketBuilder< maxPacketBytes > Struct Template Reference

Helper class for constructing a packet for sending to a BLOCKS device. More...

Public Member Functions

 HostPacketBuilder () noexcept
 
 HostPacketBuilder (const HostPacketBuilder &)=delete
 
 HostPacketBuilder (HostPacketBuilder &&)=default
 
const void * getData () const noexcept
 
int size () const noexcept
 
void writePacketSysexHeaderBytes (TopologyIndex deviceIndex) noexcept
 
void writePacketSysexFooter () noexcept
 
bool deviceControlMessage (DeviceCommand command) noexcept
 
bool beginDataChanges (PacketIndex packetIndex) noexcept
 
bool endDataChanges (bool isLastChange) noexcept
 
bool skipBytes (int numToSkip) noexcept
 
bool setMultipleBytes (const uint8 *values, int num) noexcept
 
bool setMultipleBytes (uint8 value, uint8 lastValue, int num) noexcept
 
bool addProgramEventMessage (const int32 *messageData)
 
bool addFirmwareUpdatePacket (const uint8 *packetData, uint8 size)
 
bool addConfigSetMessage (int32 item, int32 value)
 
bool addRequestMessage (int32 item)
 
bool addRequestFactorySyncMessage ()
 
bool addRequestUserSyncMessage ()
 
bool addFactoryReset ()
 
bool addBlockReset ()
 
bool addSetBlockName (const juce::String &name)
 

Detailed Description

template<int maxPacketBytes>
struct BlocksProtocol::HostPacketBuilder< maxPacketBytes >

Helper class for constructing a packet for sending to a BLOCKS device.

Constructor & Destructor Documentation

◆ HostPacketBuilder() [1/3]

template<int maxPacketBytes>
BlocksProtocol::HostPacketBuilder< maxPacketBytes >::HostPacketBuilder ( )
noexcept

◆ HostPacketBuilder() [2/3]

template<int maxPacketBytes>
BlocksProtocol::HostPacketBuilder< maxPacketBytes >::HostPacketBuilder ( const HostPacketBuilder< maxPacketBytes > &  )
delete

◆ HostPacketBuilder() [3/3]

template<int maxPacketBytes>
BlocksProtocol::HostPacketBuilder< maxPacketBytes >::HostPacketBuilder ( HostPacketBuilder< maxPacketBytes > &&  )
default

Member Function Documentation

◆ getData()

template<int maxPacketBytes>
const void* BlocksProtocol::HostPacketBuilder< maxPacketBytes >::getData ( ) const
noexcept

◆ size()

template<int maxPacketBytes>
int BlocksProtocol::HostPacketBuilder< maxPacketBytes >::size ( ) const
noexcept

◆ writePacketSysexHeaderBytes()

template<int maxPacketBytes>
void BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writePacketSysexHeaderBytes ( TopologyIndex  deviceIndex)
noexcept

◆ writePacketSysexFooter()

template<int maxPacketBytes>
void BlocksProtocol::HostPacketBuilder< maxPacketBytes >::writePacketSysexFooter ( )
noexcept

◆ deviceControlMessage()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::deviceControlMessage ( DeviceCommand  command)
noexcept

◆ beginDataChanges()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::beginDataChanges ( PacketIndex  packetIndex)
noexcept

◆ endDataChanges()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::endDataChanges ( bool  isLastChange)
noexcept

◆ skipBytes()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::skipBytes ( int  numToSkip)
noexcept

◆ setMultipleBytes() [1/2]

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::setMultipleBytes ( const uint8 values,
int  num 
)
noexcept

◆ setMultipleBytes() [2/2]

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::setMultipleBytes ( uint8  value,
uint8  lastValue,
int  num 
)
noexcept

◆ addProgramEventMessage()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addProgramEventMessage ( const int32 messageData)

◆ addFirmwareUpdatePacket()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFirmwareUpdatePacket ( const uint8 packetData,
uint8  size 
)

◆ addConfigSetMessage()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addConfigSetMessage ( int32  item,
int32  value 
)

◆ addRequestMessage()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestMessage ( int32  item)

◆ addRequestFactorySyncMessage()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestFactorySyncMessage ( )

◆ addRequestUserSyncMessage()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addRequestUserSyncMessage ( )

◆ addFactoryReset()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addFactoryReset ( )

◆ addBlockReset()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addBlockReset ( )

◆ addSetBlockName()

template<int maxPacketBytes>
bool BlocksProtocol::HostPacketBuilder< maxPacketBytes >::addSetBlockName ( const juce::String &  name)

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