DpWriterComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_DpWriterComponentAc_HPP
#define Svc_DpWriterComponentAc_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 "Svc/DpPorts/DpWrittenPortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
#include "default/config/FwSizeTypeAliasAc.hpp"

namespace Svc {

  class DpWriterComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class DpWriterTesterBase;
      friend class DpWriterTester;

    protected:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

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

      enum {
        NUM_CMDREGIN_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_EVENTOUT_OUTPUT_PORTS = 1,
        NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
        NUM_TIMEGETOUT_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_DEALLOCBUFFERSENDOUT_OUTPUT_PORTS = 1,
        NUM_DPWRITTENOUT_OUTPUT_PORTS = 1,
        NUM_PROCBUFFERSENDOUT_OUTPUT_PORTS = 5,
      };

      enum {
        OPCODE_CLEAR_EVENT_THROTTLE = 0x0, 
      };

      enum {
        EVENTID_INVALIDBUFFER = 0x0, 
        EVENTID_BUFFERTOOSMALLFORPACKET = 0x1, 
        EVENTID_INVALIDHEADERHASH = 0x2, 
        EVENTID_INVALIDHEADER = 0x3, 
        EVENTID_BUFFERTOOSMALLFORDATA = 0x4, 
        EVENTID_FILEOPENERROR = 0x5, 
        EVENTID_FILEWRITEERROR = 0x6, 
        EVENTID_FILEWRITTEN = 0x7, 
      };

      enum {
        EVENTID_INVALIDBUFFER_THROTTLE = 10, 
        EVENTID_BUFFERTOOSMALLFORPACKET_THROTTLE = 10, 
        EVENTID_INVALIDHEADERHASH_THROTTLE = 10, 
        EVENTID_INVALIDHEADER_THROTTLE = 10, 
        EVENTID_BUFFERTOOSMALLFORDATA_THROTTLE = 10, 
        EVENTID_FILEOPENERROR_THROTTLE = 10, 
        EVENTID_FILEWRITEERROR_THROTTLE = 10, 
      };

      enum {
        CHANNELID_NUMBUFFERSRECEIVED = 0x0, 
        CHANNELID_NUMBYTESWRITTEN = 0x1, 
        CHANNELID_NUMSUCCESSFULWRITES = 0x2, 
        CHANNELID_NUMFAILEDWRITES = 0x3, 
        CHANNELID_NUMERRORS = 0x4, 
      };

    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
      // ----------------------------------------------------------------------

      Fw::InputBufferSendPort* get_bufferSendIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_schedIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

      void set_cmdRegIn_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_timeGetOut_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_deallocBufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputBufferSendPort* port 
      );

      void set_dpWrittenOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputDpWrittenPort* port 
      );

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

#if FW_PORT_SERIALIZATION

    public:

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

      void set_cmdRegIn_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_timeGetOut_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_deallocBufferSendOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

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

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

#endif

    public:

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

      void regCommands();

    protected:

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

      DpWriterComponentBase(
          const char* compName = "" 
      );

      virtual ~DpWriterComponentBase();

    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_bufferSendIn_InputPorts() {
        return NUM_BUFFERSENDIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_schedIn_InputPorts() {
        return NUM_SCHEDIN_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_cmdRegIn_OutputPorts() {
        return NUM_CMDREGIN_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_timeGetOut_OutputPorts() {
        return NUM_TIMEGETOUT_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_deallocBufferSendOut_OutputPorts() {
        return NUM_DEALLOCBUFFERSENDOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dpWrittenOut_OutputPorts() {
        return NUM_DPWRITTENOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_procBufferSendOut_OutputPorts() {
        return NUM_PROCBUFFERSENDOUT_OUTPUT_PORTS;
      }

    protected:

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

      bool isConnected_cmdRegIn_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_timeGetOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      bool isConnected_deallocBufferSendOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_dpWrittenOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_procBufferSendOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

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

      virtual void schedIn_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 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 schedIn_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

    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 schedIn_preMsgHook(
          FwIndexType portNum, 
          U32 context 
      );

    protected:

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

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

      void dpWrittenOut_out(
          FwIndexType portNum, 
          const Fw::StringBase& fileName, 
          FwDpPriorityType priority, 
          FwSizeType size 
      );

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

    protected:

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

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

    protected:

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

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

    protected:

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

      void CLEAR_EVENT_THROTTLE_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 CLEAR_EVENT_THROTTLE_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    protected:

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

      void log_WARNING_HI_InvalidBuffer();

      void log_WARNING_HI_BufferTooSmallForPacket(
          FwSizeType bufferSize, 
          U32 minSize 
      );

      void log_WARNING_HI_InvalidHeaderHash(
          FwSizeType bufferSize, 
          U32 storedHash, 
          U32 computedHash 
      );

      void log_WARNING_HI_InvalidHeader(
          FwSizeType bufferSize, 
          U32 errorCode 
      );

      void log_WARNING_HI_BufferTooSmallForData(
          FwSizeType bufferSize, 
          U32 minSize 
      );

      void log_WARNING_HI_FileOpenError(
          U32 status, 
          const Fw::StringBase& file 
      );

      void log_WARNING_HI_FileWriteError(
          U32 status, 
          U32 bytesWritten, 
          U32 bytesToWrite, 
          const Fw::StringBase& file 
      );

      void log_ACTIVITY_LO_FileWritten(
          U32 bytes, 
          const Fw::StringBase& file 
      ) const;

    protected:

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

      void log_WARNING_HI_InvalidBuffer_ThrottleClear();

      void log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear();

      void log_WARNING_HI_InvalidHeaderHash_ThrottleClear();

      void log_WARNING_HI_InvalidHeader_ThrottleClear();

      void log_WARNING_HI_BufferTooSmallForData_ThrottleClear();

      void log_WARNING_HI_FileOpenError_ThrottleClear();

      void log_WARNING_HI_FileWriteError_ThrottleClear();

    protected:

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

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

      void tlmWrite_NumBytesWritten(
          U64 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

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

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

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

    protected:

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

      Fw::Time getTime() const;

    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_bufferSendIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

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

    private:

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

      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];

    private:

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

      Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS];

      Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];

    private:

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

      Fw::OutputCmdRegPort m_cmdRegIn_OutputPort[NUM_CMDREGIN_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_timeGetOut_OutputPort[NUM_TIMEGETOUT_OUTPUT_PORTS];

      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

    private:

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

      Fw::OutputBufferSendPort m_deallocBufferSendOut_OutputPort[NUM_DEALLOCBUFFERSENDOUT_OUTPUT_PORTS];

      Svc::OutputDpWrittenPort m_dpWrittenOut_OutputPort[NUM_DPWRITTENOUT_OUTPUT_PORTS];

      Fw::OutputBufferSendPort m_procBufferSendOut_OutputPort[NUM_PROCBUFFERSENDOUT_OUTPUT_PORTS];

    private:

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

      std::atomic<FwIndexType> m_InvalidBufferThrottle;

      std::atomic<FwIndexType> m_BufferTooSmallForPacketThrottle;

      std::atomic<FwIndexType> m_InvalidHeaderHashThrottle;

      std::atomic<FwIndexType> m_InvalidHeaderThrottle;

      std::atomic<FwIndexType> m_BufferTooSmallForDataThrottle;

      std::atomic<FwIndexType> m_FileOpenErrorThrottle;

      std::atomic<FwIndexType> m_FileWriteErrorThrottle;

    private:

      // ----------------------------------------------------------------------
      // First update flags for telemetry channels
      // ----------------------------------------------------------------------

      bool m_first_update_NumBuffersReceived = true;

      bool m_first_update_NumBytesWritten = true;

      bool m_first_update_NumSuccessfulWrites = true;

      bool m_first_update_NumFailedWrites = true;

      bool m_first_update_NumErrors = true;

    private:

      // ----------------------------------------------------------------------
      // Last value storage for telemetry channels
      // ----------------------------------------------------------------------

      U32 m_last_NumBuffersReceived = {};

      U64 m_last_NumBytesWritten = {};

      U32 m_last_NumSuccessfulWrites = {};

      U32 m_last_NumFailedWrites = {};

      U32 m_last_NumErrors = {};

  };

}

#endif