AbstractFrontEnd.hxx

Go to the documentation of this file.

//
// Created by Zhiping Jiang on 12/24/19.
//
 
#ifndef PICOSCENES_PLATFORM_ABSTRACTFRONTEND_HXX
#define PICOSCENES_PLATFORM_ABSTRACTFRONTEND_HXX
 
#include <functional>
#include <array>
#include <condition_variable>
#include "BoostHeaders.hxx"
#include "ModularPicoScenesFrame.hxx"
#include "FrontEndConfigurations.hxx"
 
class AbstractFrontEnd : public FrontEndConfigurations {
public:
    explicit AbstractFrontEnd(const std::string &referredInterfaceName);
 
    virtual int startTx();
 
    virtual int stopTx();
 
    [[nodiscard]] virtual bool isTxServiceStarted() const;
 
    virtual int pauseTx();
 
    virtual int resumeTx();
 
    virtual int transmit(const ModularPicoScenesTxFrame &frame) = 0;
 
    virtual int transmitFramesInBatch(const std::vector<const ModularPicoScenesTxFrame *> &frames, uint32_t repeat) = 0;
 
    [[deprecated("Use the pointer-version or variadic-template versions of transmitFramesInBatch instead. This method will be removed in future release.")]]
    virtual int transmitFramesInBatch(const std::vector<ModularPicoScenesTxFrame> &frames, const uint32_t repeat) {
        std::vector<const ModularPicoScenesTxFrame *> framePoints;
        framePoints.reserve(frames.size());
        for (const auto &frame: frames)
            framePoints.emplace_back(&frame);
        return transmitFramesInBatch(framePoints, repeat);
    }
 
    template<int repeat = 1, typename ... Frames, typename = std::enable_if_t<(std::is_same_v<std::remove_cvref_t<Frames>, ModularPicoScenesTxFrame *> &&...) ||
                                                                              (std::is_same_v<std::remove_cvref_t<Frames>, ModularPicoScenesTxFrame>  &&...) ||
                                                                              ((std::is_same_v<std::remove_cvref_t<Frames>, std::shared_ptr<ModularPicoScenesTxFrame>> ||
                                                                                std::is_same_v<std::remove_cvref_t<Frames>, std::unique_ptr<ModularPicoScenesTxFrame>>) &&...)>>
    int transmitFramesInBatch(Frames &&... frames) {
        std::vector<const ModularPicoScenesTxFrame *> framePoints;
 
        if constexpr ((std::is_same_v<std::remove_cvref_t<Frames>, ModularPicoScenesTxFrame *> && ...)) {
            (framePoints.emplace_back(frames), ...);
        } else if constexpr ((std::is_same_v<std::remove_cvref_t<Frames>, ModularPicoScenesTxFrame> && ...)) {
            (framePoints.emplace_back(&frames), ...);
        } else if constexpr (((std::is_same_v<std::remove_cvref_t<Frames>, std::shared_ptr<ModularPicoScenesTxFrame>> ||
                               std::is_same_v<std::remove_cvref_t<Frames>, std::unique_ptr<ModularPicoScenesTxFrame>>) && ...)) {
            (framePoints.emplace_back(frames.get()), ...);
        }
        return transmitFramesInBatch(framePoints, repeat);
    }
 
//    int transmitTest(const ModularPicoScenesTxFrame &frame1, const ModularPicoScenesTxFrame &frame2) {
//        ModularPicoScenesTxFrame t1, t2, t3;
//        auto t4 = std::make_shared<ModularPicoScenesTxFrame>();
//        auto t5 = std::make_shared<ModularPicoScenesTxFrame>();
//        auto t6 = std::make_unique<ModularPicoScenesTxFrame>();
//        auto t7 = std::make_unique<ModularPicoScenesTxFrame>();
//        transmitFramesInBatch(t4, t6);
//        transmitFramesInBatch(t6, t7);
//        transmitFramesInBatch(t1, t2, t3);
//        return transmitFramesInBatch(frame1, frame2);
//    }
 
    virtual int startRx() = 0;
 
    virtual int stopRx() = 0;
 
    virtual int pauseRx();
 
    virtual int resumeRx();
 
    virtual void printStatus() = 0;
 
    void registerRxHandle(const std::function<void(const ModularPicoScenesRxFrame &)> &rxHandle);
 
    [[nodiscard]] const std::string &getReferredInterfaceName() const;
 
    void setReferredInterfaceName(const std::string &name);
 
    [[nodiscard]] const std::string &getPhyId() const;
 
    [[nodiscard]] PicoScenesDeviceType getFrontEndType() const;
 
    [[nodiscard]] PicoScenesDeviceSubtype getFrontEndSubtype() const;
 
    [[nodiscard]] const std::array<uint8_t, 6> &getMacAddressPhy() const;
 
    PicoScenesFrameTxParameters &getUserSpecifiedTxParameters();
 
    ModularPicoScenesTxFrame initializeTxFrame() override;
 
    virtual ~AbstractFrontEnd() = default;
 
protected:
    std::string referredInterfaceName; 
    std::string phyId; 
    std::array<uint8_t, 6> macAddress_PHY{0, 0, 0, 0, 0, 0}; 
    PicoScenesDeviceType frontEndType = PicoScenesDeviceType::Unknown; 
    PicoScenesDeviceSubtype frontEndSubtype = PicoScenesDeviceSubtype::Unknown; 
 
    bool txServiceStarted = false; 
    PicoScenesFrameTxParameters userSpecifiedTxParameters; 
    std::mutex txPauseMutex;
    std::condition_variable txPauseCV;
    bool txPaused = false; 
 
    std::function<void(const ModularPicoScenesRxFrame &)> rxHandle = nullptr; 
    bool rxPaused = false; 
    bool rxServiceStarted = false; 
};
 
 
#endif //PICOSCENES_PLATFORM_ABSTRACTFRONTEND_HXX