GenericHub.hpp

Go to the documentation of this file.

// ======================================================================
// \title  GenericHub.hpp
// \author mstarch
// \brief  hpp file for GenericHub component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef Svc_GenericHub_HPP
#define Svc_GenericHub_HPP

#include "Svc/GenericHub/GenericHubComponentAc.hpp"

namespace Svc {

class GenericHub final : public GenericHubComponentBase {
  public:
    enum HubType {
        HUB_TYPE_PORT,      
        HUB_TYPE_BUFFER,    
        HUB_TYPE_EVENT,     
        HUB_TYPE_CHANNEL,   
        HUB_TYPE_CMD_DISP,  
        HUB_TYPE_CMD_RESP,  
        HUB_TYPE_MAX
    };

    // ----------------------------------------------------------------------
    // Construction, initialization, and destruction
    // ----------------------------------------------------------------------

    GenericHub(const char* const compName 
    );

    ~GenericHub();

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

    void bufferIn_handler(const FwIndexType portNum, 
                          Fw::Buffer& fwBuffer) override;

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

    void cmdDispIn_handler(FwIndexType portNum,  
                           Fw::ComBuffer& data,  
                           U32 context           
                           ) override;

    void cmdRespIn_handler(FwIndexType portNum,             
                           FwOpcodeType opCode,             
                           U32 cmdSeq,                      
                           const Fw::CmdResponse& response  
                           ) override;

    void fromBufferDriver_handler(const FwIndexType portNum, 
                                  Fw::Buffer& fwBuffer) override;

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

    void eventIn_handler(const FwIndexType portNum,       
                         FwEventIdType id,                
                         Fw::Time& timeTag,               
                         const Fw::LogSeverity& severity, 
                         Fw::LogBuffer& args              
                         ) override;

    void tlmIn_handler(const FwIndexType portNum, 
                       FwChanIdType id,           
                       Fw::Time& timeTag,         
                       Fw::TlmBuffer& val         
                       ) override;

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

    void serialIn_handler(FwIndexType portNum,            
                          Fw::SerializeBufferBase& Buffer 
                          ) override;

    // Helpers and members
    void send_data(const HubType type, const FwIndexType port, const U8* data, const FwSizeType size);
};

}  // end namespace Svc

#endif