#include <PathVisualizerBase.h>

Inheritance diagram for inet::visualizer::PathVisualizerBase:

Classes
class	DirectiveResolver

class	PathVisualization

Public Member Functions
virtual	~PathVisualizerBase ()

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	refreshDisplay () const override

virtual void	subscribe ()

virtual void	unsubscribe ()

virtual bool	isPathStart (cModule *module) const =0

virtual bool	isPathEnd (cModule *module) const =0

virtual bool	isPathElement (cModule *module) const =0

virtual const PathVisualization *	createPathVisualization (const std::vector< int > &path, cPacket *packet) const =0

virtual const PathVisualization *	getPathVisualization (const std::vector< int > &path)

virtual void	addPathVisualization (const PathVisualization *pathVisualization)

virtual void	removePathVisualization (const PathVisualization *pathVisualization)

virtual void	removeAllPathVisualizations ()

virtual void	setAlpha (const PathVisualization *pathVisualization, double alpha) const =0

virtual const std::vector< int > *	getIncompletePath (int treeId)

virtual void	addToIncompletePath (int treeId, cModule *module)

virtual void	removeIncompletePath (int treeId)

virtual std::string	getPathVisualizationText (cPacket *packet) const

virtual void	refreshPathVisualization (const PathVisualization pathVisualization, cPacket packet)

virtual void	updatePathVisualization (const std::vector< int > &path, cPacket *packet)

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
LineManager *	lineManager = nullptr

std::map< int, std::vector< int > >	incompletePaths
	Maps packet to module vector. More...

std::map< int, int >	numPaths
	Maps nodes to the number of paths that go through it. More...

std::multimap< std::pair< int, int >, const PathVisualization * >	pathVisualizations
	Maps source/destination modules to multiple paths between them. More...

Parameters
bool	displayRoutes = false

NetworkNodeFilter	nodeFilter

PacketFilter	packetFilter

ColorSet	lineColorSet

cFigure::LineStyle	lineStyle

double	lineWidth = NaN

bool	lineSmooth = false

double	lineShift = NaN

const char *	lineShiftMode = nullptr

double	lineContactSpacing = NaN

const char *	lineContactMode = nullptr

StringFormat	labelFormat

cFigure::Font	labelFont

const char *	labelColorAsString = nullptr

cFigure::Color	labelColor

const char *	fadeOutMode = nullptr

double	fadeOutTime = NaN

double	fadeOutAnimationSpeed = NaN

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

const char *	tags = nullptr

Constructor & Destructor Documentation

inet::visualizer::PathVisualizerBase::~PathVisualizerBase ( )

virtual

 {
     if (displayRoutes)
         unsubscribe();
 }

Member Function Documentation

void inet::visualizer::PathVisualizerBase::addPathVisualization ( const PathVisualization * pathVisualization )

protectedvirtual

Reimplemented in inet::visualizer::PathCanvasVisualizerBase.

Referenced by inet::visualizer::PathCanvasVisualizerBase::addPathVisualization(), and updatePathVisualization().

 {
     auto sourceAndDestination = std::pair<int, int>(pathVisualization->moduleIds.front(), pathVisualization->moduleIds.back());
     pathVisualizations.insert(std::pair<std::pair<int, int>, const PathVisualization *>(sourceAndDestination, pathVisualization));
 }

void inet::visualizer::PathVisualizerBase::addToIncompletePath	(	int	treeId,
		cModule *	module
	)

protectedvirtual

Referenced by receiveSignal().

 {
     auto& moduleIds = incompletePaths[treeId];
     auto moduleId = module->getId();
     if (moduleIds.size() == 0 || moduleIds[moduleIds.size() - 1] != moduleId)
         moduleIds.push_back(moduleId);
 }

const PathVisualizerBase::PathVisualization * inet::visualizer::PathVisualizerBase::createPathVisualization	(	const std::vector< int > &	path,
		cPacket *	packet
	)		const

protectedpure virtual

Implemented in inet::visualizer::PathOsgVisualizerBase, inet::visualizer::PathCanvasVisualizerBase, inet::visualizer::NetworkRouteCanvasVisualizer, and inet::visualizer::TransportRouteCanvasVisualizer.

Referenced by inet::visualizer::PathOsgVisualizerBase::createPathVisualization(), and updatePathVisualization().

 {
     return new PathVisualization(path);
 }

const std::vector< int > * inet::visualizer::PathVisualizerBase::getIncompletePath ( int treeId )

protectedvirtual

Referenced by receiveSignal().

 {
     auto it = incompletePaths.find(treeId);
     if (it == incompletePaths.end())
         return nullptr;
     else
         return &it->second;
 }

const PathVisualizerBase::PathVisualization * inet::visualizer::PathVisualizerBase::getPathVisualization ( const std::vector< int > & path )

protectedvirtual

Referenced by updatePathVisualization().

 {
     auto key = std::pair<int, int>(path.front(), path.back());
     auto range = pathVisualizations.equal_range(key);
     for (auto it = range.first; it != range.second; it++)
         if (it->second->moduleIds == path)
             return it->second;
     return nullptr;
 }

std::string inet::visualizer::PathVisualizerBase::getPathVisualizationText ( cPacket * packet ) const

protectedvirtual

Referenced by inet::visualizer::PathCanvasVisualizerBase::createPathVisualization(), and inet::visualizer::PathCanvasVisualizerBase::refreshPathVisualization().

 {
     DirectiveResolver directiveResolver(packet);
     return labelFormat.formatString(&directiveResolver);
 }

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

overrideprotectedvirtual

 {
     if (name != nullptr) {
         if (!strcmp(name, "nodeFilter"))
             nodeFilter.setPattern(par("nodeFilter"));
         else if (!strcmp(name, "packetFilter"))
             packetFilter.setPattern(par("packetFilter"));
         removeAllPathVisualizations();
     }
 }

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::PathOsgVisualizerBase, and inet::visualizer::PathCanvasVisualizerBase.

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

 {
     VisualizerBase::initialize(stage);
     if (!hasGUI()) return;
     if (stage == INITSTAGE_LOCAL) {
         displayRoutes = par("displayRoutes");
         nodeFilter.setPattern(par("nodeFilter"));
         packetFilter.setPattern(par("packetFilter"));
         lineColorSet.parseColors(par("lineColor"));
         lineStyle = cFigure::parseLineStyle(par("lineStyle"));
         lineWidth = par("lineWidth");
         lineSmooth = par("lineSmooth");
         lineShift = par("lineShift");
         lineShiftMode = par("lineShiftMode");
         lineContactSpacing = par("lineContactSpacing");
         lineContactMode = par("lineContactMode");
         labelFormat.parseFormat(par("labelFormat"));
         labelFont = cFigure::parseFont(par("labelFont"));
         labelColorAsString = par("labelColor");
         if (!isEmpty(labelColorAsString))
             labelColor = cFigure::Color(labelColorAsString);
         fadeOutMode = par("fadeOutMode");
         fadeOutTime = par("fadeOutTime");
         fadeOutAnimationSpeed = par("fadeOutAnimationSpeed");
         lineManager = LineManager::getLineManager(visualizerTargetModule->getCanvas());
         if (displayRoutes)
             subscribe();
     }
 }

virtual bool inet::visualizer::PathVisualizerBase::isPathElement ( cModule * module ) const

protectedpure virtual

Implemented in inet::visualizer::NetworkRouteCanvasVisualizer, inet::visualizer::NetworkRouteOsgVisualizer, inet::visualizer::TransportRouteCanvasVisualizer, and inet::visualizer::TransportRouteOsgVisualizer.

Referenced by receiveSignal().

virtual bool inet::visualizer::PathVisualizerBase::isPathEnd ( cModule * module ) const

protectedpure virtual

Implemented in inet::visualizer::NetworkRouteCanvasVisualizer, inet::visualizer::NetworkRouteOsgVisualizer, inet::visualizer::TransportRouteCanvasVisualizer, and inet::visualizer::TransportRouteOsgVisualizer.

Referenced by receiveSignal().

virtual bool inet::visualizer::PathVisualizerBase::isPathStart ( cModule * module ) const

protectedpure virtual

Implemented in inet::visualizer::NetworkRouteCanvasVisualizer, inet::visualizer::NetworkRouteOsgVisualizer, inet::visualizer::TransportRouteCanvasVisualizer, and inet::visualizer::TransportRouteOsgVisualizer.

Referenced by receiveSignal().

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

overridevirtual

 {
     Enter_Method_Silent();
     if (signal == LayeredProtocolBase::packetReceivedFromUpperSignal) {
         if (isPathStart(static_cast<cModule *>(source))) {
             auto module = check_and_cast<cModule *>(source);
             auto packet = check_and_cast<cPacket *>(object);
             auto treeId = packet->getEncapsulationTreeId();
             auto path = getIncompletePath(treeId);
             if (path != nullptr)
                 removeIncompletePath(treeId);
             auto networkNode = getContainingNode(module);
             if (nodeFilter.matches(networkNode) && packetFilter.matches(packet))
                 addToIncompletePath(treeId, networkNode);
         }
     }
     else if (signal == LayeredProtocolBase::packetReceivedFromLowerSignal) {
         if (isPathElement(static_cast<cModule *>(source))) {
             auto module = check_and_cast<cModule *>(source);
             auto packet = check_and_cast<cPacket *>(object);
             auto treeId = packet->getEncapsulationTreeId();
             auto path = getIncompletePath(treeId);
             if (path != nullptr)
                 addToIncompletePath(treeId, getContainingNode(module));
         }
     }
     else if (signal == LayeredProtocolBase::packetSentToUpperSignal) {
         if (isPathEnd(static_cast<cModule *>(source))) {
             auto module = check_and_cast<cModule *>(source);
             auto packet = check_and_cast<cPacket *>(object);
             auto treeId = packet->getEncapsulationTreeId();
             auto path = getIncompletePath(treeId);
             if (path != nullptr) {
                 auto networkNode = getContainingNode(module);
                 if (nodeFilter.matches(networkNode) && packetFilter.matches(packet))
                     updatePathVisualization(*path, packet);
                 removeIncompletePath(treeId);
             }
         }
     }
     else
         throw cRuntimeError("Unknown signal");
 }

void inet::visualizer::PathVisualizerBase::refreshDisplay ( ) const

overrideprotectedvirtual

Reimplemented in inet::visualizer::PathCanvasVisualizerBase.

Referenced by inet::visualizer::PathCanvasVisualizerBase::refreshDisplay().

 {
     AnimationPosition currentAnimationPosition;
     std::vector<const PathVisualization *> removedPathVisualizations;
     for (auto it : pathVisualizations) {
         auto pathVisualization = it.second;
         double delta;
         if (!strcmp(fadeOutMode, "simulationTime"))
             delta = (currentAnimationPosition.getSimulationTime() - pathVisualization->lastUsageAnimationPosition.getSimulationTime()).dbl();
         else if (!strcmp(fadeOutMode, "animationTime"))
             delta = currentAnimationPosition.getAnimationTime() - pathVisualization->lastUsageAnimationPosition.getAnimationTime();
         else if (!strcmp(fadeOutMode, "realTime"))
             delta = currentAnimationPosition.getRealTime() - pathVisualization->lastUsageAnimationPosition.getRealTime();
         else
             throw cRuntimeError("Unknown fadeOutMode: %s", fadeOutMode);
         if (delta > fadeOutTime)
             removedPathVisualizations.push_back(pathVisualization);
         else
             setAlpha(pathVisualization, 1 - delta / fadeOutTime);
     }
     for (auto path : removedPathVisualizations) {
         const_cast<PathVisualizerBase *>(this)->removePathVisualization(path);
         delete path;
     }
 }

void inet::visualizer::PathVisualizerBase::refreshPathVisualization	(	const PathVisualization *	pathVisualization,
		cPacket *	packet
	)

protectedvirtual

Reimplemented in inet::visualizer::PathCanvasVisualizerBase.

Referenced by inet::visualizer::PathCanvasVisualizerBase::refreshPathVisualization(), and updatePathVisualization().

 {
     pathVisualization->lastUsageAnimationPosition = AnimationPosition();
 }

void inet::visualizer::PathVisualizerBase::removeAllPathVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

 {
     incompletePaths.clear();
     numPaths.clear();
     std::vector<const PathVisualization *> removedPathVisualizations;
     for (auto it : pathVisualizations)
         removedPathVisualizations.push_back(it.second);
     for (auto it : removedPathVisualizations) {
         removePathVisualization(it);
         delete it;
     }
 }

void inet::visualizer::PathVisualizerBase::removeIncompletePath ( int treeId )

protectedvirtual

Referenced by receiveSignal().

 {
     incompletePaths.erase(incompletePaths.find(treeId));
 }

void inet::visualizer::PathVisualizerBase::removePathVisualization ( const PathVisualization * pathVisualization )

protectedvirtual

Reimplemented in inet::visualizer::PathCanvasVisualizerBase.

Referenced by refreshDisplay(), removeAllPathVisualizations(), and inet::visualizer::PathCanvasVisualizerBase::removePathVisualization().

 {
     auto sourceAndDestination = std::pair<int, int>(pathVisualization->moduleIds.front(), pathVisualization->moduleIds.back());
     auto range = pathVisualizations.equal_range(sourceAndDestination);
     for (auto it = range.first; it != range.second; it++) {
         if (it->second == pathVisualization) {
             pathVisualizations.erase(it);
             break;
         }
     }
 }

virtual void inet::visualizer::PathVisualizerBase::setAlpha	(	const PathVisualization *	pathVisualization,
		double	alpha
	)		const

protectedpure virtual

Implemented in inet::visualizer::PathOsgVisualizerBase, and inet::visualizer::PathCanvasVisualizerBase.

Referenced by refreshDisplay().

void inet::visualizer::PathVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

 {
     auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
     subscriptionModule->subscribe(LayeredProtocolBase::packetSentToUpperSignal, this);
     subscriptionModule->subscribe(LayeredProtocolBase::packetReceivedFromUpperSignal, this);
     subscriptionModule->subscribe(LayeredProtocolBase::packetReceivedFromLowerSignal, this);
 }

void inet::visualizer::PathVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~PathVisualizerBase().

 {
     // 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(LayeredProtocolBase::packetSentToUpperSignal, this);
         subscriptionModule->unsubscribe(LayeredProtocolBase::packetReceivedFromUpperSignal, this);
         subscriptionModule->unsubscribe(LayeredProtocolBase::packetReceivedFromLowerSignal, this);
     }
 }

void inet::visualizer::PathVisualizerBase::updatePathVisualization	(	const std::vector< int > &	path,
		cPacket *	packet
	)

protectedvirtual

Referenced by receiveSignal().

 {
     const PathVisualization *pathVisualization = getPathVisualization(moduleIds);
     if (pathVisualization == nullptr) {
         pathVisualization = createPathVisualization(moduleIds, packet);
         addPathVisualization(pathVisualization);
     }
     else
         refreshPathVisualization(pathVisualization, packet);
 }