BufferManagerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferManagerComponentAc.hpp
// \author Auto-generated
// \brief  hpp file for BufferManager component base class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef BUFFERMANAGER_COMP_HPP_
#define BUFFERMANAGER_COMP_HPP_
 
#include <FpConfig.hpp>
#include <Fw/Port/InputSerializePort.hpp>
#include <Fw/Port/OutputSerializePort.hpp>
#include <Fw/Comp/ActiveComponentBase.hpp>
#include <Os/Mutex.hpp>
#include <Fw/Tlm/TlmString.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogString.hpp>
#include <Fw/Time/Time.hpp>
#include <Fw/Log/LogBuffer.hpp>
#include <Fw/Log/TextLogString.hpp>
#include <Fw/Tlm/TlmBuffer.hpp>
#include <Fw/Time/TimePortAc.hpp>
#include <Fw/Log/LogPortAc.hpp>
#if FW_ENABLE_TEXT_LOGGING == 1
#include <Fw/Log/LogTextPortAc.hpp>
#endif
#include <Fw/Buffer/BufferSendPortAc.hpp>
#include <Fw/Buffer/BufferGetPortAc.hpp>
#include <Fw/Tlm/TlmPortAc.hpp>
 
namespace Svc {
 
  class BufferManagerComponentBase :
    public Fw::PassiveComponentBase
  {
 
    // ----------------------------------------------------------------------
    // Friend classes
    // ----------------------------------------------------------------------
 
    friend class BufferManagerComponentBaseFriend;
 
  public:
 
    // ----------------------------------------------------------------------
    // Getters for typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputBufferSendPort* get_bufferSendIn_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    Fw::InputBufferGetPort* get_bufferGetCallee_InputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect typed input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTimePort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogPort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_textEventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputLogTextPort *port 
    );
#endif
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputTlmPort *port 
    );
 
#if FW_PORT_SERIALIZATION
 
  public:
 
    // ----------------------------------------------------------------------
    // Connect serialization input ports to typed output ports
    // ----------------------------------------------------------------------
 
    void set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
    void set_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    void set_textEventOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
#endif
 
    void set_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum, 
        Fw::InputSerializePort *port 
    );
 
#endif
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Component construction, initialization, and destruction
    // ----------------------------------------------------------------------
 
#if FW_OBJECT_NAMES == 1
    BufferManagerComponentBase(
        const char* compName 
    );
#else
    BufferManagerComponentBase(void);
#endif
 
    void init(
        NATIVE_INT_TYPE instance = 0 
    );
 
    virtual ~BufferManagerComponentBase(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
    // ----------------------------------------------------------------------
 
    virtual void lock(void);
 
    virtual void unLock(void);
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Handlers to implement for typed input ports
    // ----------------------------------------------------------------------
 
    //
    virtual void bufferSendIn_handler(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    ) = 0;
 
    //
    virtual Fw::Buffer bufferGetCallee_handler(
        NATIVE_INT_TYPE portNum, 
        U32 size 
    ) = 0;
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Port handler base-class functions for typed input ports.
    // ----------------------------------------------------------------------
    // Call these functions directly to bypass the corresponding ports.
    // ----------------------------------------------------------------------
 
    void bufferSendIn_handlerBase(
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    Fw::Buffer bufferGetCallee_handlerBase(
        NATIVE_INT_TYPE portNum, 
        U32 size 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of input ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_bufferSendIn_InputPorts(void);
 
    NATIVE_INT_TYPE getNum_bufferGetCallee_InputPorts(void);
 
 
    // ----------------------------------------------------------------------
    // Enumerations for number of ports
    // ----------------------------------------------------------------------
 
    enum {
       NUM_BUFFERSENDIN_INPUT_PORTS = 1,
       NUM_BUFFERGETCALLEE_INPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Getters for numbers of output ports
    // ----------------------------------------------------------------------
 
    NATIVE_INT_TYPE getNum_timeCaller_OutputPorts(void);
 
    NATIVE_INT_TYPE getNum_eventOut_OutputPorts(void);
 
#if FW_ENABLE_TEXT_LOGGING == 1
    NATIVE_INT_TYPE getNum_textEventOut_OutputPorts(void);
#endif
 
    NATIVE_INT_TYPE getNum_tlmOut_OutputPorts(void);
 
 
    enum {
       NUM_TIMECALLER_OUTPUT_PORTS = 1,
       NUM_EVENTOUT_OUTPUT_PORTS = 1,
       NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
       NUM_TLMOUT_OUTPUT_PORTS = 1,
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Connection status queries for output ports
    // ----------------------------------------------------------------------
 
    bool isConnected_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
    bool isConnected_eventOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
#if FW_ENABLE_TEXT_LOGGING == 1
    bool isConnected_textEventOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
#endif
 
    bool isConnected_tlmOut_OutputPort(
        NATIVE_INT_TYPE portNum 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event IDs
    // ----------------------------------------------------------------------
 
    enum {
      EVENTID_CLEAREDERRORSTATE = 0x00, /* The Buffer Manager has cleared its error state */
      EVENTID_STORESIZEEXCEEDED = 0x01, /* The Buffer Manager received an allocation request that, if granted, would cause the storage buffer to overflow */
      EVENTID_TOOMANYBUFFERS = 0x02, /* The Buffer Manager received an allocation request that, if granted, would result in too many buffers */
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Event logging functions
    // ----------------------------------------------------------------------
 
    /* The Buffer Manager has cleared its error state */
    void log_ACTIVITY_HI_ClearedErrorState(
        void
    );
 
 
    /* The Buffer Manager received an allocation request that, if granted, would cause the storage buffer to overflow */
    void log_WARNING_HI_StoreSizeExceeded(
        void
    );
 
 
    /* The Buffer Manager received an allocation request that, if granted, would result in too many buffers */
    void log_WARNING_HI_TooManyBuffers(
        void
    );
 
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Channel IDs
    // ----------------------------------------------------------------------
 
    enum {
      CHANNELID_BUFFERMANAGER_NUMALLOCATEDBUFFERS = 0x00, 
      CHANNELID_BUFFERMANAGER_ALLOCATEDSIZE = 0x01, 
    };
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Telemetry write functions
    // ----------------------------------------------------------------------
 
    /* The number of buffers currently allocated */
    void tlmWrite_BufferManager_NumAllocatedBuffers(
        U32 arg 
    );
 
    /* The total size of all allocated buffers */
    void tlmWrite_BufferManager_AllocatedSize(
        U32 arg 
    );
 
  PROTECTED:
 
    // ----------------------------------------------------------------------
    // Time
    // ----------------------------------------------------------------------
 
    Fw::Time getTime(void);
 
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed input ports
    // ----------------------------------------------------------------------
 
    Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS];
 
    Fw::InputBufferGetPort m_bufferGetCallee_InputPort[NUM_BUFFERGETCALLEE_INPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Typed output ports
    // ----------------------------------------------------------------------
 
    Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];
 
    Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];
 
#if FW_ENABLE_TEXT_LOGGING == 1
    Fw::OutputLogTextPort m_textEventOut_OutputPort[NUM_TEXTEVENTOUT_OUTPUT_PORTS];
#endif
 
    Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Calls for messages received on typed input ports
    // ----------------------------------------------------------------------
 
    static void m_p_bufferSendIn_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        Fw::Buffer &fwBuffer 
    );
 
    static Fw::Buffer m_p_bufferGetCallee_in(
        Fw::PassiveComponentBase* callComp, 
        NATIVE_INT_TYPE portNum, 
        U32 size 
    );
 
  PRIVATE:
 
    // ----------------------------------------------------------------------
    // Mutexes
    // ----------------------------------------------------------------------
 
    Os::Mutex m_guardedPortMutex;
 
 
  PRIVATE:
    // ----------------------------------------------------------------------
    // Counter values for event throttling
    // ----------------------------------------------------------------------
 
  };
 
} // end namespace Svc
#endif