FramerComponentAc.cpp

Go to the documentation of this file.

// ======================================================================
// \title  FramerComponentAc.cpp
// \author Generated by fpp-to-cpp
// \brief  cpp file for Framer component base class
// ======================================================================

#include "F-Prime/Svc/Framer/FramerComponentAc.hpp"
#include "Fw/Types/Assert.hpp"
#include "Fw/Types/ExternalString.hpp"
#if FW_ENABLE_TEXT_LOGGING
#include "Fw/Types/String.hpp"
#endif

namespace Svc {

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

  void FramerComponentBase ::
    init(FwEnumStoreType instance)
  {
    // Initialize base class
    Fw::PassiveComponentBase::init(instance);

    // Connect input port bufferIn
    for (
      FwIndexType port = 0;
      port < static_cast<FwIndexType>(this->getNum_bufferIn_InputPorts());
      port++
    ) {
      this->m_bufferIn_InputPort[port].init();
      this->m_bufferIn_InputPort[port].addCallComp(
        this,
        m_p_bufferIn_in
      );
      this->m_bufferIn_InputPort[port].setPortNum(port);

#if FW_OBJECT_NAMES == 1
      Fw::ObjectName portName;
      portName.format(
        "%s_bufferIn_InputPort[%" PRI_PlatformIntType "]",
        this->m_objName.toChar(),
        port
      );
      this->m_bufferIn_InputPort[port].setObjName(portName.toChar());
#endif
    }

    // Connect input port comIn
    for (
      FwIndexType port = 0;
      port < static_cast<FwIndexType>(this->getNum_comIn_InputPorts());
      port++
    ) {
      this->m_comIn_InputPort[port].init();
      this->m_comIn_InputPort[port].addCallComp(
        this,
        m_p_comIn_in
      );
      this->m_comIn_InputPort[port].setPortNum(port);

#if FW_OBJECT_NAMES == 1
      Fw::ObjectName portName;
      portName.format(
        "%s_comIn_InputPort[%" PRI_PlatformIntType "]",
        this->m_objName.toChar(),
        port
      );
      this->m_comIn_InputPort[port].setObjName(portName.toChar());
#endif
    }

    // Connect input port comStatusIn
    for (
      FwIndexType port = 0;
      port < static_cast<FwIndexType>(this->getNum_comStatusIn_InputPorts());
      port++
    ) {
      this->m_comStatusIn_InputPort[port].init();
      this->m_comStatusIn_InputPort[port].addCallComp(
        this,
        m_p_comStatusIn_in
      );
      this->m_comStatusIn_InputPort[port].setPortNum(port);

#if FW_OBJECT_NAMES == 1
      Fw::ObjectName portName;
      portName.format(
        "%s_comStatusIn_InputPort[%" PRI_PlatformIntType "]",
        this->m_objName.toChar(),
        port
      );
      this->m_comStatusIn_InputPort[port].setObjName(portName.toChar());
#endif
    }

    // Connect output port bufferDeallocate
    for (
      FwIndexType port = 0;
      port < static_cast<FwIndexType>(this->getNum_bufferDeallocate_OutputPorts());
      port++
    ) {
      this->m_bufferDeallocate_OutputPort[port].init();

#if FW_OBJECT_NAMES == 1
      Fw::ObjectName portName;
      portName.format(
        "%s_bufferDeallocate_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName.toChar(),
        port
      );
      this->m_bufferDeallocate_OutputPort[port].setObjName(portName.toChar());
#endif
    }

    // Connect output port comStatusOut
    for (
      FwIndexType port = 0;
      port < static_cast<FwIndexType>(this->getNum_comStatusOut_OutputPorts());
      port++
    ) {
      this->m_comStatusOut_OutputPort[port].init();

#if FW_OBJECT_NAMES == 1
      Fw::ObjectName portName;
      portName.format(
        "%s_comStatusOut_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName.toChar(),
        port
      );
      this->m_comStatusOut_OutputPort[port].setObjName(portName.toChar());
#endif
    }

    // Connect output port framedAllocate
    for (
      FwIndexType port = 0;
      port < static_cast<FwIndexType>(this->getNum_framedAllocate_OutputPorts());
      port++
    ) {
      this->m_framedAllocate_OutputPort[port].init();

#if FW_OBJECT_NAMES == 1
      Fw::ObjectName portName;
      portName.format(
        "%s_framedAllocate_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName.toChar(),
        port
      );
      this->m_framedAllocate_OutputPort[port].setObjName(portName.toChar());
#endif
    }

    // Connect output port framedOut
    for (
      FwIndexType port = 0;
      port < static_cast<FwIndexType>(this->getNum_framedOut_OutputPorts());
      port++
    ) {
      this->m_framedOut_OutputPort[port].init();

#if FW_OBJECT_NAMES == 1
      Fw::ObjectName portName;
      portName.format(
        "%s_framedOut_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName.toChar(),
        port
      );
      this->m_framedOut_OutputPort[port].setObjName(portName.toChar());
#endif
    }
  }

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

  Fw::InputBufferSendPort* FramerComponentBase ::
    get_bufferIn_InputPort(FwIndexType portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_bufferIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    return &this->m_bufferIn_InputPort[portNum];
  }

  Fw::InputComPort* FramerComponentBase ::
    get_comIn_InputPort(FwIndexType portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_comIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    return &this->m_comIn_InputPort[portNum];
  }

  Fw::InputSuccessConditionPort* FramerComponentBase ::
    get_comStatusIn_InputPort(FwIndexType portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_comStatusIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    return &this->m_comStatusIn_InputPort[portNum];
  }

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

  void FramerComponentBase ::
    set_bufferDeallocate_OutputPort(
        FwIndexType portNum,
        Fw::InputBufferSendPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_bufferDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    this->m_bufferDeallocate_OutputPort[portNum].addCallPort(port);
  }

  void FramerComponentBase ::
    set_comStatusOut_OutputPort(
        FwIndexType portNum,
        Fw::InputSuccessConditionPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_comStatusOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    this->m_comStatusOut_OutputPort[portNum].addCallPort(port);
  }

  void FramerComponentBase ::
    set_framedAllocate_OutputPort(
        FwIndexType portNum,
        Fw::InputBufferGetPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_framedAllocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    this->m_framedAllocate_OutputPort[portNum].addCallPort(port);
  }

  void FramerComponentBase ::
    set_framedOut_OutputPort(
        FwIndexType portNum,
        Drv::InputByteStreamSendPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_framedOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    this->m_framedOut_OutputPort[portNum].addCallPort(port);
  }

#if FW_PORT_SERIALIZATION

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

  void FramerComponentBase ::
    set_bufferDeallocate_OutputPort(
        FwIndexType portNum,
        Fw::InputSerializePort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_bufferDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    this->m_bufferDeallocate_OutputPort[portNum].registerSerialPort(port);
  }

  void FramerComponentBase ::
    set_comStatusOut_OutputPort(
        FwIndexType portNum,
        Fw::InputSerializePort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_comStatusOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    this->m_comStatusOut_OutputPort[portNum].registerSerialPort(port);
  }

#endif

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

  FramerComponentBase ::
    FramerComponentBase(const char* compName) :
      Fw::PassiveComponentBase(compName)
  {

  }

  FramerComponentBase ::
    ~FramerComponentBase()
  {

  }

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

  FwIndexType FramerComponentBase ::
    getNum_bufferIn_InputPorts() const
  {
    return static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_bufferIn_InputPort));
  }

  FwIndexType FramerComponentBase ::
    getNum_comIn_InputPorts() const
  {
    return static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_comIn_InputPort));
  }

  FwIndexType FramerComponentBase ::
    getNum_comStatusIn_InputPorts() const
  {
    return static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_comStatusIn_InputPort));
  }

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

  FwIndexType FramerComponentBase ::
    getNum_bufferDeallocate_OutputPorts() const
  {
    return static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_bufferDeallocate_OutputPort));
  }

  FwIndexType FramerComponentBase ::
    getNum_comStatusOut_OutputPorts() const
  {
    return static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_comStatusOut_OutputPort));
  }

  FwIndexType FramerComponentBase ::
    getNum_framedAllocate_OutputPorts() const
  {
    return static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_framedAllocate_OutputPort));
  }

  FwIndexType FramerComponentBase ::
    getNum_framedOut_OutputPorts() const
  {
    return static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_framedOut_OutputPort));
  }

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

  bool FramerComponentBase ::
    isConnected_bufferDeallocate_OutputPort(FwIndexType portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_bufferDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    return this->m_bufferDeallocate_OutputPort[portNum].isConnected();
  }

  bool FramerComponentBase ::
    isConnected_comStatusOut_OutputPort(FwIndexType portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_comStatusOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    return this->m_comStatusOut_OutputPort[portNum].isConnected();
  }

  bool FramerComponentBase ::
    isConnected_framedAllocate_OutputPort(FwIndexType portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_framedAllocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    return this->m_framedAllocate_OutputPort[portNum].isConnected();
  }

  bool FramerComponentBase ::
    isConnected_framedOut_OutputPort(FwIndexType portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_framedOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    return this->m_framedOut_OutputPort[portNum].isConnected();
  }

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

  void FramerComponentBase ::
    bufferIn_handlerBase(
        FwIndexType portNum,
        Fw::Buffer& fwBuffer
    )
  {
    // Make sure port number is valid
    FW_ASSERT(
      portNum < this->getNum_bufferIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    // Lock guard mutex before calling
    this->lock();

    // Call handler function
    this->bufferIn_handler(
      portNum,
      fwBuffer
    );

    // Unlock guard mutex
    this->unLock();
  }

  void FramerComponentBase ::
    comIn_handlerBase(
        FwIndexType portNum,
        Fw::ComBuffer& data,
        U32 context
    )
  {
    // Make sure port number is valid
    FW_ASSERT(
      portNum < this->getNum_comIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    // Lock guard mutex before calling
    this->lock();

    // Call handler function
    this->comIn_handler(
      portNum,
      data,
      context
    );

    // Unlock guard mutex
    this->unLock();
  }

  void FramerComponentBase ::
    comStatusIn_handlerBase(
        FwIndexType portNum,
        Fw::Success& condition
    )
  {
    // Make sure port number is valid
    FW_ASSERT(
      portNum < this->getNum_comStatusIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );

    // Call handler function
    this->comStatusIn_handler(
      portNum,
      condition
    );
  }

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

  void FramerComponentBase ::
    bufferDeallocate_out(
        FwIndexType portNum,
        Fw::Buffer& fwBuffer
    )
  {
    FW_ASSERT(
      portNum < this->getNum_bufferDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
    this->m_bufferDeallocate_OutputPort[portNum].invoke(
      fwBuffer
    );
  }

  void FramerComponentBase ::
    comStatusOut_out(
        FwIndexType portNum,
        Fw::Success& condition
    )
  {
    FW_ASSERT(
      portNum < this->getNum_comStatusOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
    this->m_comStatusOut_OutputPort[portNum].invoke(
      condition
    );
  }

  Fw::Buffer FramerComponentBase ::
    framedAllocate_out(
        FwIndexType portNum,
        U32 size
    )
  {
    FW_ASSERT(
      portNum < this->getNum_framedAllocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
    return this->m_framedAllocate_OutputPort[portNum].invoke(
      size
    );
  }

  Drv::SendStatus FramerComponentBase ::
    framedOut_out(
        FwIndexType portNum,
        Fw::Buffer& sendBuffer
    )
  {
    FW_ASSERT(
      portNum < this->getNum_framedOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
    return this->m_framedOut_OutputPort[portNum].invoke(
      sendBuffer
    );
  }

  // ----------------------------------------------------------------------
  // Mutex operations for guarded ports
  //
  // You can override these operations to provide more sophisticated
  // synchronization
  // ----------------------------------------------------------------------

  void FramerComponentBase ::
    lock()
  {
    this->m_guardedPortMutex.lock();
  }

  void FramerComponentBase ::
    unLock()
  {
    this->m_guardedPortMutex.unLock();
  }

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

  void FramerComponentBase ::
    m_p_bufferIn_in(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        Fw::Buffer& fwBuffer
    )
  {
    FW_ASSERT(callComp);
    FramerComponentBase* compPtr = static_cast<FramerComponentBase*>(callComp);
    compPtr->bufferIn_handlerBase(
      portNum,
      fwBuffer
    );
  }

  void FramerComponentBase ::
    m_p_comIn_in(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        Fw::ComBuffer& data,
        U32 context
    )
  {
    FW_ASSERT(callComp);
    FramerComponentBase* compPtr = static_cast<FramerComponentBase*>(callComp);
    compPtr->comIn_handlerBase(
      portNum,
      data,
      context
    );
  }

  void FramerComponentBase ::
    m_p_comStatusIn_in(
        Fw::PassiveComponentBase* callComp,
        FwIndexType portNum,
        Fw::Success& condition
    )
  {
    FW_ASSERT(callComp);
    FramerComponentBase* compPtr = static_cast<FramerComponentBase*>(callComp);
    compPtr->comStatusIn_handlerBase(
      portNum,
      condition
    );
  }

}