FileUplinkComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_FileUplinkComponentAc_HPP
#define Svc_FileUplinkComponentAc_HPP

#include <atomic>

#include "Fw/Buffer/BufferSendPortAc.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 "Svc/Ping/PingPortAc.hpp"
#include "Svc/Ports/FilePorts/FileAnnouncePortAc.hpp"
#include "default/config/FwPacketDescriptorTypeAliasAc.hpp"
#include "default/config/FwSizeStoreTypeAliasAc.hpp"

namespace Svc {

  class FileUplinkComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class FileUplinkTesterBase;
      friend class FileUplinkTester;

    protected:

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

      enum {
        NUM_BUFFERSENDIN_INPUT_PORTS = 1,
        NUM_PINGIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_EVENTOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

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

      enum {
        EVENTID_BADCHECKSUM = 0x0, 
        EVENTID_FILEOPENERROR = 0x1, 
        EVENTID_FILERECEIVED = 0x2, 
        EVENTID_FILEWRITEERROR = 0x3, 
        EVENTID_INVALIDRECEIVEMODE = 0x4, 
        EVENTID_PACKETOUTOFBOUNDS = 0x5, 
        EVENTID_PACKETOUTOFORDER = 0x6, 
        EVENTID_PACKETDUPLICATE = 0x7, 
        EVENTID_UPLINKCANCELED = 0x8, 
        EVENTID_DECODEERROR = 0x9, 
        EVENTID_INVALIDPACKETRECEIVED = 0xa, 
      };

      enum {
        EVENTID_FILEWRITEERROR_THROTTLE = 5, 
        EVENTID_INVALIDRECEIVEMODE_THROTTLE = 5, 
        EVENTID_PACKETOUTOFBOUNDS_THROTTLE = 5, 
        EVENTID_PACKETOUTOFORDER_THROTTLE = 20, 
        EVENTID_PACKETDUPLICATE_THROTTLE = 20, 
      };

      enum {
        CHANNELID_FILESRECEIVED = 0x0, 
        CHANNELID_PACKETSRECEIVED = 0x1, 
        CHANNELID_WARNINGS = 0x2, 
      };

    public:

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

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

    public:

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

      Fw::InputBufferSendPort* get_bufferSendIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPingPort* get_pingIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

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

      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_bufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

      void set_fileAnnounce_OutputPort(
          FwIndexType portNum, 
          Svc::InputFileAnnouncePort* port 
      );

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

#if FW_PORT_SERIALIZATION

    public:

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

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

      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_bufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

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

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

#endif

    protected:

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

      FileUplinkComponentBase(
          const char* compName = "" 
      );

      virtual ~FileUplinkComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_bufferSendIn_InputPorts() {
        return NUM_BUFFERSENDIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingIn_InputPorts() {
        return NUM_PINGIN_INPUT_PORTS;
      }

    protected:

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

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_LogText_OutputPorts() {
        return NUM_LOGTEXT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_eventOut_OutputPorts() {
        return NUM_EVENTOUT_OUTPUT_PORTS;
      }

      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_bufferSendOut_OutputPorts() {
        return NUM_BUFFERSENDOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_fileAnnounce_OutputPorts() {
        return NUM_FILEANNOUNCE_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingOut_OutputPorts() {
        return NUM_PINGOUT_OUTPUT_PORTS;
      }

    protected:

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

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_eventOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      bool isConnected_bufferSendOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_fileAnnounce_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      virtual void bufferSendIn_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 bufferSendIn_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 bufferSendIn_preMsgHook(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      virtual void pingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

    protected:

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

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

      void fileAnnounce_out(
          FwIndexType portNum, 
          Fw::StringBase& file_name 
      );

      void pingOut_out(
          FwIndexType portNum, 
          U32 key 
      );

    protected:

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

      void log_WARNING_HI_BadChecksum(
          const Fw::StringBase& fileName, 
          U32 computed, 
          U32 read 
      ) const;

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

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

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

      void log_WARNING_HI_InvalidReceiveMode(
          FwPacketDescriptorType packetType, 
          U32 mode 
      );

      void log_WARNING_HI_PacketOutOfBounds(
          U32 packetIndex, 
          const Fw::StringBase& fileName 
      );

      void log_WARNING_HI_PacketOutOfOrder(
          U32 packetIndex, 
          U32 lastPacketIndex 
      );

      void log_WARNING_HI_PacketDuplicate(
          U32 packetIndex 
      );

      void log_ACTIVITY_HI_UplinkCanceled() const;

      void log_WARNING_HI_DecodeError(
          I32 status 
      ) const;

      void log_WARNING_HI_InvalidPacketReceived(
          FwPacketDescriptorType packetType 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Event throttle reset functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_FileWriteError_ThrottleClear();

      void log_WARNING_HI_InvalidReceiveMode_ThrottleClear();

      void log_WARNING_HI_PacketOutOfBounds_ThrottleClear();

      void log_WARNING_HI_PacketOutOfOrder_ThrottleClear();

      void log_WARNING_HI_PacketDuplicate_ThrottleClear();

    protected:

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

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

      void tlmWrite_PacketsReceived(
          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;

    private:

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

      virtual MsgDispatchStatus doDispatch();

    private:

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

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

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

    private:

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

      Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS];

      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];

    private:

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

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];

#endif

      Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

    private:

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

      Fw::OutputBufferSendPort m_bufferSendOut_OutputPort[NUM_BUFFERSENDOUT_OUTPUT_PORTS];

      Svc::OutputFileAnnouncePort m_fileAnnounce_OutputPort[NUM_FILEANNOUNCE_OUTPUT_PORTS];

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // Counter values for event throttling
      // ----------------------------------------------------------------------

      std::atomic<FwIndexType> m_FileWriteErrorThrottle;

      std::atomic<FwIndexType> m_InvalidReceiveModeThrottle;

      std::atomic<FwIndexType> m_PacketOutOfBoundsThrottle;

      std::atomic<FwIndexType> m_PacketOutOfOrderThrottle;

      std::atomic<FwIndexType> m_PacketDuplicateThrottle;

  };

}

#endif