PassiveRateGroupComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_PassiveRateGroupComponentAc_HPP
#define Svc_PassiveRateGroupComponentAc_HPP

#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#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 "Svc/Cycle/CyclePortAc.hpp"
#include "Svc/Sched/SchedPortAc.hpp"

namespace Svc {

  class PassiveRateGroupComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class PassiveRateGroupTesterBase;
      friend class PassiveRateGroupTester;

    protected:

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

      enum {
        NUM_CYCLEIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_TIME_OUTPUT_PORTS = 1,
        NUM_TLM_OUTPUT_PORTS = 1,
      };

      enum {
        NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS = 10,
      };

      enum {
        CHANNELID_MAXCYCLETIME = 0x0, 
        CHANNELID_CYCLETIME = 0x1, 
        CHANNELID_CYCLECOUNT = 0x2, 
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Svc::InputCyclePort* get_CycleIn_InputPort(
          FwIndexType portNum 
      );

    public:

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

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

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

    public:

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

      void set_RateGroupMemberOut_OutputPort(
          FwIndexType portNum, 
          Svc::InputSchedPort* port 
      );

#if FW_PORT_SERIALIZATION

    public:

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

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

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

#endif

#if FW_PORT_SERIALIZATION

    public:

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

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

#endif

    protected:

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

      PassiveRateGroupComponentBase(
          const char* compName = "" 
      );

      virtual ~PassiveRateGroupComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_CycleIn_InputPorts() {
        return NUM_CYCLEIN_INPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_Time_OutputPorts() {
        return NUM_TIME_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_Tlm_OutputPorts() {
        return NUM_TLM_OUTPUT_PORTS;
      }

    protected:

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

      static constexpr FwIndexType getNum_RateGroupMemberOut_OutputPorts() {
        return NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS;
      }

    protected:

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

      bool isConnected_Time_OutputPort(
          FwIndexType portNum 
      );

      bool isConnected_Tlm_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      bool isConnected_RateGroupMemberOut_OutputPort(
          FwIndexType portNum 
      );

    protected:

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

      virtual void CycleIn_handler(
          FwIndexType portNum, 
          Os::RawTime& cycleStart 
      ) = 0;

    protected:

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

      void CycleIn_handlerBase(
          FwIndexType portNum, 
          Os::RawTime& cycleStart 
      );

    protected:

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

      void RateGroupMemberOut_out(
          FwIndexType portNum, 
          U32 context 
      );

    protected:

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

      void tlmWrite_MaxCycleTime(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

      void tlmWrite_CycleTime(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

      void tlmWrite_CycleCount(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    protected:

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

      Fw::Time getTime() const;

    private:

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

      static void m_p_CycleIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Os::RawTime& cycleStart 
      );

    private:

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

      Svc::InputCyclePort m_CycleIn_InputPort[NUM_CYCLEIN_INPUT_PORTS];

    private:

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

      Fw::OutputTimePort m_Time_OutputPort[NUM_TIME_OUTPUT_PORTS];

      Fw::OutputTlmPort m_Tlm_OutputPort[NUM_TLM_OUTPUT_PORTS];

    private:

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

      Svc::OutputSchedPort m_RateGroupMemberOut_OutputPort[NUM_RATEGROUPMEMBEROUT_OUTPUT_PORTS];

    private:

      // ----------------------------------------------------------------------
      // First update flags for telemetry channels
      // ----------------------------------------------------------------------

      bool m_first_update_MaxCycleTime = true;

    private:

      // ----------------------------------------------------------------------
      // Last value storage for telemetry channels
      // ----------------------------------------------------------------------

      U32 m_last_MaxCycleTime = {};

  };

}

#endif