FrontEndConfigurations.hxx

Go to the documentation of this file.

//
// Created by Zhiping Jiang on 5/2/21.
//
 
#ifndef PICOSCENES_PLATFORM_FRONTENDCONFIGURATIONS_HXX
#define PICOSCENES_PLATFORM_FRONTENDCONFIGURATIONS_HXX
 
#include <vector>
#include "ModularPicoScenesFrame.hxx"
#include "ExtraInfoSegment.hxx"
 
class FrontEndConfigurations {
public:
    virtual ~FrontEndConfigurations() = default;
 
    virtual ExtraInfo buildExtraInfo() = 0;
 
    virtual bool isHardwareSupportedPreset(const std::string &presetName) = 0;
 
    virtual void applyPreset(const std::string &presetName, bool skipChangeRate = false) = 0;
 
    virtual std::tuple<double, double, double> getChannelAndBandwidth() = 0;
 
    virtual int setChannelAndBandwidth(double control, double bw, double center) = 0;
 
    virtual int setChannelAndBandwidth(std::optional<double> control, std::optional<double> bw, std::optional<double> center) = 0;
 
    virtual double getCarrierFrequency() = 0;
 
    virtual void setCarrierFrequency(double carrierFrequency) = 0;
 
    virtual double getSamplingRate() = 0;
 
    virtual void setSamplingRate(double samplingRate) = 0;
 
    virtual double getControlChannelFrequency() = 0;
 
    virtual void setControlChannelFrequency(double controlFrequency) = 0;
 
    virtual double getRxChannelBandwidth() = 0;
 
    virtual void setRxChannelBandwidth(double rxcbw) = 0;
 
    virtual double getTxpower() = 0;
 
    virtual void setTxpower(double txpower) = 0;
 
    virtual double getRxGain() = 0;
 
    virtual void setRxGain(double rxGain) = 0;
 
    virtual void setRxGain(double rxGain, uint8_t channel) = 0;
 
    virtual uint8_t getTxChainMask() = 0;
 
    virtual void setTxChainMask(uint8_t txChainMask) = 0;
 
    virtual uint8_t getRxChainMask() = 0;
 
    virtual void setRxChainMask(uint8_t rxChainMask) = 0;
 
    virtual std::vector<size_t> getTxChannels() = 0;
 
    virtual void setTxChannels(const std::vector<size_t> &txChannels) = 0;
 
    void setNumTxChannels(const uint8_t numTxChannels) {
        std::vector<size_t> channels;
        for (auto i = 0; i < numTxChannels; i++)
            channels.emplace_back(i);
 
        setTxChannels(channels);
    }
 
    virtual std::vector<size_t> getRxChannels() = 0;
 
    virtual void setRxChannels(const std::vector<size_t> &rxChannels) = 0;
 
    void setNumRxChannels(const uint8_t numRxChannels) {
        std::vector<size_t> channels;
        for (auto i = 0; i < numRxChannels; i++)
            channels.emplace_back(i);
 
        setRxChannels(channels);
    }
 
    std::vector<size_t> getAllChannels() {
        std::vector<size_t> channels;
        for (const auto &txChannel: getTxChannels())
            channels.emplace_back(txChannel);
        for (const auto &rxChannel: getRxChannels())
            channels.emplace_back(rxChannel);
 
        std::sort(channels.begin(), channels.end());
        channels.erase(std::unique(channels.begin(), channels.end()), channels.end());
        return channels;
    }
 
    virtual uint16_t getChannelFlags() = 0;
 
    virtual void setSourceMACAddressFilter(const std::vector<std::array<uint8_t, 6>> &addresses) {
        sourceAddressFilterList.clear();
        std::copy(addresses.cbegin(), addresses.cend(), std::back_inserter(sourceAddressFilterList));
    }
 
    virtual void setDestinationMACAddressFilter(const std::vector<std::array<uint8_t, 6>> &addresses) {
        destinationAddressFilterList.clear();
        std::copy(addresses.cbegin(), addresses.cend(), std::back_inserter(destinationAddressFilterList));
    }
 
    virtual uint16_t getAndIncreasePerFrontEndTxFrameSequenceNumber() {
        return currentTxSequenceNumber++;
    }
 
    virtual ModularPicoScenesTxFrame initializeTxFrame() = 0;
 
protected:
    std::vector<std::array<uint8_t, 6>> sourceAddressFilterList; 
    std::vector<std::array<uint8_t, 6>> destinationAddressFilterList; 
    uint16_t currentTxSequenceNumber{0}; 
};
 
#endif // PICOSCENES_PLATFORM_FRONTENDCONFIGURATIONS_HXX