ComLoggerComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_ComLoggerComponentAc_HPP
#define Svc_ComLoggerComponentAc_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/Com/ComPortAc.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 "Svc/Ping/PingPortAc.hpp"

namespace Svc {

  class ComLoggerComponentBase :
    public Fw::ActiveComponentBase
  {

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

      friend class ComLoggerComponentBaseFriend;
      friend class ComLoggerTesterBase;

    PROTECTED:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

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

      enum {
        NUM_LOGTEXT_OUTPUT_PORTS = 1,
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_LOGOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_PINGOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_CLOSEFILE = 0x0, 
      };

      enum {
        EVENTID_FILEOPENERROR = 0x0, 
        EVENTID_FILEWRITEERROR = 0x1, 
        EVENTID_FILEVALIDATIONERROR = 0x2, 
        EVENTID_FILECLOSED = 0x3, 
        EVENTID_FILENOTINITIALIZED = 0x4,
      };

      enum {
        EVENTID_FILENOTINITIALIZED_THROTTLE = 5, 
      };

    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::InputComPort* get_comIn_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_cmdRegOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputCmdRegPort* port 
      );

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

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

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

    public:

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

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

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

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

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

#endif

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

      ComLoggerComponentBase(
          const char* compName = "" 
      );

      virtual ~ComLoggerComponentBase();

    PROTECTED:

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

      FwIndexType getNum_cmdIn_InputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_comIn_InputPorts() const;

      FwIndexType getNum_pingIn_InputPorts() const;

    PROTECTED:

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

#if FW_ENABLE_TEXT_LOGGING == 1

      FwIndexType getNum_LogText_OutputPorts() const;

#endif

      FwIndexType getNum_cmdRegOut_OutputPorts() const;

      FwIndexType getNum_cmdResponseOut_OutputPorts() const;

      FwIndexType getNum_logOut_OutputPorts() const;

      FwIndexType getNum_timeCaller_OutputPorts() const;

    PROTECTED:

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

      FwIndexType getNum_pingOut_OutputPorts() const;

    PROTECTED:

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

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_LogText_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_cmdRegOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_logOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      bool isConnected_pingOut_OutputPort(
          FwIndexType portNum 
      );

    PROTECTED:

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

      virtual void comIn_handler(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      ) = 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 comIn_handlerBase(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      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 comIn_preMsgHook(
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

      virtual void pingIn_preMsgHook(
          FwIndexType portNum, 
          U32 key 
      );

    PROTECTED:

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

      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 CloseFile_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq 
      ) = 0;

    PROTECTED:

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

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

    PROTECTED:

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

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

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

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

      void log_DIAGNOSTIC_FileClosed(
          const Fw::StringBase& file 
      ) const;

      void log_WARNING_LO_FileNotInitialized();

    PROTECTED:

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

      void log_WARNING_LO_FileNotInitialized_ThrottleClear();

    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_comIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::ComBuffer& data, 
          U32 context 
      );

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

      Fw::InputComPort m_comIn_InputPort[NUM_COMIN_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::OutputCmdRegPort m_cmdRegOut_OutputPort[NUM_CMDREGOUT_OUTPUT_PORTS];

      Fw::OutputCmdResponsePort m_cmdResponseOut_OutputPort[NUM_CMDRESPONSEOUT_OUTPUT_PORTS];

      Fw::OutputLogPort m_logOut_OutputPort[NUM_LOGOUT_OUTPUT_PORTS];

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

    PRIVATE:

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

      Svc::OutputPingPort m_pingOut_OutputPort[NUM_PINGOUT_OUTPUT_PORTS];

    PRIVATE:

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

      std::atomic<FwIndexType> m_FileNotInitializedThrottle;

  };

}

#endif