VersionComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_VersionComponentAc_HPP
#define Svc_VersionComponentAc_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
#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 "Os/Mutex.hpp"
#include "Svc/Ports/VersionPorts/VersionPortAc.hpp"
#include "Svc/Version/CustomVersionDbSerializableAc.hpp"
#include "Svc/Version/VersionEnabledEnumAc.hpp"
#include "Svc/Version/VersionTypeEnumAc.hpp"
#include "default/config/VersionEnumEnumAc.hpp"

namespace Svc {

  class VersionComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class VersionTesterBase;
      friend class VersionTester;

    protected:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_GETVERSION_INPUT_PORTS = 1,
        NUM_SETVERSION_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_LOGOUT_OUTPUT_PORTS = 1,
        NUM_LOGTEXTOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_ENABLE = 0x0, 
        OPCODE_VERSION = 0x1, 
      };

      enum {
        EVENTID_FRAMEWORKVERSION = 0x0, 
        EVENTID_PROJECTVERSION = 0x1, 
        EVENTID_LIBRARYVERSIONS = 0x2, 
        EVENTID_CUSTOMVERSIONS = 0x3, 
      };

      enum {
        CHANNELID_FRAMEWORKVERSION = 0x0, 
        CHANNELID_PROJECTVERSION = 0x1, 
        CHANNELID_CUSTOMVERSION01 = 0x2, 
        CHANNELID_CUSTOMVERSION02 = 0x3, 
        CHANNELID_CUSTOMVERSION03 = 0x4, 
        CHANNELID_CUSTOMVERSION04 = 0x5, 
        CHANNELID_CUSTOMVERSION05 = 0x6, 
        CHANNELID_CUSTOMVERSION06 = 0x7, 
        CHANNELID_CUSTOMVERSION07 = 0x8, 
        CHANNELID_CUSTOMVERSION08 = 0x9, 
        CHANNELID_CUSTOMVERSION09 = 0xa, 
        CHANNELID_CUSTOMVERSION10 = 0xb, 
        CHANNELID_LIBRARYVERSION01 = 0xc, 
        CHANNELID_LIBRARYVERSION02 = 0xd, 
        CHANNELID_LIBRARYVERSION03 = 0xe, 
        CHANNELID_LIBRARYVERSION04 = 0xf, 
        CHANNELID_LIBRARYVERSION05 = 0x10, 
        CHANNELID_LIBRARYVERSION06 = 0x11, 
        CHANNELID_LIBRARYVERSION07 = 0x12, 
        CHANNELID_LIBRARYVERSION08 = 0x13, 
        CHANNELID_LIBRARYVERSION09 = 0x14, 
        CHANNELID_LIBRARYVERSION10 = 0x15, 
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Fw::InputCmdPort* get_cmdIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

      Svc::InputVersionPort* get_getVersion_InputPort(
          FwIndexType portNum 
      );

      Svc::InputVersionPort* get_setVersion_InputPort(
          FwIndexType portNum 
      );

    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_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_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

#if 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_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_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

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

#endif

    public:

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

      void regCommands();

    protected:

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

      VersionComponentBase(
          const char* compName = "" 
      );

      virtual ~VersionComponentBase();

    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_getVersion_InputPorts() {
        return NUM_GETVERSION_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_setVersion_InputPorts() {
        return NUM_SETVERSION_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_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_timeCaller_OutputPorts() {
        return NUM_TIMECALLER_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_tlmOut_OutputPorts() {
        return NUM_TLMOUT_OUTPUT_PORTS;
      }

    protected:

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

      bool isConnected_cmdRegOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_cmdResponseOut_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_logOut_OutputPort(
          FwIndexType portNum 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_logTextOut_OutputPort(
          FwIndexType portNum 
      );

#endif

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      virtual void getVersion_handler(
          FwIndexType portNum, 
          const Svc::VersionCfg::VersionEnum& version_id, 
          Fw::StringBase& version_string, 
          Svc::VersionStatus& status 
      ) = 0;

      virtual void setVersion_handler(
          FwIndexType portNum, 
          const Svc::VersionCfg::VersionEnum& version_id, 
          Fw::StringBase& version_string, 
          Svc::VersionStatus& status 
      ) = 0;

    protected:

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

      void getVersion_handlerBase(
          FwIndexType portNum, 
          const Svc::VersionCfg::VersionEnum& version_id, 
          Fw::StringBase& version_string, 
          Svc::VersionStatus& status 
      );

      void setVersion_handlerBase(
          FwIndexType portNum, 
          const Svc::VersionCfg::VersionEnum& version_id, 
          Fw::StringBase& version_string, 
          Svc::VersionStatus& status 
      );

    protected:

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

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

    protected:

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

      virtual void ENABLE_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::VersionEnabled enable 
      ) = 0;

      virtual void VERSION_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          Svc::VersionType version_type 
      ) = 0;

    protected:

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

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

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

    protected:

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

      void log_ACTIVITY_LO_FrameworkVersion(
          const Fw::StringBase& version 
      ) const;

      void log_ACTIVITY_LO_ProjectVersion(
          const Fw::StringBase& version 
      ) const;

      void log_ACTIVITY_LO_LibraryVersions(
          const Fw::StringBase& version 
      ) const;

      void log_ACTIVITY_LO_CustomVersions(
          Svc::VersionCfg::VersionEnum version_enum, 
          const Fw::StringBase& version_value 
      ) const;

    protected:

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

      void tlmWrite_FrameworkVersion(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_ProjectVersion(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion01(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion02(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion03(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion04(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion05(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion06(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion07(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion08(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion09(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CustomVersion10(
          const Svc::CustomVersionDb& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion01(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion02(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion03(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion04(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion05(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion06(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion07(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion08(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion09(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_LibraryVersion10(
          const Fw::StringBase& arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    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:

      // ----------------------------------------------------------------------
      // 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_getVersion_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Svc::VersionCfg::VersionEnum& version_id, 
          Fw::StringBase& version_string, 
          Svc::VersionStatus& status 
      );

      static void m_p_setVersion_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Svc::VersionCfg::VersionEnum& version_id, 
          Fw::StringBase& version_string, 
          Svc::VersionStatus& status 
      );

    private:

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

      Fw::InputCmdPort m_cmdIn_InputPort[NUM_CMDIN_INPUT_PORTS];

    private:

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

      Svc::InputVersionPort m_getVersion_InputPort[NUM_GETVERSION_INPUT_PORTS];

      Svc::InputVersionPort m_setVersion_InputPort[NUM_SETVERSION_INPUT_PORTS];

    private:

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

      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];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_logTextOut_OutputPort[NUM_LOGTEXTOUT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

    private:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif