StaticMemoryComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  StaticMemoryComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for StaticMemory component base class
// ======================================================================

#ifndef Svc_StaticMemoryComponentAc_HPP
#define Svc_StaticMemoryComponentAc_HPP

#include "FpConfig.hpp"
#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Os/Mutex.hpp"

namespace Svc {

  class StaticMemoryComponentBase :
    public Fw::PassiveComponentBase
  {

      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------

      friend class StaticMemoryComponentBaseFriend;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------

      enum {
        NUM_BUFFERALLOCATE_INPUT_PORTS = 4,
        NUM_BUFFERDEALLOCATE_INPUT_PORTS = 4,
      };

    public:

      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Fw::InputBufferGetPort* get_bufferAllocate_InputPort(
          FwIndexType portNum 
      );

      Fw::InputBufferSendPort* get_bufferDeallocate_InputPort(
          FwIndexType portNum 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------

      StaticMemoryComponentBase(
          const char* compName = "" 
      );

      virtual ~StaticMemoryComponentBase();

    PROTECTED:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------

      FwIndexType getNum_bufferAllocate_InputPorts() const;

      FwIndexType getNum_bufferDeallocate_InputPorts() const;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------

      virtual Fw::Buffer bufferAllocate_handler(
          FwIndexType portNum, 
          U32 size 
      ) = 0;

      virtual void bufferDeallocate_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;

    PROTECTED:

      // ----------------------------------------------------------------------
      // Port handler base-class functions for typed input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

      Fw::Buffer bufferAllocate_handlerBase(
          FwIndexType portNum, 
          U32 size 
      );

      void bufferDeallocate_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

    PROTECTED:

      // ----------------------------------------------------------------------
      // Mutex operations for guarded ports
      //
      // You can override these operations to provide more sophisticated
      // synchronization
      // ----------------------------------------------------------------------

      virtual void lock();

      virtual void unLock();

    PRIVATE:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static Fw::Buffer m_p_bufferAllocate_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 size 
      );

      static void m_p_bufferDeallocate_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

    PRIVATE:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Fw::InputBufferGetPort m_bufferAllocate_InputPort[NUM_BUFFERALLOCATE_INPUT_PORTS];

      Fw::InputBufferSendPort m_bufferDeallocate_InputPort[NUM_BUFFERDEALLOCATE_INPUT_PORTS];

    PRIVATE:

      // ----------------------------------------------------------------------
      // Mutexes
      // ----------------------------------------------------------------------

      Os::Mutex m_guardedPortMutex;

  };

}

#endif