FrameAccumulator.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FrameAccumulator.hpp
// \author mstarch
// \brief  hpp file for FrameAccumulator component implementation class
// ======================================================================

#ifndef Svc_FrameAccumulator_HPP
#define Svc_FrameAccumulator_HPP

#include "Fw/Types/MemAllocator.hpp"
#include "Svc/FrameAccumulator/FrameAccumulatorComponentAc.hpp"
#include "Svc/FrameAccumulator/FrameDetector.hpp"
#include "Utils/Types/CircularBuffer.hpp"

namespace Svc {

class FrameAccumulator final : public FrameAccumulatorComponentBase {
    friend class FrameAccumulatorTester;

  public:
    // ----------------------------------------------------------------------
    // Component construction and destruction
    // ----------------------------------------------------------------------

    FrameAccumulator(const char* const compName  
    );

    ~FrameAccumulator();

    void configure(const FrameDetector& detector,  
                   FwEnumStoreType allocationId,   
                   Fw::MemAllocator& allocator,    
                   FwSizeType store_size           
    );

    void cleanup();

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for user-defined typed input ports
    // ----------------------------------------------------------------------

    void dataIn_handler(FwIndexType portNum,  
                        Fw::Buffer& recvBuffer,
                        const ComCfg::FrameContext& context) override;

    void dataReturnIn_handler(FwIndexType portNum,                 
                              Fw::Buffer& fwBuffer,                
                              const ComCfg::FrameContext& context  
                              ) override;

  private:
    void processBuffer(Fw::Buffer& buffer);

    void processRing();

    Types::CircularBuffer m_inRing;

    FrameDetector const* m_detector;

    Fw::MemAllocator* m_memoryAllocator;

    U8* m_memory;

    FwEnumStoreType m_allocatorId;
};

}  // namespace Svc

#endif