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 "Svc/BufferAccumulator/BufferAccumulatorComponentAc.hpp"
#include "Os/Queue.hpp"
#include <Fw/Types/MemAllocator.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 * elements;
 
          NATIVE_UINT_TYPE capacity;
 
          NATIVE_UINT_TYPE enqueueIndex;
 
          NATIVE_UINT_TYPE dequeueIndex;
 
          NATIVE_UINT_TYPE 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 
      );
 
      void schedIn_handler(
          const NATIVE_INT_TYPE portNum, 
          NATIVE_UINT_TYPE context 
      );
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Command handler implementations
      // ----------------------------------------------------------------------
 
      void BA_SetMode_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          OpState mode 
      );
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Private helper methods
      // ----------------------------------------------------------------------
 
      void sendStoredBuffer();
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Private member variables
      // ----------------------------------------------------------------------
 
      OpState mode;
 
      Fw::Buffer * bufferMemory;
 
      ArrayFIFOBuffer bufferQueue;
 
      bool send;
 
      U32 numWarnings;
 
      NATIVE_INT_TYPE allocatorId;
 
  };
 
}
 
#endif