DpCompressProcComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_DpCompressProcComponentAc_HPP
#define Svc_DpCompressProcComponentAc_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/Dp/DpContainer.hpp"
#include "Fw/Dp/DpGetPortAc.hpp"
#include "Fw/Dp/DpSendPortAc.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#include "Fw/Log/LogTextPortAc.hpp"
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/InputSerializePort.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/OutputSerializePort.hpp"
#endif
#include "Fw/Prm/PrmGetPortAc.hpp"
#include "Fw/Prm/PrmSetPortAc.hpp"
#include "Fw/Prm/PrmString.hpp"
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Types/EnabledEnumAc.hpp"
#include "Os/Mutex.hpp"
#include "Svc/DpCompressProc/Ports/CompressChunkPortAc.hpp"
#include "default/config/FwDpIdTypeAliasAc.hpp"
#include "default/config/FwSizeStoreTypeAliasAc.hpp"
#include "default/config/FwSizeTypeAliasAc.hpp"

namespace Svc {

  class DpCompressProcComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class DpCompressProcTesterBase;
      friend class DpCompressProcTester;

    protected:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_PROCREQUEST_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_DPGET_OUTPUT_PORTS = 1,
        NUM_DPSEND_OUTPUT_PORTS = 1,
        NUM_LOGOUT_OUTPUT_PORTS = 1,
        NUM_LOGTEXTOUT_OUTPUT_PORTS = 1,
        NUM_PRMGETOUT_OUTPUT_PORTS = 1,
        NUM_PRMSETOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_COMPRESSCHUNK_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_CHUNK_SIZE_SET = 0x0, 
        OPCODE_CHUNK_SIZE_SAVE = 0x1, 
        OPCODE_ENABLE_SET = 0x2, 
        OPCODE_ENABLE_SAVE = 0x3, 
      };

      enum {
        EVENTID_COMPRESSIONCOMPLETE = 0x0,
        EVENTID_DIDNOTCOMPRESS = 0x1,
        EVENTID_INVALIDHEADER = 0x2, 
        EVENTID_BUFFERTOOSMALLFORPACKET = 0x3, 
        EVENTID_CONTAINERTOOLARGE = 0x4, 
      };

      enum {
        EVENTID_DIDNOTCOMPRESS_THROTTLE = 10, 
        EVENTID_INVALIDHEADER_THROTTLE = 10, 
        EVENTID_BUFFERTOOSMALLFORPACKET_THROTTLE = 10, 
        EVENTID_CONTAINERTOOLARGE_THROTTLE = 10, 
      };

      enum {
        PARAMID_CHUNK_SIZE = 0x0, 
        PARAMID_ENABLE = 0x1, 
      };

      static constexpr FwSizeType SIZE_OF_CompressionRecord_RECORD(FwSizeType arraySize) {
        return sizeof(FwDpIdType) + sizeof(FwSizeStoreType) + arraySize * sizeof(U8);
      }

    protected:

      // ----------------------------------------------------------------------
      // Types for data products
      // ----------------------------------------------------------------------

      struct ContainerId {
        enum T : FwDpIdType {
          Dummy = 0,
        };
      };

      struct ContainerPriority {
        enum T : FwDpPriorityType {
          Dummy = 0,
        };
      };

      struct RecordId {
        enum T : FwDpIdType {
          CompressionRecord = 0,
        };
      };

      class DpContainer :
        public Fw::DpContainer
      {

        public:

          DpContainer(
              FwDpIdType id, 
              const Fw::Buffer& buffer, 
              FwDpIdType baseId 
          );

          DpContainer();

        public:

          Fw::SerializeStatus serializeRecord_CompressionRecord(
              const U8* array, 
              FwSizeType size 
          );

          FwDpIdType getBaseId() const { return this->m_baseId; }

          void setBaseId(FwDpIdType baseId) { this->m_baseId = baseId; }

        private:

          FwDpIdType m_baseId;

      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

#if !FW_DIRECT_PORT_CALLS

    public:

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

      Fw::InputCmdPort* get_cmdIn_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

      Fw::InputBufferSendPort* get_procRequest_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

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

      void set_dpSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputDpSendPort* port 
      );

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

      void set_prmGetOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputPrmGetPort* port 
      );

      void set_prmSetOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputPrmSetPort* port 
      );

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

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

      void set_compressChunk_OutputPort(
          FwIndexType portNum, 
          Svc::InputCompressChunkPort* port 
      );

#endif

#if !FW_DIRECT_PORT_CALLS && 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_dpSend_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

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

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

#endif

    public:

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

      void regCommands();

    public:

      // ----------------------------------------------------------------------
      // Parameter loading
      // ----------------------------------------------------------------------

      void loadParameters();

    protected:

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

      DpCompressProcComponentBase(
          const char* compName = "" 
      );

      virtual ~DpCompressProcComponentBase();

    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_procRequest_InputPorts() {
        return NUM_PROCREQUEST_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_dpGet_OutputPorts() {
        return NUM_DPGET_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_dpSend_OutputPorts() {
        return NUM_DPSEND_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_logOut_OutputPorts() {
        return NUM_LOGOUT_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_logTextOut_OutputPorts() {
        return NUM_LOGTEXTOUT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_prmGetOut_OutputPorts() {
        return NUM_PRMGETOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_prmSetOut_OutputPorts() {
        return NUM_PRMSETOUT_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_timeCaller_OutputPorts() {
        return NUM_TIMECALLER_OUTPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_compressChunk_OutputPorts() {
        return NUM_COMPRESSCHUNK_OUTPUT_PORTS;
      }

    protected:

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

      bool isConnected_cmdRegOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_dpGet_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_dpSend_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_logOut_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_logTextOut_OutputPort(
          FwIndexType portNum 
      ) const;

#endif

      bool isConnected_prmGetOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_prmSetOut_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      ) const;

    protected:

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

      bool isConnected_compressChunk_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

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

      void cmdIn_handlerBase(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    protected:

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

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

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

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

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

    protected:

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

      Svc::CompressionAlgorithm compressChunk_out(
          FwIndexType portNum, 
          Fw::Buffer& buffer,
          FwSizeType min_compression,
          FwSizeType write_offset
      ) const;

    protected:

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

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

    protected:

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

      void log_DIAGNOSTIC_CompressionComplete(
          FwDpIdType dp_id,
          FwSizeType initial_size,
          FwSizeType final_size
      ) const;

      void log_ACTIVITY_LO_DidNotCompress(
          FwDpIdType dp_id,
          FwSizeType data_size
      );

      void log_WARNING_HI_InvalidHeader(
          FwSizeType buffer_size, 
          U32 error_code 
      );

      void log_WARNING_HI_BufferTooSmallForPacket(
          FwSizeType buffer_size, 
          FwSizeType min_size 
      );

      void log_WARNING_HI_ContainerTooLarge(
          FwDpIdType dp_id, 
          FwSizeType data_size 
      );

    protected:

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

      void log_ACTIVITY_LO_DidNotCompress_ThrottleClear();

      void log_WARNING_HI_InvalidHeader_ThrottleClear();

      void log_WARNING_HI_BufferTooSmallForPacket_ThrottleClear();

      void log_WARNING_HI_ContainerTooLarge_ThrottleClear();

    protected:

      // ----------------------------------------------------------------------
      // Parameter hook functions
      // ----------------------------------------------------------------------

      virtual void parameterUpdated(
          FwPrmIdType id 
      );

      virtual void parametersLoaded();

    protected:

      // ----------------------------------------------------------------------
      // Parameter get functions
      // ----------------------------------------------------------------------

      FwSizeStoreType paramGet_CHUNK_SIZE(
          Fw::ParamValid& valid 
      );

      Fw::Enabled paramGet_ENABLE(
          Fw::ParamValid& valid 
      );

    protected:

      // ----------------------------------------------------------------------
      // Functions for managing data products
      // ----------------------------------------------------------------------

      Fw::Success::T dpGet_Dummy(
          FwSizeType dataSize, 
          DpContainer& container 
      ) {
        return this->dpGet(
          ContainerId::Dummy,
          dataSize,
          ContainerPriority::Dummy,
          container
        );
      }

      void dpSend(
          DpContainer& container, 
          Fw::Time timeTag = Fw::ZERO_TIME 
      );

    protected:

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

      Fw::Time getTime() const;

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

    private:

      // ----------------------------------------------------------------------
      // Invocation functions for special output ports
      // ----------------------------------------------------------------------

      void cmdRegOut_out(
          FwIndexType portNum, 
          FwOpcodeType opCode 
      ) const;

      void cmdResponseOut_out(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdResponse& response 
      ) const;

      Fw::Success dpGet_out(
          FwIndexType portNum, 
          FwDpIdType id, 
          FwSizeType dataSize, 
          Fw::Buffer& buffer 
      ) const;

      void dpSend_out(
          FwIndexType portNum, 
          FwDpIdType id, 
          const Fw::Buffer& buffer 
      ) const;

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

#if FW_ENABLE_TEXT_LOGGING

      void logTextOut_out(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::TextLogString& text 
      ) const;

#endif

      Fw::ParamValid prmGetOut_out(
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      ) const;

      void prmSetOut_out(
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      ) const;

      void timeCaller_out(
          FwIndexType portNum, 
          Fw::Time& time 
      ) const;

    private:

      // ----------------------------------------------------------------------
      // Parameter set functions
      // ----------------------------------------------------------------------

      Fw::CmdResponse paramSet_CHUNK_SIZE(
          Fw::SerialBufferBase& val 
      );

      Fw::CmdResponse paramSet_ENABLE(
          Fw::SerialBufferBase& val 
      );

    private:

      // ----------------------------------------------------------------------
      // Parameter save functions
      // ----------------------------------------------------------------------

      Fw::CmdResponse paramSave_CHUNK_SIZE();

      Fw::CmdResponse paramSave_ENABLE();

    private:

      // ----------------------------------------------------------------------
      // Private data product handling functions
      // ----------------------------------------------------------------------

      Fw::Success::T dpGet(
          ContainerId::T containerId, 
          FwSizeType dataSize, 
          FwDpPriorityType priority, 
          DpContainer& container 
      );

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::InputBufferSendPort m_procRequest_InputPort[NUM_PROCREQUEST_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];

      Fw::OutputDpGetPort m_dpGet_OutputPort[NUM_DPGET_OUTPUT_PORTS];

      Fw::OutputDpSendPort m_dpSend_OutputPort[NUM_DPSEND_OUTPUT_PORTS];

      Fw::OutputLogPort m_logOut_OutputPort[NUM_LOGOUT_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_logTextOut_OutputPort[NUM_LOGTEXTOUT_OUTPUT_PORTS];

#endif

      Fw::OutputPrmGetPort m_prmGetOut_OutputPort[NUM_PRMGETOUT_OUTPUT_PORTS];

      Fw::OutputPrmSetPort m_prmSetOut_OutputPort[NUM_PRMSETOUT_OUTPUT_PORTS];

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Svc::OutputCompressChunkPort m_compressChunk_OutputPort[NUM_COMPRESSCHUNK_OUTPUT_PORTS];

#endif

    private:

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

      std::atomic<FwIndexType> m_DidNotCompressThrottle;

      std::atomic<FwIndexType> m_InvalidHeaderThrottle;

      std::atomic<FwIndexType> m_BufferTooSmallForPacketThrottle;

      std::atomic<FwIndexType> m_ContainerTooLargeThrottle;

    private:

      // ----------------------------------------------------------------------
      // Parameter validity flags
      // ----------------------------------------------------------------------

      Fw::ParamValid m_param_CHUNK_SIZE_valid = Fw::ParamValid::UNINIT;

      Fw::ParamValid m_param_ENABLE_valid = Fw::ParamValid::UNINIT;

    private:

      // ----------------------------------------------------------------------
      // Parameter variables
      // ----------------------------------------------------------------------

      FwSizeStoreType m_CHUNK_SIZE;

      Fw::Enabled m_ENABLE;

    private:

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

      Os::Mutex m_paramLock;

  };

}

#endif