#include <TransportConnectionVisualizerBase.h>

Inheritance diagram for inet::visualizer::TransportConnectionVisualizerBase:

Classes
class	TransportConnectionVisualization

Parameters
bool	displayTransportConnections = false

NetworkNodeFilter	sourceNodeFilter

PortFilter	sourcePortFilter

NetworkNodeFilter	destinationNodeFilter

PortFilter	destinationPortFilter

const char *	icon = nullptr

ColorSet	iconColorSet

cFigure::Font	labelFont

cFigure::Color	labelColor

Placement	placementHint

double	placementPriority

std::vector< const TransportConnectionVisualization * >	connectionVisualizations

virtual void	initialize (int stage) override

virtual void	handleParameterChange (const char *name) override

virtual void	preDelete (cComponent *root) 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 ()

virtual void	receiveSignal (cComponent source, simsignal_t signal, cObject object, cObject *details) override

Additional Inherited Members
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 Quaternion	getOrientation (const cModule *networkNode) const

virtual void	mapChunks (const Ptr< const Chunk > &chunk, const std::function< void(const Ptr< const Chunk > &, int)> &thunk) const

Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizationTargetModule = nullptr

cModule *	visualizationSubjectModule = nullptr

const char *	tags = nullptr

Member Function Documentation

◆ addConnectionVisualization()

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

protectedvirtual

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

 {
     connectionVisualizations.push_back(connection);
 }

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

◆ createConnectionVisualization()

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

protectedpure virtual

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

Referenced by receiveSignal().

◆ handleParameterChange()

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

overrideprotectedvirtual

 {
     if (!hasGUI()) return;
     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();
     }
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

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

 {
     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"));
         placementHint = parsePlacement(par("placementHint"));
         placementPriority = par("placementPriority");
         if (displayTransportConnections)
             subscribe();
     }
 }

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

◆ preDelete()

void inet::visualizer::TransportConnectionVisualizerBase::preDelete ( cComponent * root )

overrideprotectedvirtual

 {
     if (displayTransportConnections) {
         unsubscribe();
         removeAllConnectionVisualizations();
     }
 }

◆ receiveSignal()

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

overridevirtual

 {
 #ifdef INET_WITH_TCP_INET
     Enter_Method("%s", cComponent::getSignalName(signal));
  
     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 // INET_WITH_TCP_INET
 }

◆ removeAllConnectionVisualizations()

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

protectedvirtual

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

Referenced by handleParameterChange(), and preDelete().

◆ removeConnectionVisualization()

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

protectedvirtual

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

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

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

◆ subscribe()

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

protectedvirtual

 {
 #ifdef INET_WITH_TCP_INET
     visualizationSubjectModule->subscribe(inet::tcp::Tcp::tcpConnectionAddedSignal, this);
 #endif // INET_WITH_TCP_INET
 }

Referenced by initialize().

◆ unsubscribe()

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

protectedvirtual

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