PolyDbComponentAc.cpp

Go to the documentation of this file.

// ======================================================================
// \title  PolyDbComponentAc.cpp
// \author Generated by fpp-to-cpp
// \brief  cpp file for PolyDb component base class
// ======================================================================
 
#include <cstdio>
 
#include "F-Prime/Svc/PolyDb/PolyDbComponentAc.hpp"
#include "Fw/Types/Assert.hpp"
#if FW_ENABLE_TEXT_LOGGING
#include "Fw/Types/String.hpp"
#endif
 
namespace Svc {
 
  namespace {
    // Get the max size by doing a union of the input and internal port serialization sizes
    union BuffUnion {
      BYTE getValuePortSize[Svc::InputPolyPort::SERIALIZED_SIZE];
      BYTE setValuePortSize[Svc::InputPolyPort::SERIALIZED_SIZE];
    };
 
    // Define a message buffer class large enough to handle all the
    // asynchronous inputs to the component
    class ComponentIpcSerializableBuffer :
      public Fw::SerializeBufferBase
    {
 
      public:
 
        enum {
          // Max. message size = size of data + message id + port
          SERIALIZATION_SIZE =
            sizeof(BuffUnion) +
            sizeof(NATIVE_INT_TYPE) +
            sizeof(NATIVE_INT_TYPE)
        };
 
        NATIVE_UINT_TYPE getBuffCapacity() const {
          return sizeof(m_buff);
        }
 
        U8* getBuffAddr() {
          return m_buff;
        }
 
        const U8* getBuffAddr() const {
          return m_buff;
        }
 
      private:
        // Should be the max of all the input ports serialized sizes...
        U8 m_buff[SERIALIZATION_SIZE];
 
    };
  }
 
  // ----------------------------------------------------------------------
  // Component initialization
  // ----------------------------------------------------------------------
 
  void PolyDbComponentBase ::
    init(NATIVE_INT_TYPE instance)
  {
    // Initialize base class
    Fw::PassiveComponentBase::init(instance);
 
    // Connect input port getValue
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_getValue_InputPorts());
      port++
    ) {
      this->m_getValue_InputPort[port].init();
      this->m_getValue_InputPort[port].addCallComp(
        this,
        m_p_getValue_in
      );
      this->m_getValue_InputPort[port].setPortNum(port);
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_getValue_InputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_getValue_InputPort[port].setObjName(portName);
#endif
    }
 
    // Connect input port setValue
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_setValue_InputPorts());
      port++
    ) {
      this->m_setValue_InputPort[port].init();
      this->m_setValue_InputPort[port].addCallComp(
        this,
        m_p_setValue_in
      );
      this->m_setValue_InputPort[port].setPortNum(port);
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_setValue_InputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_setValue_InputPort[port].setObjName(portName);
#endif
    }
  }
 
  // ----------------------------------------------------------------------
  // Getters for typed input ports
  // ----------------------------------------------------------------------
 
  Svc::InputPolyPort* PolyDbComponentBase ::
    get_getValue_InputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_getValue_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return &this->m_getValue_InputPort[portNum];
  }
 
  Svc::InputPolyPort* PolyDbComponentBase ::
    get_setValue_InputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_setValue_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return &this->m_setValue_InputPort[portNum];
  }
 
  // ----------------------------------------------------------------------
  // Component construction and destruction
  // ----------------------------------------------------------------------
 
  PolyDbComponentBase ::
    PolyDbComponentBase(const char* compName) :
      Fw::PassiveComponentBase(compName)
  {
 
  }
 
  PolyDbComponentBase ::
    ~PolyDbComponentBase()
  {
 
  }
 
  // ----------------------------------------------------------------------
  // Getters for numbers of typed input ports
  // ----------------------------------------------------------------------
 
  NATIVE_INT_TYPE PolyDbComponentBase ::
    getNum_getValue_InputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_getValue_InputPort));
  }
 
  NATIVE_INT_TYPE PolyDbComponentBase ::
    getNum_setValue_InputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_setValue_InputPort));
  }
 
  // ----------------------------------------------------------------------
  // Port handler base-class functions for typed input ports
  //
  // Call these functions directly to bypass the corresponding ports
  // ----------------------------------------------------------------------
 
  void PolyDbComponentBase ::
    getValue_handlerBase(
        NATIVE_INT_TYPE portNum,
        U32 entry,
        Svc::MeasurementStatus& status,
        Fw::Time& time,
        Fw::PolyType& val
    )
  {
    // Make sure port number is valid
    FW_ASSERT(
      portNum < this->getNum_getValue_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    // Lock guard mutex before calling
    this->lock();
 
    // Down call to pure virtual handler method implemented in Impl class
    this->getValue_handler(
      portNum,
      entry,
      status,
      time,
      val
    );
 
    // Unlock guard mutex
    this->unLock();
  }
 
  void PolyDbComponentBase ::
    setValue_handlerBase(
        NATIVE_INT_TYPE portNum,
        U32 entry,
        Svc::MeasurementStatus& status,
        Fw::Time& time,
        Fw::PolyType& val
    )
  {
    // Make sure port number is valid
    FW_ASSERT(
      portNum < this->getNum_setValue_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    // Lock guard mutex before calling
    this->lock();
 
    // Down call to pure virtual handler method implemented in Impl class
    this->setValue_handler(
      portNum,
      entry,
      status,
      time,
      val
    );
 
    // Unlock guard mutex
    this->unLock();
  }
 
  // ----------------------------------------------------------------------
  // Mutex operations for guarded ports
  //
  // You can override these operations to provide more sophisticated
  // synchronization
  // ----------------------------------------------------------------------
 
  void PolyDbComponentBase ::
    lock()
  {
    this->m_guardedPortMutex.lock();
  }
 
  void PolyDbComponentBase ::
    unLock()
  {
    this->m_guardedPortMutex.unLock();
  }
 
  // ----------------------------------------------------------------------
  // Calls for messages received on typed input ports
  // ----------------------------------------------------------------------
 
  void PolyDbComponentBase ::
    m_p_getValue_in(
        Fw::PassiveComponentBase* callComp,
        NATIVE_INT_TYPE portNum,
        U32 entry,
        Svc::MeasurementStatus& status,
        Fw::Time& time,
        Fw::PolyType& val
    )
  {
    FW_ASSERT(callComp);
    PolyDbComponentBase* compPtr = static_cast<PolyDbComponentBase*>(callComp);
    compPtr->getValue_handlerBase(
      portNum,
      entry,
      status,
      time,
      val
    );
  }
 
  void PolyDbComponentBase ::
    m_p_setValue_in(
        Fw::PassiveComponentBase* callComp,
        NATIVE_INT_TYPE portNum,
        U32 entry,
        Svc::MeasurementStatus& status,
        Fw::Time& time,
        Fw::PolyType& val
    )
  {
    FW_ASSERT(callComp);
    PolyDbComponentBase* compPtr = static_cast<PolyDbComponentBase*>(callComp);
    compPtr->setValue_handlerBase(
      portNum,
      entry,
      status,
      time,
      val
    );
  }
 
}