TimeConverterComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_TimeConverterComponentAc_HPP
#define Svc_TimeConverterComponentAc_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"
#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/Time/TimePortAc.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Ports/TimeConverterPorts/ConvertTimePortAc.hpp"
#include "Svc/Ports/TimeConverterPorts/TimeOffsetSendPortAc.hpp"
#include "default/config/TimeBaseEnumAc.hpp"

namespace Svc {

  class TimeConverterComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class TimeConverterTesterBase;
      friend class TimeConverterTester;

    protected:

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

      enum {
        NUM_CMDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_CONVERTTIME_INPUT_PORTS = 1,
        NUM_OFFSETUPDATE_INPUT_PORTS = 1,
      };

      enum {
        NUM_CMDREGOUT_OUTPUT_PORTS = 1,
        NUM_CMDRESPONSEOUT_OUTPUT_PORTS = 1,
        NUM_EVENTOUT_OUTPUT_PORTS = 1,
        NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
      };

      enum {
        OPCODE_SET_OFFSET = 0x0, 
        OPCODE_CLEAR_OFFSETS = 0x1, 
        OPCODE_GET_OFFSET = 0x2, 
        OPCODE_DUMP_OFFSETS = 0x3, 
      };

      enum {
        EVENTID_NOCONVERSIONAVAILABLE = 0x0, 
        EVENTID_INVALIDTIME = 0x1, 
        EVENTID_OFFSETSET = 0x2, 
        EVENTID_OFFSETTABLEFULL = 0x3, 
        EVENTID_OFFSETSCLEARED = 0x4, 
        EVENTID_OFFSETREPORT = 0x5, 
        EVENTID_NOOFFSETSTORED = 0x6, 
        EVENTID_OFFSETTABLEEMPTY = 0x7, 
        EVENTID_IDENTICALTIMEBASES = 0x8, 
        EVENTID_OFFSETOUTOFRANGE = 0x9, 
        EVENTID_UNUSABLETIMEBASE = 0xa, 
      };

      enum {
        EVENTID_NOCONVERSIONAVAILABLE_THROTTLE = 5, 
        EVENTID_INVALIDTIME_THROTTLE = 5, 
        EVENTID_OFFSETTABLEFULL_THROTTLE = 5, 
        EVENTID_IDENTICALTIMEBASES_THROTTLE = 5, 
        EVENTID_OFFSETOUTOFRANGE_THROTTLE = 5, 
        EVENTID_UNUSABLETIMEBASE_THROTTLE = 5, 
      };

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

      Svc::InputConvertTimePort* get_convertTime_InputPort(
          FwIndexType portNum 
      );

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

#endif

    public:

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

      void regCommands();

    protected:

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

      TimeConverterComponentBase(
          const char* compName = "" 
      );

      virtual ~TimeConverterComponentBase();

    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_convertTime_InputPorts() {
        return NUM_CONVERTTIME_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_offsetUpdate_InputPorts() {
        return NUM_OFFSETUPDATE_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_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_timeCaller_OutputPorts() {
        return NUM_TIMECALLER_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_eventOut_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_textEventOut_OutputPort(
          FwIndexType portNum 
      ) const;

#endif

      bool isConnected_timeCaller_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 Svc::ConvertTimeStatus convertTime_handler(
          FwIndexType portNum, 
          const Fw::Time& in_time, 
          Fw::Time& out_time 
      ) = 0;

      virtual void offsetUpdate_handler(
          FwIndexType portNum, 
          const Svc::TimeOffset& offset
      ) = 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
      // ----------------------------------------------------------------------

      Svc::ConvertTimeStatus convertTime_handlerBase(
          FwIndexType portNum, 
          const Fw::Time& in_time, 
          Fw::Time& out_time 
      );

      void offsetUpdate_handlerBase(
          FwIndexType portNum, 
          const Svc::TimeOffset& offset
      );

    protected:

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

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

    protected:

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

      virtual void SET_OFFSET_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const TimeBase& from, 
          const TimeBase& to, 
          I64 offset_us 
      ) = 0;

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

      virtual void GET_OFFSET_cmdHandler(
          FwOpcodeType opCode, 
          U32 cmdSeq, 
          const TimeBase& from, 
          const TimeBase& to 
      ) = 0;

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

    protected:

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

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

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

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

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

    protected:

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

      void log_WARNING_LO_NoConversionAvailable(
          const TimeBase& in_tb, 
          const TimeBase& out_tb 
      );

      void log_WARNING_LO_InvalidTime(
          const TimeBase& in_tb, 
          const TimeBase& out_tb, 
          I64 offset_us, 
          I64 in_time_us 
      );

      void log_ACTIVITY_HI_OffsetSet(
          const TimeBase& from, 
          const TimeBase& to, 
          I64 offset_us 
      ) const;

      void log_WARNING_HI_OffsetTableFull(
          const TimeBase& from, 
          const TimeBase& to, 
          U32 capacity 
      );

      void log_ACTIVITY_HI_OffsetsCleared(
          U32 entries 
      ) const;

      void log_ACTIVITY_HI_OffsetReport(
          const TimeBase& from, 
          const TimeBase& to, 
          I64 offset_us 
      ) const;

      void log_WARNING_LO_NoOffsetStored(
          const TimeBase& from, 
          const TimeBase& to 
      ) const;

      void log_ACTIVITY_HI_OffsetTableEmpty() const;

      void log_WARNING_LO_IdenticalTimeBases(
          const TimeBase& tb 
      );

      void log_WARNING_HI_OffsetOutOfRange(
          const TimeBase& from, 
          const TimeBase& to, 
          I64 offset_us 
      );

      void log_WARNING_HI_UnusableTimeBase(
          const TimeBase& tb 
      );

    protected:

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

      void log_WARNING_LO_NoConversionAvailable_ThrottleClear();

      void log_WARNING_LO_InvalidTime_ThrottleClear();

      void log_WARNING_HI_OffsetTableFull_ThrottleClear();

      void log_WARNING_LO_IdenticalTimeBases_ThrottleClear();

      void log_WARNING_HI_OffsetOutOfRange_ThrottleClear();

      void log_WARNING_HI_UnusableTimeBase_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:

      // ----------------------------------------------------------------------
      // 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 Svc::ConvertTimeStatus m_p_convertTime_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Fw::Time& in_time, 
          Fw::Time& out_time 
      );

      static void m_p_offsetUpdate_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Svc::TimeOffset& offset
      );

    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;

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

#if FW_ENABLE_TEXT_LOGGING

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

#endif

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

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

      Svc::InputConvertTimePort m_convertTime_InputPort[NUM_CONVERTTIME_INPUT_PORTS];

      Svc::InputTimeOffsetSendPort m_offsetUpdate_InputPort[NUM_OFFSETUPDATE_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::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_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

#endif

    private:

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

      std::atomic<FwIndexType> m_NoConversionAvailableThrottle;

      std::atomic<FwIndexType> m_InvalidTimeThrottle;

      std::atomic<FwIndexType> m_OffsetTableFullThrottle;

      std::atomic<FwIndexType> m_IdenticalTimeBasesThrottle;

      std::atomic<FwIndexType> m_OffsetOutOfRangeThrottle;

      std::atomic<FwIndexType> m_UnusableTimeBaseThrottle;

    private:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif