PrmDbComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_PrmDbComponentAc_HPP
#define Svc_PrmDbComponentAc_HPP

#include <atomic>

#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
#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/Time/TimePortAc.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Ping/PingPortAc.hpp"
#include "Svc/PrmDb/PrmDb_MergeEnumAc.hpp"
#include "Svc/PrmDb/PrmDb_PrmDbFileLoadStateEnumAc.hpp"
#include "Svc/PrmDb/PrmDb_PrmLoadActionEnumAc.hpp"
#include "Svc/PrmDb/PrmDb_PrmReadErrorEnumAc.hpp"
#include "Svc/PrmDb/PrmDb_PrmWriteErrorEnumAc.hpp"
#include "default/config/FwPrmIdTypeAliasAc.hpp"
#include "default/config/FwSizeStoreTypeAliasAc.hpp"

namespace Svc {

  class PrmDbComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class PrmDbTesterBase;
      friend class PrmDbTester;

    protected:

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

      enum {
        NUM_CMDDISP_INPUT_PORTS = 1,
      };

      enum {
        NUM_GETPRM_INPUT_PORTS = 1,
        NUM_PINGIN_INPUT_PORTS = 1,
        NUM_SETPRM_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREG_OUTPUT_PORTS = 1,
        NUM_CMDSTATUS_OUTPUT_PORTS = 1,
        NUM_LOG_OUTPUT_PORTS = 1,
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_TIME_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_PRM_SAVE_FILE = 0x0, 
        OPCODE_PRM_LOAD_FILE = 0x1, 
        OPCODE_PRM_COMMIT_STAGED = 0x2, 
      };

      enum {
        EVENTID_PRMIDNOTFOUND = 0x0, 
        EVENTID_PRMIDUPDATED = 0x1, 
        EVENTID_PRMDBFULL = 0x2, 
        EVENTID_PRMIDADDED = 0x3, 
        EVENTID_PRMFILEWRITEERROR = 0x4, 
        EVENTID_PRMFILESAVECOMPLETE = 0x5, 
        EVENTID_PRMFILEREADERROR = 0x6, 
        EVENTID_PRMFILELOADCOMPLETE = 0x7, 
        EVENTID_PRMDBCOMMITCOMPLETE = 0x8, 
        EVENTID_PRMDBCOPYALLCOMPLETE = 0x9, 
        EVENTID_PRMDBFILELOADFAILED = 0xa, 
        EVENTID_PRMDBFILELOADINVALIDACTION = 0xb, 
        EVENTID_PRMFILEBADCRC = 0xc, 
      };

      enum {
        EVENTID_PRMIDNOTFOUND_THROTTLE = 5, 
      };

    public:

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

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

#if !FW_DIRECT_PORT_CALLS

    public:

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

      Fw::InputCmdPort* get_CmdDisp_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

      Fw::InputPrmGetPort* get_getPrm_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPingPort* get_pingIn_InputPort(
          FwIndexType portNum 
      );

      Fw::InputPrmSetPort* get_setPrm_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

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

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

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

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

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

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

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

#endif

#if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION

    public:

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

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

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

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

#if FW_ENABLE_TEXT_LOGGING == 1

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

#endif

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

#endif

#if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION

    public:

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

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

#endif

    public:

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

      void regCommands();

    protected:

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

      PrmDbComponentBase(
          const char* compName = "" 
      );

      virtual ~PrmDbComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_CmdDisp_InputPorts() {
        return NUM_CMDDISP_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_getPrm_InputPorts() {
        return NUM_GETPRM_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_pingIn_InputPorts() {
        return NUM_PINGIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_setPrm_InputPorts() {
        return NUM_SETPRM_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_CmdReg_OutputPorts() {
        return NUM_CMDREG_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_CmdStatus_OutputPorts() {
        return NUM_CMDSTATUS_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_Log_OutputPorts() {
        return NUM_LOG_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_LogText_OutputPorts() {
        return NUM_LOGTEXT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_Time_OutputPorts() {
        return NUM_TIME_OUTPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_pingOut_OutputPorts() {
        return NUM_PINGOUT_OUTPUT_PORTS;
      }

    protected:

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

      bool isConnected_CmdReg_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_CmdStatus_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_Log_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      ) const;

#endif

      bool isConnected_Time_OutputPort(
          FwIndexType portNum 
      ) const;

    protected:

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

      bool isConnected_pingOut_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 CmdDisp_handlerBase(
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    protected:

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

      virtual Fw::ParamValid getPrm_handler(
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      ) = 0;

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

      virtual void setPrm_handler(
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      ) = 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
      // ----------------------------------------------------------------------

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

      void pingIn_handlerBase(
          FwIndexType portNum, 
          U32 key 
      );

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

    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 pingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

      virtual void setPrm_preMsgHook(
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      );

    protected:

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

      void pingOut_out(
          FwIndexType portNum, 
          U32 key 
      ) const;

    protected:

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

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

    protected:

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

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

      virtual void PRM_LOAD_FILE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const Fw::CmdStringArg& fileName, 
          Svc::PrmDb_Merge merge 
      ) = 0;

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

    protected:

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

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

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

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

      virtual void PRM_LOAD_FILE_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

      virtual void PRM_COMMIT_STAGED_preMsgHook(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      );

    protected:

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

      void log_WARNING_LO_PrmIdNotFound(
          FwPrmIdType Id 
      );

      void log_ACTIVITY_HI_PrmIdUpdated(
          FwPrmIdType Id 
      ) const;

      void log_WARNING_HI_PrmDbFull(
          FwPrmIdType Id 
      ) const;

      void log_ACTIVITY_HI_PrmIdAdded(
          FwPrmIdType Id 
      ) const;

      void log_WARNING_HI_PrmFileWriteError(
          Svc::PrmDb_PrmWriteError stage, 
          I32 record, 
          I32 error 
      ) const;

      void log_ACTIVITY_HI_PrmFileSaveComplete(
          U32 records 
      ) const;

      void log_WARNING_HI_PrmFileReadError(
          Svc::PrmDb_PrmReadError stage, 
          I32 record, 
          I32 error 
      ) const;

      void log_ACTIVITY_HI_PrmFileLoadComplete(
          const Fw::StringBase& databaseString, 
          U32 recordsTotal, 
          U32 recordsAdded, 
          U32 recordsUpdated 
      ) const;

      void log_ACTIVITY_HI_PrmDbCommitComplete() const;

      void log_ACTIVITY_HI_PrmDbCopyAllComplete(
          const Fw::StringBase& databaseStringSrc, 
          const Fw::StringBase& databaseStringDest 
      ) const;

      void log_WARNING_HI_PrmDbFileLoadFailed() const;

      void log_WARNING_LO_PrmDbFileLoadInvalidAction(
          Svc::PrmDb_PrmDbFileLoadState currentState, 
          Svc::PrmDb_PrmLoadAction attemptedAction 
      ) const;

      void log_WARNING_HI_PrmFileBadCrc(
          U32 readCrc, 
          U32 compCrc 
      ) const;

    protected:

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

      void log_WARNING_LO_PrmIdNotFound_ThrottleClear();

    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_CmdDisp_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Fw::CmdArgBuffer& args 
      );

    private:

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

      static Fw::ParamValid m_p_getPrm_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      );

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

      static void m_p_setPrm_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwPrmIdType id, 
          Fw::ParamBuffer& val 
      );

    private:

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

      void CmdReg_out(
          FwIndexType portNum, 
          FwOpcodeType opCode 
      ) const;

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

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

#if FW_ENABLE_TEXT_LOGGING

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

#endif

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

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::InputCmdPort m_CmdDisp_InputPort[NUM_CMDDISP_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::InputPrmGetPort m_getPrm_InputPort[NUM_GETPRM_INPUT_PORTS];

      Svc::InputPingPort m_pingIn_InputPort[NUM_PINGIN_INPUT_PORTS];

      Fw::InputPrmSetPort m_setPrm_InputPort[NUM_SETPRM_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Fw::OutputCmdRegPort m_CmdReg_OutputPort[NUM_CMDREG_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_CmdStatus_OutputPort[NUM_CMDSTATUS_OUTPUT_PORTS];

      Fw::OutputLogPort m_Log_OutputPort[NUM_LOG_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_LogText_OutputPort[NUM_LOGTEXT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

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

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

#endif

    private:

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

      std::atomic<FwIndexType> m_PrmIdNotFoundThrottle;

    private:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif