FatalHandlerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_FatalHandlerComponentAc_HPP
#define Svc_FatalHandlerComponentAc_HPP

#include "FpConfig.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Svc/Fatal/FatalEventPortAc.hpp"

namespace Svc {

  class FatalHandlerComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class FatalHandlerComponentBaseFriend;

    PROTECTED:

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

      enum {
        NUM_FATALRECEIVE_INPUT_PORTS = 1,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Svc::InputFatalEventPort* get_FatalReceive_InputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      FatalHandlerComponentBase(
          const char* compName = "" 
      );

      virtual ~FatalHandlerComponentBase();

    PROTECTED:

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

      FwIndexType getNum_FatalReceive_InputPorts() const;

    PROTECTED:

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

      virtual void FatalReceive_handler(
          FwIndexType portNum, 
          FwEventIdType Id 
      ) = 0;

    PROTECTED:

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

      void FatalReceive_handlerBase(
          FwIndexType portNum, 
          FwEventIdType Id 
      );

    PRIVATE:

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

      static void m_p_FatalReceive_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwEventIdType Id 
      );

    PRIVATE:

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

      Svc::InputFatalEventPort m_FatalReceive_InputPort[NUM_FATALRECEIVE_INPUT_PORTS];

  };

}

#endif