PolyDbComponentAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_PolyDbComponentAc_HPP
#define Svc_PolyDbComponentAc_HPP

#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Port/InputSerializePort.hpp"
#include "Fw/Port/OutputSerializePort.hpp"
#include "Os/Mutex.hpp"
#include "Svc/PolyIf/PolyPortAc.hpp"

namespace Svc {

  class PolyDbComponentBase :
    public Fw::PassiveComponentBase
  {

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

      friend class PolyDbTesterBase;
      friend class PolyDbTester;

    protected:

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

      enum {
        NUM_GETVALUE_INPUT_PORTS = 1,
        NUM_SETVALUE_INPUT_PORTS = 1,
      };

    public:

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

      void init(
          FwEnumStoreType instance = 0 
      );

    public:

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

      Svc::InputPolyPort* get_getValue_InputPort(
          FwIndexType portNum 
      );

      Svc::InputPolyPort* get_setValue_InputPort(
          FwIndexType portNum 
      );

    protected:

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

      PolyDbComponentBase(
          const char* compName = "" 
      );

      virtual ~PolyDbComponentBase();

    protected:

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

      static constexpr FwIndexType getNum_getValue_InputPorts() {
        return NUM_GETVALUE_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_setValue_InputPorts() {
        return NUM_SETVALUE_INPUT_PORTS;
      }

    protected:

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

      virtual void getValue_handler(
          FwIndexType portNum, 
          const Svc::PolyDbCfg::PolyDbEntry& entry, 
          Svc::MeasurementStatus& status, 
          Fw::Time& time, 
          Fw::PolyType& val 
      ) = 0;

      virtual void setValue_handler(
          FwIndexType portNum, 
          const Svc::PolyDbCfg::PolyDbEntry& entry, 
          Svc::MeasurementStatus& status, 
          Fw::Time& time, 
          Fw::PolyType& val 
      ) = 0;

    protected:

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

      void getValue_handlerBase(
          FwIndexType portNum, 
          const Svc::PolyDbCfg::PolyDbEntry& entry, 
          Svc::MeasurementStatus& status, 
          Fw::Time& time, 
          Fw::PolyType& val 
      );

      void setValue_handlerBase(
          FwIndexType portNum, 
          const Svc::PolyDbCfg::PolyDbEntry& entry, 
          Svc::MeasurementStatus& status, 
          Fw::Time& time, 
          Fw::PolyType& val 
      );

    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 typed input ports
      // ----------------------------------------------------------------------

      static void m_p_getValue_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Svc::PolyDbCfg::PolyDbEntry& entry, 
          Svc::MeasurementStatus& status, 
          Fw::Time& time, 
          Fw::PolyType& val 
      );

      static void m_p_setValue_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          const Svc::PolyDbCfg::PolyDbEntry& entry, 
          Svc::MeasurementStatus& status, 
          Fw::Time& time, 
          Fw::PolyType& val 
      );

    private:

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

      Svc::InputPolyPort m_getValue_InputPort[NUM_GETVALUE_INPUT_PORTS];

      Svc::InputPolyPort m_setValue_InputPort[NUM_SETVALUE_INPUT_PORTS];

    private:

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

      Os::Mutex m_guardedPortMutex;

  };

}

#endif