DpManager.hpp

Go to the documentation of this file.

// ======================================================================
// \title  DpManager.hpp
// \author bocchino
// \brief  hpp file for DpManager component implementation class
// ======================================================================

#ifndef Svc_DpManager_HPP
#define Svc_DpManager_HPP

#include <atomic>

#include "Svc/DpManager/DpManagerComponentAc.hpp"
#include "config/FppConstantsAc.hpp"

namespace Svc {

class DpManager final : public DpManagerComponentBase {
  private:
    // ----------------------------------------------------------------------
    // Static assertions against the assumptions about the model
    // ----------------------------------------------------------------------

    static_assert(
        DpManager::NUM_PRODUCTGETIN_INPUT_PORTS == static_cast<FwSizeType>(DpManagerNumPorts),
        "Number of product get in ports must equal DpManagerNumPorts"
    );
    static_assert(
        DpManager::NUM_PRODUCTREQUESTIN_INPUT_PORTS == static_cast<FwSizeType>(DpManagerNumPorts),
        "Number of product request in ports must equal DpManagerNumPorts"
    );
    static_assert(
        DpManager::NUM_PRODUCTRESPONSEOUT_OUTPUT_PORTS == static_cast<FwSizeType>(DpManagerNumPorts),
        "Number of product response out ports must equal DpManagerNumPorts"
    );
    static_assert(
        DpManager::NUM_BUFFERGETOUT_OUTPUT_PORTS == static_cast<FwSizeType>(DpManagerNumPorts),
        "Number of buffer get out ports must equal DpManagerNumPorts"
    );
    static_assert(
        DpManager::NUM_PRODUCTSENDIN_INPUT_PORTS == static_cast<FwSizeType>(DpManagerNumPorts),
        "Number of product send in ports must equal DpManagerNumPorts"
    );
    static_assert(
        DpManager::NUM_PRODUCTSENDOUT_OUTPUT_PORTS == static_cast<FwSizeType>(DpManagerNumPorts),
        "Number of product send out ports must equal DpManagerNumPorts"
    );

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

    explicit DpManager(const char* const compName  
    );

    ~DpManager();

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

    Fw::Success productGetIn_handler(const FwIndexType portNum,  
                                     FwDpIdType id,                  
                                     FwSizeType size,                
                                     Fw::Buffer& buffer              
                                     ) final;

    void productRequestIn_handler(const FwIndexType portNum,  
                                  FwDpIdType id,                  
                                  FwSizeType size                 
                                  ) final;

    void productSendIn_handler(const FwIndexType portNum,  
                               FwDpIdType id,                  
                               const Fw::Buffer& buffer        
                               ) final;

    void schedIn_handler(const FwIndexType portNum,  
                         U32 context                     
                         ) final;

  PRIVATE:
    // ----------------------------------------------------------------------
    // Handler implementations for commands
    // ----------------------------------------------------------------------

    void CLEAR_EVENT_THROTTLE_cmdHandler(FwOpcodeType opCode,  
                                         U32 cmdSeq            
                                         ) override;

  PRIVATE:
    // ----------------------------------------------------------------------
    // Private helper functions
    // ----------------------------------------------------------------------

    Fw::Success getBuffer(FwIndexType portNum,  
                          FwDpIdType id,        
                          FwSizeType size,      
                          Fw::Buffer& buffer    
    );

  PRIVATE:
    // ----------------------------------------------------------------------
    // Private member variables
    // ----------------------------------------------------------------------

    std::atomic<U32> numSuccessfulAllocations;

    std::atomic<U32> numFailedAllocations;

    U32 numDataProducts;

    U64 numBytes;
};

}  // end namespace Svc

#endif