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 "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogBuffer.hpp"
#include "Fw/Log/LogSeverityEnumAc.hpp"
#include "Fw/Time/Time.hpp"
#include "Fw/Types/Serializable.hpp"
#include "default/config/FwEventIdTypeAliasAc.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Comp/PassiveComponentBase.hpp"
#include "Fw/Port/InputPortBase.hpp"
#include "Fw/Port/OutputPortBase.hpp"
#endif

namespace Fw {

  class LogPortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for LogPortBuffer
      // ----------------------------------------------------------------------

      static constexpr FwSizeType CAPACITY =
        sizeof(FwEventIdType) +
        Fw::Time::SERIALIZED_SIZE +
        Fw::LogSeverity::SERIALIZED_SIZE +
        Fw::LogBuffer::SERIALIZED_SIZE;

    public:

      // ----------------------------------------------------------------------
      // Public member functions for LogPortBuffer
      // ----------------------------------------------------------------------

      Fw::Serializable::SizeType getCapacity() const override {
        return CAPACITY;
      }

      U8* getBuffAddr() override {
        return m_buff;
      }

      const U8* getBuffAddr() const override {
        return m_buff;
      }

    private:

      // ----------------------------------------------------------------------
      // Private member variables
      // ----------------------------------------------------------------------

      U8 m_buff[CAPACITY];

  };

  class LogPortSerializer {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for LogPortSerializer
      // ----------------------------------------------------------------------

      LogPortSerializer();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for LogPortSerializer
      // ----------------------------------------------------------------------

      Fw::SerializeStatus deserializePortArgs(
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public static functions for LogPortSerializer
      // ----------------------------------------------------------------------

      static Fw::SerializeStatus serializePortArgs(
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args, 
          Fw::SerialBufferBase& _buffer 
      );

    public:

      // ----------------------------------------------------------------------
      // Public member variables for LogPortSerializer
      // ----------------------------------------------------------------------

      FwEventIdType m_id;
      Fw::Time m_timeTag;
      Fw::LogSeverity m_severity;
      Fw::LogBuffer m_args;

  };

#if !FW_DIRECT_PORT_CALLS

  class InputLogPort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputLogPort
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputLogPort
      // ----------------------------------------------------------------------

      InputLogPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for 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:

      // ----------------------------------------------------------------------
      // Private member functions for InputLogPort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

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

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputLogPort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputLogPort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputLogPort
      // ----------------------------------------------------------------------

      OutputLogPort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputLogPort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputLogPort* callPort 
      );

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

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputLogPort
      // ----------------------------------------------------------------------

      InputLogPort* m_port;

  };

#endif

}

#endif