StreamCrossoverComponentAc.cpp

Go to the documentation of this file.

// ======================================================================
// \title  StreamCrossoverComponentAc.cpp
// \author Generated by fpp-to-cpp
// \brief  cpp file for StreamCrossover component base class
// ======================================================================
 
#include <cstdio>
 
#include "F-Prime/Drv/StreamCrossover/StreamCrossoverComponentAc.hpp"
#include "Fw/Types/Assert.hpp"
#if FW_ENABLE_TEXT_LOGGING
#include "Fw/Types/String.hpp"
#endif
 
namespace Drv {
 
  namespace {
    // Get the max size by doing a union of the input and internal port serialization sizes
    union BuffUnion {
      BYTE streamInPortSize[Drv::InputByteStreamRecvPort::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 StreamCrossoverComponentBase ::
    init(NATIVE_INT_TYPE instance)
  {
    // Initialize base class
    Fw::PassiveComponentBase::init(instance);
 
    // Connect input port streamIn
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_streamIn_InputPorts());
      port++
    ) {
      this->m_streamIn_InputPort[port].init();
      this->m_streamIn_InputPort[port].addCallComp(
        this,
        m_p_streamIn_in
      );
      this->m_streamIn_InputPort[port].setPortNum(port);
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_streamIn_InputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_streamIn_InputPort[port].setObjName(portName);
#endif
    }
 
    // Connect output port logOut
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_logOut_OutputPorts());
      port++
    ) {
      this->m_logOut_OutputPort[port].init();
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_logOut_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_logOut_OutputPort[port].setObjName(portName);
#endif
    }
 
#if FW_ENABLE_TEXT_LOGGING == 1
    // Connect output port logTextOut
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_logTextOut_OutputPorts());
      port++
    ) {
      this->m_logTextOut_OutputPort[port].init();
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_logTextOut_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_logTextOut_OutputPort[port].setObjName(portName);
#endif
    }
#endif
 
    // Connect output port timeCaller
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_timeCaller_OutputPorts());
      port++
    ) {
      this->m_timeCaller_OutputPort[port].init();
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_timeCaller_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_timeCaller_OutputPort[port].setObjName(portName);
#endif
    }
 
    // Connect output port errorDeallocate
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_errorDeallocate_OutputPorts());
      port++
    ) {
      this->m_errorDeallocate_OutputPort[port].init();
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_errorDeallocate_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_errorDeallocate_OutputPort[port].setObjName(portName);
#endif
    }
 
    // Connect output port streamOut
    for (
      PlatformIntType port = 0;
      port < static_cast<PlatformIntType>(this->getNum_streamOut_OutputPorts());
      port++
    ) {
      this->m_streamOut_OutputPort[port].init();
 
#if FW_OBJECT_NAMES == 1
      char portName[120];
      (void) snprintf(
        portName,
        sizeof(portName),
        "%s_streamOut_OutputPort[%" PRI_PlatformIntType "]",
        this->m_objName,
        port
      );
      this->m_streamOut_OutputPort[port].setObjName(portName);
#endif
    }
  }
 
  // ----------------------------------------------------------------------
  // Getters for typed input ports
  // ----------------------------------------------------------------------
 
  Drv::InputByteStreamRecvPort* StreamCrossoverComponentBase ::
    get_streamIn_InputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_streamIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return &this->m_streamIn_InputPort[portNum];
  }
 
  // ----------------------------------------------------------------------
  // Connect special input ports to special output ports
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    set_logOut_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputLogPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_logOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_logOut_OutputPort[portNum].addCallPort(port);
  }
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
  void StreamCrossoverComponentBase ::
    set_logTextOut_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputLogTextPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_logTextOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_logTextOut_OutputPort[portNum].addCallPort(port);
  }
 
#endif
 
  void StreamCrossoverComponentBase ::
    set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputTimePort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_timeCaller_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_timeCaller_OutputPort[portNum].addCallPort(port);
  }
 
  // ----------------------------------------------------------------------
  // Connect typed input ports to typed output ports
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    set_errorDeallocate_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputBufferSendPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_errorDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_errorDeallocate_OutputPort[portNum].addCallPort(port);
  }
 
  void StreamCrossoverComponentBase ::
    set_streamOut_OutputPort(
        NATIVE_INT_TYPE portNum,
        Drv::InputByteStreamSendPort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_streamOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_streamOut_OutputPort[portNum].addCallPort(port);
  }
 
#if FW_PORT_SERIALIZATION
 
  // ----------------------------------------------------------------------
  // Connect serial input ports to special output ports
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    set_logOut_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputSerializePort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_logOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_logOut_OutputPort[portNum].registerSerialPort(port);
  }
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
  void StreamCrossoverComponentBase ::
    set_logTextOut_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputSerializePort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_logTextOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_logTextOut_OutputPort[portNum].registerSerialPort(port);
  }
 
#endif
 
  void StreamCrossoverComponentBase ::
    set_timeCaller_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputSerializePort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_timeCaller_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_timeCaller_OutputPort[portNum].registerSerialPort(port);
  }
 
#endif
 
#if FW_PORT_SERIALIZATION
 
  // ----------------------------------------------------------------------
  // Connect serial input ports to typed output ports
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    set_errorDeallocate_OutputPort(
        NATIVE_INT_TYPE portNum,
        Fw::InputSerializePort* port
    )
  {
    FW_ASSERT(
      portNum < this->getNum_errorDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    this->m_errorDeallocate_OutputPort[portNum].registerSerialPort(port);
  }
 
#endif
 
  // ----------------------------------------------------------------------
  // Component construction and destruction
  // ----------------------------------------------------------------------
 
  StreamCrossoverComponentBase ::
    StreamCrossoverComponentBase(const char* compName) :
      Fw::PassiveComponentBase(compName)
  {
 
  }
 
  StreamCrossoverComponentBase ::
    ~StreamCrossoverComponentBase()
  {
 
  }
 
  // ----------------------------------------------------------------------
  // Getters for numbers of typed input ports
  // ----------------------------------------------------------------------
 
  NATIVE_INT_TYPE StreamCrossoverComponentBase ::
    getNum_streamIn_InputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_streamIn_InputPort));
  }
 
  // ----------------------------------------------------------------------
  // Getters for numbers of special output ports
  // ----------------------------------------------------------------------
 
  NATIVE_INT_TYPE StreamCrossoverComponentBase ::
    getNum_logOut_OutputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_logOut_OutputPort));
  }
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
  NATIVE_INT_TYPE StreamCrossoverComponentBase ::
    getNum_logTextOut_OutputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_logTextOut_OutputPort));
  }
 
#endif
 
  NATIVE_INT_TYPE StreamCrossoverComponentBase ::
    getNum_timeCaller_OutputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_timeCaller_OutputPort));
  }
 
  // ----------------------------------------------------------------------
  // Getters for numbers of typed output ports
  // ----------------------------------------------------------------------
 
  NATIVE_INT_TYPE StreamCrossoverComponentBase ::
    getNum_errorDeallocate_OutputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_errorDeallocate_OutputPort));
  }
 
  NATIVE_INT_TYPE StreamCrossoverComponentBase ::
    getNum_streamOut_OutputPorts()
  {
    return static_cast<NATIVE_INT_TYPE>(FW_NUM_ARRAY_ELEMENTS(this->m_streamOut_OutputPort));
  }
 
  // ----------------------------------------------------------------------
  // Connection status queries for special output ports
  // ----------------------------------------------------------------------
 
  bool StreamCrossoverComponentBase ::
    isConnected_logOut_OutputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_logOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return this->m_logOut_OutputPort[portNum].isConnected();
  }
 
#if FW_ENABLE_TEXT_LOGGING == 1
 
  bool StreamCrossoverComponentBase ::
    isConnected_logTextOut_OutputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_logTextOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return this->m_logTextOut_OutputPort[portNum].isConnected();
  }
 
#endif
 
  bool StreamCrossoverComponentBase ::
    isConnected_timeCaller_OutputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_timeCaller_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return this->m_timeCaller_OutputPort[portNum].isConnected();
  }
 
  // ----------------------------------------------------------------------
  // Connection status queries for typed output ports
  // ----------------------------------------------------------------------
 
  bool StreamCrossoverComponentBase ::
    isConnected_errorDeallocate_OutputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_errorDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return this->m_errorDeallocate_OutputPort[portNum].isConnected();
  }
 
  bool StreamCrossoverComponentBase ::
    isConnected_streamOut_OutputPort(NATIVE_INT_TYPE portNum)
  {
    FW_ASSERT(
      portNum < this->getNum_streamOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    return this->m_streamOut_OutputPort[portNum].isConnected();
  }
 
  // ----------------------------------------------------------------------
  // Port handler base-class functions for typed input ports
  //
  // Call these functions directly to bypass the corresponding ports
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    streamIn_handlerBase(
        NATIVE_INT_TYPE portNum,
        Fw::Buffer& recvBuffer,
        const Drv::RecvStatus& recvStatus
    )
  {
    // Make sure port number is valid
    FW_ASSERT(
      portNum < this->getNum_streamIn_InputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
 
    // Down call to pure virtual handler method implemented in Impl class
    this->streamIn_handler(
      portNum,
      recvBuffer,
      recvStatus
    );
  }
 
  // ----------------------------------------------------------------------
  // Invocation functions for typed output ports
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    errorDeallocate_out(
        NATIVE_INT_TYPE portNum,
        Fw::Buffer& fwBuffer
    )
  {
    FW_ASSERT(
      portNum < this->getNum_errorDeallocate_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
    this->m_errorDeallocate_OutputPort[portNum].invoke(
      fwBuffer
    );
  }
 
  Drv::SendStatus StreamCrossoverComponentBase ::
    streamOut_out(
        NATIVE_INT_TYPE portNum,
        Fw::Buffer& sendBuffer
    )
  {
    FW_ASSERT(
      portNum < this->getNum_streamOut_OutputPorts(),
      static_cast<FwAssertArgType>(portNum)
    );
    return this->m_streamOut_OutputPort[portNum].invoke(
      sendBuffer
    );
  }
 
  // ----------------------------------------------------------------------
  // Event logging functions
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    log_WARNING_HI_StreamOutError(Drv::SendStatus sendStatus)
  {
    // Get the time
    Fw::Time _logTime;
    if (this->m_timeCaller_OutputPort[0].isConnected()) {
      this->m_timeCaller_OutputPort[0].invoke(_logTime);
    }
 
    FwEventIdType _id = static_cast<FwEventIdType>(0);
 
    _id = this->getIdBase() + EVENTID_STREAMOUTERROR;
 
    // Emit the event on the log port
    if (this->m_logOut_OutputPort[0].isConnected()) {
      Fw::LogBuffer _logBuff;
      Fw::SerializeStatus _status = Fw::FW_SERIALIZE_OK;
 
#if FW_AMPCS_COMPATIBLE
      // Serialize the number of arguments
      _status = _logBuff.serialize(static_cast<U8>(1));
      FW_ASSERT(
        _status == Fw::FW_SERIALIZE_OK,
        static_cast<FwAssertArgType>(_status)
      );
#endif
 
#if FW_AMPCS_COMPATIBLE
      // Serialize the argument size
      _status = _logBuff.serialize(
        static_cast<U8>(Drv::SendStatus::SERIALIZED_SIZE)
      );
      FW_ASSERT(
        _status == Fw::FW_SERIALIZE_OK,
        static_cast<FwAssertArgType>(_status)
      );
#endif
      _status = _logBuff.serialize(sendStatus);
      FW_ASSERT(
        _status == Fw::FW_SERIALIZE_OK,
        static_cast<FwAssertArgType>(_status)
      );
 
      this->m_logOut_OutputPort[0].invoke(
        _id,
        _logTime,
        Fw::LogSeverity::WARNING_HI,
        _logBuff
      );
    }
 
    // Emit the event on the text log port
#if FW_ENABLE_TEXT_LOGGING
    if (this->m_logTextOut_OutputPort[0].isConnected()) {
#if FW_OBJECT_NAMES == 1
      const char* _formatString =
        "(%s) %s: StreamCrossover StreamOut Error: %s";
#else
      const char* _formatString =
        "%s: StreamCrossover StreamOut Error: %s";
#endif
 
      char _textBuffer[FW_LOG_TEXT_BUFFER_SIZE];
 
      Fw::String sendStatusStr;
      sendStatus.toString(sendStatusStr);
 
      (void) snprintf(
        _textBuffer,
        FW_LOG_TEXT_BUFFER_SIZE,
        _formatString,
#if FW_OBJECT_NAMES == 1
        this->m_objName,
#endif
        "StreamOutError ",
        sendStatusStr.toChar()
      );
 
      // Null terminate
      _textBuffer[FW_LOG_TEXT_BUFFER_SIZE-1] = 0;
      Fw::TextLogString _logString = _textBuffer;
      this->m_logTextOut_OutputPort[0].invoke(
        _id,
        _logTime,
        Fw::LogSeverity::WARNING_HI,
        _logString
      );
    }
#endif
  }
 
  // ----------------------------------------------------------------------
  // Time
  // ----------------------------------------------------------------------
 
  Fw::Time StreamCrossoverComponentBase ::
    getTime()
  {
    if (this->m_timeCaller_OutputPort[0].isConnected()) {
      Fw::Time _time;
      this->m_timeCaller_OutputPort[0].invoke(_time);
      return _time;
    }
    else {
      return Fw::Time(TB_NONE, 0, 0);
    }
  }
 
  // ----------------------------------------------------------------------
  // Calls for messages received on typed input ports
  // ----------------------------------------------------------------------
 
  void StreamCrossoverComponentBase ::
    m_p_streamIn_in(
        Fw::PassiveComponentBase* callComp,
        NATIVE_INT_TYPE portNum,
        Fw::Buffer& recvBuffer,
        const Drv::RecvStatus& recvStatus
    )
  {
    FW_ASSERT(callComp);
    StreamCrossoverComponentBase* compPtr = static_cast<StreamCrossoverComponentBase*>(callComp);
    compPtr->streamIn_handlerBase(
      portNum,
      recvBuffer,
      recvStatus
    );
  }
 
}