LogTextPortAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  LogTextPortAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for LogText port
// ======================================================================
 
#ifndef Fw_LogTextPortAc_HPP
#define Fw_LogTextPortAc_HPP
 
#include <cstdio>
#include <cstring>
 
#include "FpConfig.hpp"
#include "Fw/Comp/PassiveComponentBase.hpp"
#include "Fw/Log/LogSeverityEnumAc.hpp"
#include "Fw/Log/TextLogString.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 InputLogTextPort :
    public Fw::InputPortBase
  {
 
    public:
 
      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------
 
      enum {
        SERIALIZED_SIZE =
          sizeof(FwEventIdType) +
          Fw::Time::SERIALIZED_SIZE +
          Fw::LogSeverity::SERIALIZED_SIZE +
          Fw::TextLogString::SERIALIZED_SIZE
      };
 
    public:
 
      // ----------------------------------------------------------------------
      // Types
      // ----------------------------------------------------------------------
 
      typedef void (*CompFuncPtr)(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        FwEventIdType id,
        Fw::Time& timeTag,
        const Fw::LogSeverity& severity,
        Fw::TextLogString& text
      );
 
    public:
 
      // ----------------------------------------------------------------------
      // Input Port Member functions
      // ----------------------------------------------------------------------
 
      InputLogTextPort();
 
      void init();
 
      void addCallComp(
          Fw::PassiveComponentBase* callComp, 
          CompFuncPtr funcPtr 
      );
 
      void invoke(
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::TextLogString& text 
      );
 
    private:
 
#if FW_PORT_SERIALIZATION == 1
 
      Fw::SerializeStatus invokeSerial(Fw::SerializeBufferBase& _buffer);
 
#endif
 
    private:
 
      // ----------------------------------------------------------------------
      // Member variables
      // ----------------------------------------------------------------------
 
      CompFuncPtr m_func;
 
  };
 
  class OutputLogTextPort :
    public Fw::OutputPortBase
  {
 
    public:
 
      // ----------------------------------------------------------------------
      // Output Port Member functions
      // ----------------------------------------------------------------------
 
      OutputLogTextPort();
 
      void init();
 
      void addCallPort(
          InputLogTextPort* callPort 
      );
 
      void invoke(
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::TextLogString& text 
      ) const;
 
    private:
 
      // ----------------------------------------------------------------------
      // Member variables
      // ----------------------------------------------------------------------
 
      InputLogTextPort* m_port;
 
  };
 
}
 
#endif