ExperimentStore.h

Go to the documentation of this file.

// The copy of the experiment that outlives the sketch's builder objects.
//
// PhyphoxBLE::addExperiment(exp) walks the builder's lists (views → elements → subgraphs,
// export sets → entries, sensors) twice: once to measure, then — after ONE malloc of exactly
// that size — to copy every plain-data struct into the block. From then on the builder objects
// may die; the serializer and the channel store read only this copy. The block is never freed
// (a second addExperiment() frees and reallocates it, which is the one case where the heap is
// touched twice). No capacity limits: RAM is what the experiment needs.
#ifndef PHYPHOX_BLE_CORE_EXPERIMENTSTORE_H
#define PHYPHOX_BLE_CORE_EXPERIMENTSTORE_H
 
#include "ElementData.h"
 
class PhyphoxBleExperiment;
 
namespace phyphox {
 
struct InputChannelInfo {
    bool used = false;
    bool isButton = false;      
    bool fromSensor = false;    
    uint8_t sensorIndex = 0;    
    uint8_t componentIndex = 0; 
    float defaultValue = 0;
    bool hasDefault = false;
    uint8_t submitWithChannel = 0;
};
 
class ExperimentStore {
public:
    bool copyFrom(const PhyphoxBleExperiment& exp);
    static size_t bytesNeeded(const PhyphoxBleExperiment& exp);
    void buildDefault();
    void clear();
 
    const ExperimentData& data() const { return data_; }
    ExperimentData& data() { return data_; }
    const InputChannelInfo& input(uint8_t channel) const;   
    bool hasErrors() const;
    uint8_t inputChannelsUsed() const { return inputChannelsUsed_; }
    size_t blockSize() const { return blockSize_; }         
    void* channelStorage() const { return channelStorage_; }
    uint16_t* partTable() const { return partTable_; }
    ~ExperimentStore() { clear(); }
 
private:
    ExperimentData data_;
    uint8_t* block_ = nullptr;         
    size_t blockSize_ = 0;
    InputChannelInfo* inputs_ = nullptr; 
    void* channelStorage_ = nullptr;
    uint16_t* partTable_ = nullptr;
    uint8_t inputChannelsUsed_ = 0;
};
 
} // namespace phyphox
 
#endif