LogPortAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  LogPortAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for Log port
// ======================================================================

#ifndef Fw_LogPortAc_HPP
#define Fw_LogPortAc_HPP

#include <cstdio>
#include <cstring>

#include "FpConfig.hpp"
#include "Fw/Comp/PassiveComponentBase.hpp"
#include "Fw/Log/LogBuffer.hpp"
#include "Fw/Log/LogSeverityEnumAc.hpp"
#include "Fw/Port/InputPortBase.hpp"
#include "Fw/Port/OutputPortBase.hpp"
#include "Fw/Time/Time.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/StringType.hpp"

namespace Fw {

  class InputLogPort :
    public Fw::InputPortBase
  {

    public:

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

      enum {
        SERIALIZED_SIZE =
          sizeof(FwEventIdType) +
          Fw::Time::SERIALIZED_SIZE +
          Fw::LogSeverity::SERIALIZED_SIZE +
          Fw::LogBuffer::SERIALIZED_SIZE
      };

    public:

      // ----------------------------------------------------------------------
      // Types
      // ----------------------------------------------------------------------

      typedef void (*CompFuncPtr)(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        FwEventIdType id,
        Fw::Time& timeTag,
        const Fw::LogSeverity& severity,
        Fw::LogBuffer& args
      );

    public:

      // ----------------------------------------------------------------------
      // Input Port Member functions
      // ----------------------------------------------------------------------

      InputLogPort();

      void init();

      void addCallComp(
          Fw::PassiveComponentBase* callComp, 
          CompFuncPtr funcPtr 
      );

      void invoke(
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args 
      );

    private:

#if FW_PORT_SERIALIZATION == 1

      Fw::SerializeStatus invokeSerial(Fw::SerializeBufferBase& _buffer);

#endif

    private:

      // ----------------------------------------------------------------------
      // Member variables
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputLogPort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Output Port Member functions
      // ----------------------------------------------------------------------

      OutputLogPort();

      void init();

      void addCallPort(
          InputLogPort* callPort 
      );

      void invoke(
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Member variables
      // ----------------------------------------------------------------------

      InputLogPort* m_port;

  };

}

#endif