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 {

    // Forward declaration for UTs
    namespace Accumulate { class BufferAccumulatorTester; }
    namespace Drain { class BufferAccumulatorTester; }
    namespace Errors { class BufferAccumulatorTester; }

    class BufferAccumulator final : public BufferAccumulatorComponentBase {

      friend class BufferAccumulatorTester;
      friend class Svc::Accumulate::BufferAccumulatorTester;
      friend class Svc::Drain::BufferAccumulatorTester;
      friend class Svc::Errors::BufferAccumulatorTester;

      private:

        // ----------------------------------------------------------------------
        // Types
        // ----------------------------------------------------------------------

        class ArrayFIFOBuffer {
            public:
                ArrayFIFOBuffer();

                ~ArrayFIFOBuffer();

                void init(Fw::Buffer* const elements,  
                          FwSizeType capacity    
                        );

                bool enqueue(const Fw::Buffer& e  
                        );

                bool dequeue(Fw::Buffer& e  
                        );

                FwSizeType getSize() const;

                FwSizeType getCapacity() const;

      private:

                // ----------------------------------------------------------------------
                // Private member variables
                // ----------------------------------------------------------------------

                Fw::Buffer* m_elements;

                FwSizeType m_capacity;

                FwSizeType m_enqueueIndex;

                FwSizeType m_dequeueIndex;

                FwSizeType m_size;
        };  // class ArrayFIFOBuffer

        public:
        // ----------------------------------------------------------------------
        // Construction, initialization, and destruction
        // ----------------------------------------------------------------------

        BufferAccumulator(
                const char* const compName 
                );

        ~BufferAccumulator();

        // ----------------------------------------------------------------------
        // Public methods
        // ----------------------------------------------------------------------

        void allocateQueue(
                FwEnumStoreType identifier, Fw::MemAllocator& allocator,
                FwSizeType maxNumBuffers  
                );

        void deallocateQueue(Fw::MemAllocator& allocator);

      private:

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

        void
            bufferSendInFill_handler(
                    const FwIndexType portNum,  
                    Fw::Buffer& buffer);

        void bufferSendInReturn_handler(
                const FwIndexType portNum,  
                Fw::Buffer& buffer);

        void pingIn_handler(const FwIndexType 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;

        FwSizeType m_numDrained;

        FwSizeType m_numToDrain;

        FwOpcodeType m_opCode;

        U32 m_cmdSeq;

        FwEnumStoreType m_allocatorId;
    };

}  // namespace Svc

#endif