cs_BehaviourStore.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Sep 23, 2019
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
 
#pragma once
 
#include <behaviour/cs_ExtendedSwitchBehaviour.h>
#include <behaviour/cs_SwitchBehaviour.h>
#include <behaviour/cs_TwilightBehaviour.h>
#include <common/cs_Component.h>
#include <events/cs_EventListener.h>
#include <protocol/cs_ErrorCodes.h>
#include <test/cs_TestAccess.h>
 
#include <array>
#include <optional>
#include <vector>
 
class BehaviourStore : public EventListener, public Component {
    friend class TestAccess<BehaviourStore>;
 
public:
    static constexpr size_t MaxBehaviours = 50;
 
private:
    std::array<Behaviour*, MaxBehaviours> activeBehaviours = {};
 
public:
    // delete copy and move constructor to prevent double deletions etc.
    BehaviourStore(BehaviourStore& other) = delete;
    BehaviourStore(BehaviourStore&& other) = delete;
    // default is not implicitly generated when copy constructors are deleted.
    BehaviourStore() = default;
 
    virtual void handleEvent(event_t& evt);
 
    /*****************************
     * NOTE: to loop over a specific type of behaviours simply do:
     *
     * for(auto b : getActiveBehaviours()){
     *   if(auto switchbehave = dynamic_cast<SwitchBehaviour*>(b)){
     *     // work with switchbehave
     *   }
     * }
     */
    inline std::array<Behaviour*, MaxBehaviours>& getActiveBehaviours() { return activeBehaviours; }
 
    cs_ret_code_t init() override;
 
    virtual ~BehaviourStore();
 
    ErrorCodesGeneral addBehaviour(Behaviour* behaviour);
 
    ErrorCodesGeneral replaceBehaviour(uint8_t index, Behaviour* behaviour);
 
    Behaviour* getBehaviour(uint8_t index);
 
    uint8_t findEmptyIndex();
 
private:
    ErrorCodesGeneral addBehaviour(uint8_t* buf, cs_buffer_size_t bufSize, uint8_t& index);
 
    ErrorCodesGeneral removeBehaviour(uint8_t index);
 
    void clearActiveBehavioursArray();
 
    uint32_t calculateMasterHash();
 
    void storeMasterHash();
 
    BehaviourMutation handleSaveBehaviour(event_t& evt);
 
    BehaviourMutation handleReplaceBehaviour(event_t& evt);
    BehaviourMutation handleRemoveBehaviour(event_t& evt);
    void handleGetBehaviour(event_t& evt);
    void handleGetBehaviourIndices(event_t& evt);
 
    // utilities
    void storeUpdate(uint8_t index, SwitchBehaviour::Type type, uint8_t* buf, cs_buffer_size_t bufSize);
    void storeUpdate(uint8_t index, Behaviour* behaviour);
 
    Behaviour* allocateBehaviour(uint8_t index, SwitchBehaviour::Type type, uint8_t* buf, cs_buffer_size_t bufSize);
 
    void assignBehaviour(uint8_t index, Behaviour* behaviour);
 
    ErrorCodesGeneral checkSizeAndType(SwitchBehaviour::Type type, cs_buffer_size_t bufSize);
 
    size_t getBehaviourSize(SwitchBehaviour::Type type);
 
    void dispatchBehaviourMutationEvent(BehaviourMutation mutation);
 
    // checks intermediate state of handleReplaceBehaviour for consistency.
    ErrorCodesGeneral replaceParameterValidation(event_t& evt, uint8_t index, SwitchBehaviour::Type type);
 
    // loads the behaviours from state into the 'activeBehaviours' array.
    // BehaviourType must match BehaviourCsType.
    template <class BehaviourType>
    void LoadBehavioursFromMemory(CS_TYPE BehaviourCsType);
};