inet::visualizer::TransportConnectionVisualizerBase Class Reference

#include <TransportConnectionVisualizerBase.h>

Inheritance diagram for inet::visualizer::TransportConnectionVisualizerBase:

Classes
class	TransportConnectionVisualization

Public Member Functions
virtual	~TransportConnectionVisualizerBase ()
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *object, cObject *details) override

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	handleParameterChange (const char *name) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual const TransportConnectionVisualization *	createConnectionVisualization (cModule *source, cModule *destination, tcp::TCPConnection *tcpConnection) const =0
virtual void	addConnectionVisualization (const TransportConnectionVisualization *connectionVisualization)
virtual void	removeConnectionVisualization (const TransportConnectionVisualization *connectionVisualization)
virtual void	removeAllConnectionVisualizations ()
Protected Member Functions inherited from inet::visualizer::VisualizerBase
virtual int	numInitStages () const override
virtual Coord	getPosition (const cModule *networkNode) const
virtual Coord	getContactPosition (const cModule *networkNode, const Coord &fromPosition, const char *contactMode, double contactSpacing) const
virtual InterfaceEntry *	getInterfaceEntry (cModule *networkNode, cModule *module) const

Protected Attributes
std::vector< const TransportConnectionVisualization * >	connectionVisualizations
Parameters
bool	displayTransportConnections = false
NetworkNodeFilter	sourceNodeFilter
PortFilter	sourcePortFilter
NetworkNodeFilter	destinationNodeFilter
PortFilter	destinationPortFilter
const char *	icon = nullptr
ColorSet	iconColorSet
cFigure::Font	labelFont
cFigure::Color	labelColor
Displacement	displacementHint
double	displacementPriority
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizerTargetModule = nullptr
const char *	tags = nullptr

Constructor & Destructor Documentation

inet::visualizer::TransportConnectionVisualizerBase::~TransportConnectionVisualizerBase ( )

virtual

{
    if (displayTransportConnections)
        unsubscribe();
}

Member Function Documentation

void inet::visualizer::TransportConnectionVisualizerBase::addConnectionVisualization ( const TransportConnectionVisualization *  connectionVisualization )

protectedvirtual

Reimplemented in inet::visualizer::TransportConnectionCanvasVisualizer.

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::addConnectionVisualization(), and receiveSignal().

{
    connectionVisualizations.push_back(connection);
}

virtual const TransportConnectionVisualization* inet::visualizer::TransportConnectionVisualizerBase::createConnectionVisualization ( cModule *  source, cModule *  destination, tcp::TCPConnection *  tcpConnection  ) const

protectedpure virtual

Implemented in inet::visualizer::TransportConnectionOsgVisualizer, and inet::visualizer::TransportConnectionCanvasVisualizer.

Referenced by receiveSignal().

void inet::visualizer::TransportConnectionVisualizerBase::handleParameterChange ( const char *  name )

overrideprotectedvirtual

{
    if (name != nullptr) {
        if (!strcmp(name, "sourceNodeFilter"))
            sourceNodeFilter.setPattern(par("sourceNodeFilter"));
        else if (!strcmp(name, "sourcePortFilter"))
            sourcePortFilter.setPattern(par("sourcePortFilter"));
        else if (!strcmp(name, "destinationNodeFilter"))
            sourceNodeFilter.setPattern(par("destinationNodeFilter"));
        else if (!strcmp(name, "destinationPortFilter"))
            sourcePortFilter.setPattern(par("destinationPortFilter"));
        removeAllConnectionVisualizations();
    }
}

void inet::visualizer::TransportConnectionVisualizerBase::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::TransportConnectionOsgVisualizer, and inet::visualizer::TransportConnectionCanvasVisualizer.

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::initialize().

{
    VisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        displayTransportConnections = par("displayTransportConnections");
        sourceNodeFilter.setPattern(par("sourceNodeFilter"));
        sourcePortFilter.setPattern(par("sourcePortFilter"));
        destinationNodeFilter.setPattern(par("destinationNodeFilter"));
        destinationPortFilter.setPattern(par("destinationPortFilter"));
        icon = par("icon");
        iconColorSet.parseColors(par("iconColor"));
        labelFont = cFigure::parseFont(par("labelFont"));
        labelColor = cFigure::Color(par("labelColor"));
        displacementHint = parseDisplacement(par("displacementHint"));
        displacementPriority = par("displacementPriority");
        if (displayTransportConnections)
            subscribe();
    }
}

void inet::visualizer::TransportConnectionVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, cObject *  object, cObject *  details  )

overridevirtual

{
#ifdef WITH_TCP_INET
    Enter_Method_Silent();
    if (signal == inet::tcp::TCP::tcpConnectionAddedSignal) {
        auto tcpConnection = check_and_cast<inet::tcp::TCPConnection *>(object);
        L3AddressResolver resolver;
        auto source = resolver.findHostWithAddress(tcpConnection->localAddr);
        auto destination = resolver.findHostWithAddress(tcpConnection->remoteAddr);
        if (source != nullptr && sourceNodeFilter.matches(source) &&
            destination != nullptr && destinationNodeFilter.matches(destination) &&
            sourcePortFilter.matches(tcpConnection->localPort) &&
            destinationPortFilter.matches(tcpConnection->remotePort))
        {
            addConnectionVisualization(createConnectionVisualization(source, destination, tcpConnection));
        }
    }
    else
        throw cRuntimeError("Unknown signal");
#endif // WITH_TCP_INET
}

void inet::visualizer::TransportConnectionVisualizerBase::removeAllConnectionVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

{
    std::vector<const TransportConnectionVisualization *> removedConnectionVisualizations;
    for (auto it : connectionVisualizations)
        removedConnectionVisualizations.push_back(it);
    for (auto it : removedConnectionVisualizations) {
        removeConnectionVisualization(it);
        delete it;
    }
}

void inet::visualizer::TransportConnectionVisualizerBase::removeConnectionVisualization ( const TransportConnectionVisualization *  connectionVisualization )

protectedvirtual

Reimplemented in inet::visualizer::TransportConnectionCanvasVisualizer.

Referenced by removeAllConnectionVisualizations(), and inet::visualizer::TransportConnectionCanvasVisualizer::removeConnectionVisualization().

{
    connectionVisualizations.erase(std::remove(connectionVisualizations.begin(), connectionVisualizations.end(), connection), connectionVisualizations.end());
}

void inet::visualizer::TransportConnectionVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

{
#ifdef WITH_TCP_INET
    auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
    subscriptionModule->subscribe(inet::tcp::TCP::tcpConnectionAddedSignal, this);
#endif // WITH_TCP_INET
}

void inet::visualizer::TransportConnectionVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~TransportConnectionVisualizerBase().

{
#ifdef WITH_TCP_INET
    // NOTE: lookup the module again because it may have been deleted first
    auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this, false);
    if (subscriptionModule != nullptr)
        subscriptionModule->unsubscribe(inet::tcp::TCP::tcpConnectionAddedSignal, this);
#endif // WITH_TCP_INET
}

Member Data Documentation

std::vector<const TransportConnectionVisualization *> inet::visualizer::TransportConnectionVisualizerBase::connectionVisualizations

protected

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::addConnectionVisualization(), addConnectionVisualization(), inet::visualizer::TransportConnectionCanvasVisualizer::createConnectionEndFigure(), removeAllConnectionVisualizations(), inet::visualizer::TransportConnectionCanvasVisualizer::removeConnectionVisualization(), removeConnectionVisualization(), and inet::visualizer::TransportConnectionCanvasVisualizer::setConnectionLabelsVisible().

NetworkNodeFilter inet::visualizer::TransportConnectionVisualizerBase::destinationNodeFilter

protected

Referenced by initialize(), and receiveSignal().

PortFilter inet::visualizer::TransportConnectionVisualizerBase::destinationPortFilter

protected

Referenced by initialize(), and receiveSignal().

Displacement inet::visualizer::TransportConnectionVisualizerBase::displacementHint

protected

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::addConnectionVisualization(), and initialize().

double inet::visualizer::TransportConnectionVisualizerBase::displacementPriority

protected

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::addConnectionVisualization(), and initialize().

bool inet::visualizer::TransportConnectionVisualizerBase::displayTransportConnections = false

protected

Referenced by initialize(), and ~TransportConnectionVisualizerBase().

const char* inet::visualizer::TransportConnectionVisualizerBase::icon = nullptr

protected

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::createConnectionEndFigure(), and initialize().

ColorSet inet::visualizer::TransportConnectionVisualizerBase::iconColorSet

protected

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::addConnectionVisualization(), inet::visualizer::TransportConnectionCanvasVisualizer::createConnectionEndFigure(), initialize(), and inet::visualizer::TransportConnectionCanvasVisualizer::removeConnectionVisualization().

cFigure::Color inet::visualizer::TransportConnectionVisualizerBase::labelColor

protected

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::createConnectionEndFigure(), and initialize().

cFigure::Font inet::visualizer::TransportConnectionVisualizerBase::labelFont

protected

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::createConnectionEndFigure(), and initialize().

NetworkNodeFilter inet::visualizer::TransportConnectionVisualizerBase::sourceNodeFilter

protected

Referenced by handleParameterChange(), initialize(), and receiveSignal().

PortFilter inet::visualizer::TransportConnectionVisualizerBase::sourcePortFilter

protected

Referenced by handleParameterChange(), initialize(), and receiveSignal().

---

The documentation for this class was generated from the following files:

• TransportConnectionVisualizerBase.h
• TransportConnectionVisualizerBase.cc