FileAnnouncePortAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_FileAnnouncePortAc_HPP
#define Svc_FileAnnouncePortAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/ExternalString.hpp"
#include "Fw/Types/Serializable.hpp"
#include "default/config/FwSizeStoreTypeAliasAc.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Comp/PassiveComponentBase.hpp"
#include "Fw/Port/InputPortBase.hpp"
#include "Fw/Port/OutputPortBase.hpp"
#endif

namespace Svc {

  class FileAnnouncePortBuffer :
    public Fw::LinearBufferBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constants for FileAnnouncePortBuffer
      // ----------------------------------------------------------------------

      static constexpr FwSizeType CAPACITY =
        Fw::StringBase::STATIC_SERIALIZED_SIZE(static_cast<FwSizeType>(FW_FIXED_LENGTH_STRING_SIZE));

    public:

      // ----------------------------------------------------------------------
      // Public member functions for FileAnnouncePortBuffer
      // ----------------------------------------------------------------------

      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 FileAnnouncePortSerializer {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for FileAnnouncePortSerializer
      // ----------------------------------------------------------------------

      FileAnnouncePortSerializer();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for FileAnnouncePortSerializer
      // ----------------------------------------------------------------------

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

    public:

      // ----------------------------------------------------------------------
      // Public static functions for FileAnnouncePortSerializer
      // ----------------------------------------------------------------------

      static Fw::SerializeStatus serializePortArgs(
          Fw::StringBase& file_name, 
          Fw::SerialBufferBase& _buffer 
      );

    private:

      // ----------------------------------------------------------------------
      // Private member variables for FileAnnouncePortSerializer
      // ----------------------------------------------------------------------

      char m___fprime_ac_file_name_buffer[Fw::StringBase::BUFFER_SIZE(static_cast<FwSizeType>(FW_FIXED_LENGTH_STRING_SIZE))];

    public:

      // ----------------------------------------------------------------------
      // Public member variables for FileAnnouncePortSerializer
      // ----------------------------------------------------------------------

      Fw::ExternalString m_file_name;

  };

#if !FW_DIRECT_PORT_CALLS

  class InputFileAnnouncePort :
    public Fw::InputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public types for InputFileAnnouncePort
      // ----------------------------------------------------------------------

      typedef void (*CompFuncPtr)(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        Fw::StringBase& file_name
      );

    public:

      // ----------------------------------------------------------------------
      // Public constructors for InputFileAnnouncePort
      // ----------------------------------------------------------------------

      InputFileAnnouncePort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for InputFileAnnouncePort
      // ----------------------------------------------------------------------

      void init();

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

      void invoke(
          Fw::StringBase& file_name 
      );

    private:

      // ----------------------------------------------------------------------
      // Private member functions for InputFileAnnouncePort
      // ----------------------------------------------------------------------

#if FW_PORT_SERIALIZATION == 1

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

#endif

    private:

      // ----------------------------------------------------------------------
      // Private member variables for InputFileAnnouncePort
      // ----------------------------------------------------------------------

      CompFuncPtr m_func;

  };

  class OutputFileAnnouncePort :
    public Fw::OutputPortBase
  {

    public:

      // ----------------------------------------------------------------------
      // Public constructors for OutputFileAnnouncePort
      // ----------------------------------------------------------------------

      OutputFileAnnouncePort();

    public:

      // ----------------------------------------------------------------------
      // Public member functions for OutputFileAnnouncePort
      // ----------------------------------------------------------------------

      void init();

      void addCallPort(
          InputFileAnnouncePort* callPort 
      );

      void invoke(
          Fw::StringBase& file_name 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Private member variables for OutputFileAnnouncePort
      // ----------------------------------------------------------------------

      InputFileAnnouncePort* m_port;

  };

#endif

}

#endif