HealthComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_HealthComponentAc_HPP
#define Svc_HealthComponentAc_HPP

#include <atomic>

#include "Fw/Cmd/CmdPortAc.hpp"
#include "Fw/Cmd/CmdRegPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Cmd/CmdString.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#if FW_ENABLE_TEXT_LOGGING == 1
#include "Fw/Log/LogTextPortAc.hpp"
#endif
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Fw/Types/EnabledEnumAc.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
#include "Svc/WatchDog/WatchDogPortAc.hpp"

namespace Svc {

  class HealthComponentBase :
    public Fw::QueuedComponentBase
  {

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

      friend class HealthTesterBase;
      friend class HealthTester;

    protected:

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

      enum {
        NUM_CMDDISP_INPUT_PORTS = 1,
      };

      enum {
        NUM_PINGRETURN_INPUT_PORTS = 25,
        NUM_RUN_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREG_OUTPUT_PORTS = 1,
        NUM_CMDSTATUS_OUTPUT_PORTS = 1,
        NUM_LOG_OUTPUT_PORTS = 1,
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_TIME_OUTPUT_PORTS = 1,
        NUM_TLM_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_PINGSEND_OUTPUT_PORTS = 25,
        NUM_WDOGSTROKE_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_HLTH_ENABLE = 0x0, 
        OPCODE_HLTH_PING_ENABLE = 0x1, 
        OPCODE_HLTH_CHNG_PING = 0x2, 
      };

      enum {
        EVENTID_HLTH_PING_WARN = 0x0, 
        EVENTID_HLTH_PING_LATE = 0x1, 
        EVENTID_HLTH_PING_WRONG_KEY = 0x2, 
        EVENTID_HLTH_CHECK_ENABLE = 0x3, 
        EVENTID_HLTH_CHECK_PING = 0x4, 
        EVENTID_HLTH_CHECK_LOOKUP_ERROR = 0x5, 
        EVENTID_HLTH_PING_UPDATED = 0x6, 
        EVENTID_HLTH_PING_INVALID_VALUES = 0x7, 
      };

      enum {
        CHANNELID_PINGLATEWARNINGS = 0x0, 
      };

    public:

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

      void init(
          FwSizeType queueDepth, 
          FwEnumStoreType instance = 0 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort* get_CmdDisp_InputPort(
          FwIndexType portNum 
      );

    public:

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

      Svc::InputPingPort* get_PingReturn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_Run_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------

      void set_CmdReg_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdRegPort* port 
      );

      void set_CmdStatus_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdResponsePort* port 
      );

      void set_Log_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_Time_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

      void set_Tlm_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_PingSend_OutputPort(
          FwIndexType portNum, 
          Svc::InputPingPort* port 
      );

      void set_WdogStroke_OutputPort(
          FwIndexType portNum, 
          Svc::InputWatchDogPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------

      void set_CmdReg_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_CmdStatus_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_Log_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_LogText_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_Time_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_Tlm_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

#if FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_PingSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_WdogStroke_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Command registration
      // ----------------------------------------------------------------------

      void regCommands();

    protected:

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

      HealthComponentBase(
          const char* compName = "" 
      );

      virtual ~HealthComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_CmdDisp_InputPorts() {
        return NUM_CMDDISP_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_PingReturn_InputPorts() {
        return NUM_PINGRETURN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_Run_InputPorts() {
        return NUM_RUN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_CmdReg_OutputPorts() {
        return NUM_CMDREG_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_CmdStatus_OutputPorts() {
        return NUM_CMDSTATUS_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_Log_OutputPorts() {
        return NUM_LOG_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_LogText_OutputPorts() {
        return NUM_LOGTEXT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_Time_OutputPorts() {
        return NUM_TIME_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_Tlm_OutputPorts() {
        return NUM_TLM_OUTPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_PingSend_OutputPorts() {
        return NUM_PINGSEND_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_WdogStroke_OutputPorts() {
        return NUM_WDOGSTROKE_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------

      bool isConnected_CmdReg_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_CmdStatus_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_Log_OutputPort(
          FwIndexType portNum 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_Time_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_Tlm_OutputPort(
          FwIndexType portNum 
      );

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for typed output ports
      // ----------------------------------------------------------------------

      bool isConnected_PingSend_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_WdogStroke_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      virtual void PingReturn_handler(
          FwIndexType portNum, 
          U32 key 
      ) = 0;

      virtual void Run_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;

    protected:

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

      void PingReturn_handlerBase(
          FwIndexType portNum, 
          U32 key 
      );

      void Run_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

    protected:

      // ----------------------------------------------------------------------
      // Pre-message hooks for typed async input ports
      //
      // Each of these functions is invoked just before processing a message
      // on the corresponding port. By default, they do nothing. You can
      // override them to provide specific pre-message behavior.
      // ----------------------------------------------------------------------

      virtual void PingReturn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

    protected:

      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------

      void PingSend_out(
          FwIndexType portNum, 
          U32 key 
      );

      void WdogStroke_out(
          FwIndexType portNum, 
          U32 code 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command response
      // ----------------------------------------------------------------------

      void cmdResponse_out(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdResponse response 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command handlers to implement
      // ----------------------------------------------------------------------

      virtual void HLTH_ENABLE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::Enabled enable 
      ) = 0;

      virtual void HLTH_PING_ENABLE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& entry, 
          Fw::Enabled enable 
      ) = 0;

      virtual void HLTH_CHNG_PING_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& entry, 
          U32 warningValue, 
          U32 fatalValue 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Command handler base-class functions
      //
      // Call these functions directly to bypass the command input port
      // ----------------------------------------------------------------------

      void HLTH_ENABLE_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void HLTH_PING_ENABLE_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void HLTH_CHNG_PING_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    protected:

      // ----------------------------------------------------------------------
      // Pre-message hooks for async commands
      //
      // Each of these functions is invoked just before processing the
      // corresponding command. By default they do nothing. You can
      // override them to provide specific pre-command behavior.
      // ----------------------------------------------------------------------

      virtual void HLTH_ENABLE_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void HLTH_PING_ENABLE_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void HLTH_CHNG_PING_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    protected:

      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_HLTH_PING_WARN(
          const Fw::StringBase& entry 
      ) const;

      void log_FATAL_HLTH_PING_LATE(
          const Fw::StringBase& entry 
      ) const;

      void log_FATAL_HLTH_PING_WRONG_KEY(
          const Fw::StringBase& entry, 
          U32 badKey 
      ) const;

      void log_ACTIVITY_HI_HLTH_CHECK_ENABLE(
          Fw::Enabled enabled 
      ) const;

      void log_ACTIVITY_HI_HLTH_CHECK_PING(
          Fw::Enabled enabled, 
          const Fw::StringBase& entry 
      ) const;

      void log_WARNING_LO_HLTH_CHECK_LOOKUP_ERROR(
          const Fw::StringBase& entry 
      ) const;

      void log_ACTIVITY_HI_HLTH_PING_UPDATED(
          const Fw::StringBase& entry, 
          U32 warn, 
          U32 fatal 
      ) const;

      void log_WARNING_HI_HLTH_PING_INVALID_VALUES(
          const Fw::StringBase& entry, 
          U32 warn, 
          U32 fatal 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------

      void tlmWrite_PingLateWarnings(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------

      Fw::Time getTime() const;

    protected:

      // ----------------------------------------------------------------------
      // Message dispatch functions
      // ----------------------------------------------------------------------

      virtual MsgDispatchStatus doDispatch();

    protected:

      // ----------------------------------------------------------------------
      // Helper functions for dispatching current messages
      // ----------------------------------------------------------------------

      MsgDispatchStatus dispatchCurrentMessages();

    private:

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

      static void m_p_CmdDisp_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    private:

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

      static void m_p_PingReturn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 key 
      );

      static void m_p_Run_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );

    private:

      // ----------------------------------------------------------------------
      // Special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort m_CmdDisp_InputPort[NUM_CMDDISP_INPUT_PORTS];

    private:

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

      Svc::InputPingPort m_PingReturn_InputPort[NUM_PINGRETURN_INPUT_PORTS];

      Svc::InputSchedPort m_Run_InputPort[NUM_RUN_INPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------

      Fw::OutputCmdRegPort m_CmdReg_OutputPort[NUM_CMDREG_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_CmdStatus_OutputPort[NUM_CMDSTATUS_OUTPUT_PORTS];

      Fw::OutputLogPort m_Log_OutputPort[NUM_LOG_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS];

      Fw::OutputTlmPort m_Tlm_OutputPort[NUM_TLM_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------

      Svc::OutputPingPort m_PingSend_OutputPort[NUM_PINGSEND_OUTPUT_PORTS];

      Svc::OutputWatchDogPort m_WdogStroke_OutputPort[NUM_WDOGSTROKE_OUTPUT_PORTS];

  };

}

#endif