PortBase.cpp

Go to the documentation of this file.

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Logger/Logger.hpp>
#include <Fw/Port/PortBase.hpp>
#include <cstdio>
#include "Fw/Types/Assert.hpp"
#include "Fw/Types/ExternalString.hpp"

#if FW_PORT_TRACING
void setConnTrace(bool trace) {
    Fw::PortBase::setTrace(trace);
}

namespace Fw {
bool PortBase::s_trace = false;
}

#endif  // FW_PORT_TRACING

namespace Fw {

PortBase::PortBase()
    : Fw::ObjBase(nullptr),
      m_connObj(nullptr)
#if FW_PORT_TRACING == 1
      ,
      m_trace(false),
      m_ovr_trace(false)
#endif
{
}

PortBase::~PortBase() {}

void PortBase::init() {
    ObjBase::init();
}

bool PortBase::isConnected() const {
    return m_connObj == nullptr ? false : true;
}

#if FW_PORT_TRACING == 1

void PortBase::trace() const {
    // Ports are only traced as part of invocation, which requires a connection
    FW_ASSERT(this->isConnected());
    bool do_trace = false;

    if (this->m_ovr_trace) {
        if (this->m_trace) {
            do_trace = true;
        }
    } else if (PortBase::s_trace) {
        do_trace = true;
    }

    if (do_trace) {
#if FW_OBJECT_NAMES == 1
        Fw::Logger::log("Trace: %s\n", this->m_objName.toChar());
#else
        Fw::Logger::log("Trace: %p\n", this);
#endif
    }
}

void PortBase::setTrace(bool trace) {
    PortBase::s_trace = trace;
}

void PortBase::ovrTrace(bool ovr, bool trace) {
    this->m_ovr_trace = ovr;
    this->m_trace = trace;
}

#endif  // FW_PORT_TRACING

#if FW_OBJECT_TO_STRING == 1
const char* PortBase::getToStringFormatString() {
    return "Port: %s %s->(%s)";
}

void PortBase::toString(char* buffer, FwSizeType size) {
    FW_ASSERT(size > 0);
    FW_ASSERT(buffer != nullptr);
    // Get the port-custom format string
    const char* formatString = this->getToStringFormatString();
    // Determine this port object name (or use "UNKNOWN")
    const char* object_name =
#if FW_OBJECT_NAMES == 1
        this->m_objName.toChar();
#else
        "UNKNOWN";
#endif
    // Get the C/NC for connected or not
    const char* this_is_connected = this->isConnected() ? "C" : "NC";

    // Get the name of the connection object, "UNKNOWN" or "NONE"
    const char* connected_to = this->isConnected() ?
#if FW_OBJECT_NAMES == 1
                                                   this->m_connObj->getObjName()
#else
                                                   "UNKNOWN"
#endif
                                                   : "None";
    // Format the external string or use "" on error
    const Fw::FormatStatus formatStatus = Fw::ExternalString(buffer, static_cast<Fw::ExternalString::SizeType>(size))
                                              .format(formatString, object_name, this_is_connected, connected_to);
    if (formatStatus != Fw::FormatStatus::SUCCESS) {
        buffer[0] = 0;
    }
}
#endif  // FW_OBJECT_TO_STRING

}  // namespace Fw