AssertFatalAdapterComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_AssertFatalAdapterComponentAc_HPP
#define Svc_AssertFatalAdapterComponentAc_HPP

#include <atomic>

#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"

namespace Svc {

  class AssertFatalAdapterComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class AssertFatalAdapterTesterBase;
      friend class AssertFatalAdapterTester;

    protected:

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

      enum {
        NUM_LOG_OUTPUT_PORTS = 1,
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_TIME_OUTPUT_PORTS = 1,
      };

      enum {
        EVENTID_AF_ASSERT_0 = 0x0, 
        EVENTID_AF_ASSERT_1 = 0x1, 
        EVENTID_AF_ASSERT_2 = 0x2, 
        EVENTID_AF_ASSERT_3 = 0x3, 
        EVENTID_AF_ASSERT_4 = 0x4, 
        EVENTID_AF_ASSERT_5 = 0x5, 
        EVENTID_AF_ASSERT_6 = 0x6, 
        EVENTID_AF_UNEXPECTED_ASSERT = 0x7, 
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      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 
      );

#if FW_PORT_SERIALIZATION

    public:

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

      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 
      );

#endif

    protected:

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

      AssertFatalAdapterComponentBase(
          const char* compName = "" 
      );

      virtual ~AssertFatalAdapterComponentBase();

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special 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;
      }

    protected:

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

      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 
      );

    protected:

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

      void log_FATAL_AF_ASSERT_0(
          const Fw::StringBase& file, 
          U32 line 
      ) const;

      void log_FATAL_AF_ASSERT_1(
          const Fw::StringBase& file, 
          U32 line, 
          U32 arg1 
      ) const;

      void log_FATAL_AF_ASSERT_2(
          const Fw::StringBase& file, 
          U32 line, 
          U32 arg1, 
          U32 arg2 
      ) const;

      void log_FATAL_AF_ASSERT_3(
          const Fw::StringBase& file, 
          U32 line, 
          U32 arg1, 
          U32 arg2, 
          U32 arg3 
      ) const;

      void log_FATAL_AF_ASSERT_4(
          const Fw::StringBase& file, 
          U32 line, 
          U32 arg1, 
          U32 arg2, 
          U32 arg3, 
          U32 arg4 
      ) const;

      void log_FATAL_AF_ASSERT_5(
          const Fw::StringBase& file, 
          U32 line, 
          U32 arg1, 
          U32 arg2, 
          U32 arg3, 
          U32 arg4, 
          U32 arg5 
      ) const;

      void log_FATAL_AF_ASSERT_6(
          const Fw::StringBase& file, 
          U32 line, 
          U32 arg1, 
          U32 arg2, 
          U32 arg3, 
          U32 arg4, 
          U32 arg5, 
          U32 arg6 
      ) const;

      void log_FATAL_AF_UNEXPECTED_ASSERT(
          const Fw::StringBase& file, 
          U32 line, 
          U32 numArgs 
      ) const;

    protected:

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

      Fw::Time getTime() const;

    private:

      // ----------------------------------------------------------------------
      // Special 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];

  };

}

#endif