BufferAccumulator.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferAccumulator.hpp
// \author bocchino
// \brief  BufferAccumulator interface
//
// \copyright
// Copyright (C) 2017 California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef Svc_BufferAccumulator_HPP
#define Svc_BufferAccumulator_HPP
 
#include <Fw/Types/MemAllocator.hpp>
 
#include "Os/Queue.hpp"
#include "Svc/BufferAccumulator/BufferAccumulatorComponentAc.hpp"
 
namespace Svc {
 
    class BufferAccumulator : public BufferAccumulatorComponentBase {
      PRIVATE:
 
        // ----------------------------------------------------------------------
        // Types
        // ----------------------------------------------------------------------
 
        class ArrayFIFOBuffer {
            public:
                ArrayFIFOBuffer();
 
                ~ArrayFIFOBuffer();
 
                void init(Fw::Buffer* const elements,  
                        NATIVE_UINT_TYPE capacity    
                        );
 
                bool enqueue(const Fw::Buffer& e  
                        );
 
                bool dequeue(Fw::Buffer& e  
                        );
 
                U32 getSize() const;
 
                U32 getCapacity() const;
 
      PRIVATE:
 
                // ----------------------------------------------------------------------
                // Private member variables
                // ----------------------------------------------------------------------
 
                Fw::Buffer* m_elements;
 
                NATIVE_UINT_TYPE m_capacity;
 
                NATIVE_UINT_TYPE m_enqueueIndex;
 
                NATIVE_UINT_TYPE m_dequeueIndex;
 
                NATIVE_UINT_TYPE m_size;
        };  // class ArrayFIFOBuffer
 
        public:
        // ----------------------------------------------------------------------
        // Construction, initialization, and destruction
        // ----------------------------------------------------------------------
 
        BufferAccumulator(
                const char* const compName 
                );
 
        void init(const NATIVE_INT_TYPE queueDepth,   
                const NATIVE_INT_TYPE instance = 0  
                );
 
        ~BufferAccumulator();
 
        // ----------------------------------------------------------------------
        // Public methods
        // ----------------------------------------------------------------------
 
        void allocateQueue(
                NATIVE_INT_TYPE identifier, Fw::MemAllocator& allocator,
                NATIVE_UINT_TYPE maxNumBuffers  
                );
 
        void deallocateQueue(Fw::MemAllocator& allocator);
 
      PRIVATE:
 
        // ----------------------------------------------------------------------
        // Handler implementations for user-defined typed input ports
        // ----------------------------------------------------------------------
 
        void
            bufferSendInFill_handler(
                    const NATIVE_INT_TYPE portNum,  
                    Fw::Buffer& buffer);
 
        void bufferSendInReturn_handler(
                const NATIVE_INT_TYPE portNum,  
                Fw::Buffer& buffer);
 
        void pingIn_handler(const NATIVE_INT_TYPE portNum,  
                            U32 key  
                            );
 
      PRIVATE:
 
        // ----------------------------------------------------------------------
        // Command handler implementations
        // ----------------------------------------------------------------------
 
        void BA_SetMode_cmdHandler(const FwOpcodeType opCode,  
                                   const U32 cmdSeq,  
                                   BufferAccumulator_OpState mode  
                                   );
 
        void BA_DrainBuffers_cmdHandler(const FwOpcodeType opCode, 
                                        const U32 cmdSeq,          
                                        U32 numToDrain,
                                        BufferAccumulator_BlockMode blockMode
                                        );
 
      PRIVATE:
 
        // ----------------------------------------------------------------------
        // Private helper methods
        // ----------------------------------------------------------------------
 
        void sendStoredBuffer();
 
      PRIVATE:
 
        // ----------------------------------------------------------------------
        // Private member variables
        // ----------------------------------------------------------------------
 
        BufferAccumulator_OpState m_mode;
 
        Fw::Buffer* m_bufferMemory;
 
        ArrayFIFOBuffer m_bufferQueue;
 
        bool m_send;
 
        bool m_waitForBuffer;
 
        U32 m_numWarnings;
 
        U32 m_numDrained;
 
        U32 m_numToDrain;
 
        FwOpcodeType m_opCode;
 
        U32 m_cmdSeq;
 
        NATIVE_INT_TYPE m_allocatorId;
    };
 
}  // namespace Svc
 
#endif