FileDownlinkComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_FileDownlinkComponentAc_HPP
#define Svc_FileDownlinkComponentAc_HPP

#include <atomic>

#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Cmd/CmdPortAc.hpp"
#include "Fw/Cmd/CmdRegPortAc.hpp"
#include "Fw/Cmd/CmdResponsePortAc.hpp"
#include "Fw/Cmd/CmdString.hpp"
#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"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Os/Mutex.hpp"
#include "Svc/FileDownlinkPorts/SendFileCompletePortAc.hpp"
#include "Svc/FileDownlinkPorts/SendFileRequestPortAc.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"

namespace Svc {

  class FileDownlinkComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class FileDownlinkTesterBase;
      friend class FileDownlinkTester;

    protected:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_RUN_INPUT_PORTS = 1,
        NUM_SENDFILE_INPUT_PORTS = 1,
        NUM_BUFFERRETURN_INPUT_PORTS = 1,
        NUM_PINGIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_EVENTOUT_OUTPUT_PORTS = 1,
        NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_FILECOMPLETE_OUTPUT_PORTS = 1,
        NUM_BUFFERSENDOUT_OUTPUT_PORTS = 1,
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_SENDFILE = 0x0, 
        OPCODE_CANCEL = 0x1, 
        OPCODE_SENDPARTIAL = 0x2, 
      };

      enum {
        EVENTID_FILEOPENERROR = 0x0, 
        EVENTID_FILEREADERROR = 0x1, 
        EVENTID_FILESENT = 0x2, 
        EVENTID_DOWNLINKCANCELED = 0x3, 
        EVENTID_DOWNLINKTIMEOUT = 0x4, 
        EVENTID_DOWNLINKPARTIALWARNING = 0x5, 
        EVENTID_DOWNLINKPARTIALFAIL = 0x6, 
        EVENTID_SENDDATAFAIL = 0x7, 
        EVENTID_SENDSTARTED = 0x8, 
      };

      enum {
        CHANNELID_FILESSENT = 0x0, 
        CHANNELID_PACKETSSENT = 0x1, 
        CHANNELID_WARNINGS = 0x2, 
      };

    public:

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

      void init(
          FwSizeType queueDepth, 
          FwEnumStoreType instance = 0 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort* get_cmdIn_InputPort(
          FwIndexType portNum 
      );

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Svc::InputSchedPort* get_Run_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSendFileRequestPort* get_SendFile_InputPort(
          FwIndexType portNum 
      );

      Fw::InputBufferSendPort* get_bufferReturn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPingPort* get_pingIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

      void set_cmdRegOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdRegPort* port 
      );

      void set_cmdResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdResponsePort* port 
      );

      void set_eventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_textEventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

    public:

      // ----------------------------------------------------------------------
      // Connect typed input ports to typed output ports
      // ----------------------------------------------------------------------

      void set_FileComplete_OutputPort(
          FwIndexType portNum, 
          Svc::InputSendFileCompletePort* port 
      );

      void set_bufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputPingPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

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

      void set_cmdRegOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_cmdResponseOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_eventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_textEventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

#if FW_PORT_SERIALIZATION

    public:

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

      void set_FileComplete_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_bufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_pingOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Command registration
      // ----------------------------------------------------------------------

      void regCommands();

    protected:

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

      FileDownlinkComponentBase(
          const char* compName = "" 
      );

      virtual ~FileDownlinkComponentBase();

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_cmdIn_InputPorts() {
        return NUM_CMDIN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_Run_InputPorts() {
        return NUM_RUN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_SendFile_InputPorts() {
        return NUM_SENDFILE_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_bufferReturn_InputPorts() {
        return NUM_BUFFERRETURN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingIn_InputPorts() {
        return NUM_PINGIN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_cmdRegOut_OutputPorts() {
        return NUM_CMDREGOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_cmdResponseOut_OutputPorts() {
        return NUM_CMDRESPONSEOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_eventOut_OutputPorts() {
        return NUM_EVENTOUT_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_textEventOut_OutputPorts() {
        return NUM_TEXTEVENTOUT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_timeCaller_OutputPorts() {
        return NUM_TIMECALLER_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_tlmOut_OutputPorts() {
        return NUM_TLMOUT_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_FileComplete_OutputPorts() {
        return NUM_FILECOMPLETE_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_bufferSendOut_OutputPorts() {
        return NUM_BUFFERSENDOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingOut_OutputPorts() {
        return NUM_PINGOUT_OUTPUT_PORTS;
      }

    protected:

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

      bool isConnected_cmdRegOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_eventOut_OutputPort(
          FwIndexType portNum 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_textEventOut_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      bool isConnected_FileComplete_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_bufferSendOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------

      virtual void Run_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;

      virtual Svc::SendFileResponse SendFile_handler(
          FwIndexType portNum, 
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName, 
          U32 offset, 
          U32 length 
      ) = 0;

      virtual void bufferReturn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;

      virtual void pingIn_handler(
          FwIndexType portNum, 
          U32 key 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Port handler base-class functions for typed input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

      void Run_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

      Svc::SendFileResponse SendFile_handlerBase(
          FwIndexType portNum, 
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName, 
          U32 offset, 
          U32 length 
      );

      void bufferReturn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      void pingIn_handlerBase(
          FwIndexType portNum, 
          U32 key 
      );

    protected:

      // ----------------------------------------------------------------------
      // Pre-message hooks for typed async input ports
      //
      // Each of these functions is invoked just before processing a message
      // on the corresponding port. By default, they do nothing. You can
      // override them to provide specific pre-message behavior.
      // ----------------------------------------------------------------------

      virtual void Run_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );

      virtual void bufferReturn_preMsgHook(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      virtual void pingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

    protected:

      // ----------------------------------------------------------------------
      // Invocation functions for typed output ports
      // ----------------------------------------------------------------------

      void FileComplete_out(
          FwIndexType portNum, 
          const Svc::SendFileResponse& resp
      );

      void bufferSendOut_out(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      void pingOut_out(
          FwIndexType portNum, 
          U32 key 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command response
      // ----------------------------------------------------------------------

      void cmdResponse_out(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdResponse response 
      );

    protected:

      // ----------------------------------------------------------------------
      // Command handlers to implement
      // ----------------------------------------------------------------------

      virtual void SendFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& sourceFileName, 
          const Fw::CmdStringArg& destFileName 
      ) = 0;

      virtual void Cancel_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

      virtual void SendPartial_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& sourceFileName, 
          const Fw::CmdStringArg& destFileName, 
          U32 startOffset, 
          U32 length 
      ) = 0;

    protected:

      // ----------------------------------------------------------------------
      // Command handler base-class functions
      //
      // Call these functions directly to bypass the command input port
      // ----------------------------------------------------------------------

      void SendFile_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void Cancel_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

      void SendPartial_cmdHandlerBase(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    protected:

      // ----------------------------------------------------------------------
      // Pre-message hooks for async commands
      //
      // Each of these functions is invoked just before processing the
      // corresponding command. By default they do nothing. You can
      // override them to provide specific pre-command behavior.
      // ----------------------------------------------------------------------

      virtual void SendFile_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void Cancel_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void SendPartial_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    protected:

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

      void log_WARNING_HI_FileOpenError(
          const Fw::StringBase& fileName 
      ) const;

      void log_WARNING_HI_FileReadError(
          const Fw::StringBase& fileName, 
          I32 status 
      ) const;

      void log_ACTIVITY_HI_FileSent(
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName 
      ) const;

      void log_ACTIVITY_HI_DownlinkCanceled(
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName 
      ) const;

      void log_WARNING_HI_DownlinkTimeout(
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName 
      ) const;

      void log_WARNING_LO_DownlinkPartialWarning(
          U32 startOffset, 
          U32 length, 
          U32 filesize, 
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName 
      ) const;

      void log_WARNING_HI_DownlinkPartialFail(
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName, 
          U32 startOffset, 
          U32 filesize 
      ) const;

      void log_WARNING_HI_SendDataFail(
          const Fw::StringBase& sourceFileName, 
          U32 byteOffset 
      ) const;

      void log_ACTIVITY_HI_SendStarted(
          U32 fileSize, 
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------

      void tlmWrite_FilesSent(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_PacketsSent(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_Warnings(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    protected:

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

      Fw::Time getTime() const;

    protected:

      // ----------------------------------------------------------------------
      // Mutex operations for guarded ports
      //
      // You can override these operations to provide more sophisticated
      // synchronization
      // ----------------------------------------------------------------------

      virtual void lock();

      virtual void unLock();

    private:

      // ----------------------------------------------------------------------
      // Message dispatch functions
      // ----------------------------------------------------------------------

      virtual MsgDispatchStatus doDispatch();

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on special input ports
      // ----------------------------------------------------------------------

      static void m_p_cmdIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static void m_p_Run_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );

      static Svc::SendFileResponse m_p_SendFile_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Fw::StringBase& sourceFileName, 
          const Fw::StringBase& destFileName, 
          U32 offset, 
          U32 length 
      );

      static void m_p_bufferReturn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      static void m_p_pingIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 key 
      );

    private:

      // ----------------------------------------------------------------------
      // Special input ports
      // ----------------------------------------------------------------------

      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Svc::InputSchedPort m_Run_InputPort[NUM_RUN_INPUT_PORTS];

      Svc::InputSendFileRequestPort m_SendFile_InputPort[NUM_SENDFILE_INPUT_PORTS];

      Fw::InputBufferSendPort m_bufferReturn_InputPort[NUM_BUFFERRETURN_INPUT_PORTS];

      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------

      Fw::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];

      Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_textEventOut_OutputPort[NUM_TEXTEVENTOUT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Typed output ports
      // ----------------------------------------------------------------------

      Svc::OutputSendFileCompletePort m_FileComplete_OutputPort[NUM_FILECOMPLETE_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_bufferSendOut_OutputPort[NUM_BUFFERSENDOUT_OUTPUT_PORTS];

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Mutexes
      // ----------------------------------------------------------------------

      Os::Mutex m_guardedPortMutex;

  };

}

#endif