#include <LinkVisualizerBase.h>

Inheritance diagram for inet::visualizer::LinkVisualizerBase:

Classes
class	DirectiveResolver

class	LinkVisualization

Public Member Functions
virtual	~LinkVisualizerBase ()

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	isLinkStart (cModule *module) const =0

virtual bool	isLinkEnd (cModule *module) const =0

virtual const LinkVisualization *	createLinkVisualization (cModule source, cModule destination, cPacket *packet) const =0

virtual const LinkVisualization *	getLinkVisualization (std::pair< int, int > linkVisualization)

virtual void	addLinkVisualization (std::pair< int, int > sourceAndDestination, const LinkVisualization *linkVisualization)

virtual void	removeLinkVisualization (const LinkVisualization *linkVisualization)

virtual void	removeAllLinkVisualizations ()

virtual void	setAlpha (const LinkVisualization *linkVisualization, double alpha) const =0

virtual cModule *	getLastModule (int treeId)

virtual void	setLastModule (int treeId, cModule *lastModule)

virtual void	removeLastModule (int treeId)

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

virtual void	refreshLinkVisualization (const LinkVisualization linkVisualization, cPacket packet)

virtual void	updateLinkVisualization (cModule source, cModule destination, 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, int >	lastModules
	Maps packet to last module. More...

std::map< std::pair< int, int >, const LinkVisualization * >	linkVisualizations
	Maps source/destination module ids to link visualizations. More...

Parameters
bool	displayLinks = false

NetworkNodeFilter	nodeFilter

InterfaceFilter	interfaceFilter

PacketFilter	packetFilter

cFigure::Color	lineColor

cFigure::LineStyle	lineStyle

double	lineWidth = NaN

double	lineShift = NaN

const char *	lineShiftMode = nullptr

double	lineContactSpacing = NaN

const char *	lineContactMode = nullptr

StringFormat	labelFormat

cFigure::Font	labelFont

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::LinkVisualizerBase::~LinkVisualizerBase ( )

virtual

 {
     if (displayLinks)
         unsubscribe();
 }

Member Function Documentation

void inet::visualizer::LinkVisualizerBase::addLinkVisualization	(	std::pair< int, int >	sourceAndDestination,
		const LinkVisualization *	linkVisualization
	)

protectedvirtual

Reimplemented in inet::visualizer::LinkCanvasVisualizerBase.

Referenced by inet::visualizer::LinkCanvasVisualizerBase::addLinkVisualization(), and updateLinkVisualization().

 {
     linkVisualizations[sourceAndDestination] = linkVisualization;
 }

virtual const LinkVisualization* inet::visualizer::LinkVisualizerBase::createLinkVisualization	(	cModule *	source,
		cModule *	destination,
		cPacket *	packet
	)		const

protectedpure virtual

Implemented in inet::visualizer::LinkOsgVisualizerBase, inet::visualizer::LinkCanvasVisualizerBase, inet::visualizer::DataLinkCanvasVisualizer, and inet::visualizer::PhysicalLinkCanvasVisualizer.

Referenced by updateLinkVisualization().

cModule * inet::visualizer::LinkVisualizerBase::getLastModule ( int treeId )

protectedvirtual

Referenced by receiveSignal().

 {
     auto it = lastModules.find(treeId);
     if (it == lastModules.end())
         return nullptr;
     else
         return getSimulation()->getModule(it->second);
 }

const LinkVisualizerBase::LinkVisualization * inet::visualizer::LinkVisualizerBase::getLinkVisualization ( std::pair< int, int > linkVisualization )

protectedvirtual

Referenced by updateLinkVisualization().

 {
     auto it = linkVisualizations.find(linkVisualization);
     return it == linkVisualizations.end() ? nullptr : it->second;
 }

std::string inet::visualizer::LinkVisualizerBase::getLinkVisualizationText ( cPacket * packet ) const

protectedvirtual

Referenced by inet::visualizer::LinkCanvasVisualizerBase::createLinkVisualization(), and inet::visualizer::LinkCanvasVisualizerBase::refreshLinkVisualization().

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

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

overrideprotectedvirtual

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

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::LinkOsgVisualizerBase, and inet::visualizer::LinkCanvasVisualizerBase.

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

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

virtual bool inet::visualizer::LinkVisualizerBase::isLinkEnd ( cModule * module ) const

protectedpure virtual

Implemented in inet::visualizer::DataLinkCanvasVisualizer, inet::visualizer::DataLinkOsgVisualizer, inet::visualizer::PhysicalLinkCanvasVisualizer, and inet::visualizer::PhysicalLinkOsgVisualizer.

Referenced by receiveSignal().

virtual bool inet::visualizer::LinkVisualizerBase::isLinkStart ( cModule * module ) const

protectedpure virtual

Implemented in inet::visualizer::DataLinkCanvasVisualizer, inet::visualizer::DataLinkOsgVisualizer, inet::visualizer::PhysicalLinkCanvasVisualizer, and inet::visualizer::PhysicalLinkOsgVisualizer.

Referenced by receiveSignal().

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

overridevirtual

 {
     Enter_Method_Silent();
     if (signal == LayeredProtocolBase::packetReceivedFromUpperSignal) {
         if (isLinkStart(static_cast<cModule *>(source))) {
             auto module = check_and_cast<cModule *>(source);
             auto packet = check_and_cast<cPacket *>(object);
             auto treeId = packet->getTreeId();
             auto lastModule = getLastModule(treeId);
             if (lastModule != nullptr)
                 removeLastModule(treeId);
             auto networkNode = getContainingNode(module);
             auto interfaceEntry = getInterfaceEntry(networkNode, module);
             if (nodeFilter.matches(networkNode) && interfaceFilter.matches(interfaceEntry) && packetFilter.matches(packet))
                 setLastModule(treeId, module);
         }
     }
     else if (signal == LayeredProtocolBase::packetSentToUpperSignal) {
         if (isLinkEnd(static_cast<cModule *>(source))) {
             auto module = check_and_cast<cModule *>(source);
             auto packet = check_and_cast<cPacket *>(object);
             auto treeId = packet->getTreeId();
             auto lastModule = getLastModule(treeId);
             if (lastModule != nullptr) {
                 auto networkNode = getContainingNode(module);
                 auto interfaceEntry = getInterfaceEntry(networkNode, module);
                 if (nodeFilter.matches(networkNode) && interfaceFilter.matches(interfaceEntry) && packetFilter.matches(packet))
                     updateLinkVisualization(getContainingNode(lastModule), networkNode, packet);
                 // NOTE: don't call removeLastModule(treeId) because other network nodes may still receive this packet
             }
         }
     }
     else
         throw cRuntimeError("Unknown signal");
 }

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

overrideprotectedvirtual

Reimplemented in inet::visualizer::LinkCanvasVisualizerBase.

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

 {
     if (displayLinks) {
         AnimationPosition currentAnimationPosition;
         std::vector<const LinkVisualization *> removedLinkVisualizations;
         for (auto it : linkVisualizations) {
             auto linkVisualization = it.second;
             double delta;
             if (!strcmp(fadeOutMode, "simulationTime"))
                 delta = (currentAnimationPosition.getSimulationTime() - linkVisualization->lastUsageAnimationPosition.getSimulationTime()).dbl();
             else if (!strcmp(fadeOutMode, "animationTime"))
                 delta = currentAnimationPosition.getAnimationTime() - linkVisualization->lastUsageAnimationPosition.getAnimationTime();
             else if (!strcmp(fadeOutMode, "realTime"))
                 delta = currentAnimationPosition.getRealTime() - linkVisualization->lastUsageAnimationPosition.getRealTime();
             else
                 throw cRuntimeError("Unknown fadeOutMode: %s", fadeOutMode);
             if (delta > fadeOutTime)
                 removedLinkVisualizations.push_back(linkVisualization);
             else
                 setAlpha(linkVisualization, 1 - delta / fadeOutTime);
         }
         for (auto linkVisualization : removedLinkVisualizations) {
             const_cast<LinkVisualizerBase *>(this)->removeLinkVisualization(linkVisualization);
             delete linkVisualization;
         }
     }
 }

void inet::visualizer::LinkVisualizerBase::refreshLinkVisualization	(	const LinkVisualization *	linkVisualization,
		cPacket *	packet
	)

protectedvirtual

Reimplemented in inet::visualizer::LinkCanvasVisualizerBase.

Referenced by inet::visualizer::LinkCanvasVisualizerBase::refreshLinkVisualization(), and updateLinkVisualization().

 {
     linkVisualization->lastUsageAnimationPosition = AnimationPosition();
 }

void inet::visualizer::LinkVisualizerBase::removeAllLinkVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

 {
     lastModules.clear();
     std::vector<const LinkVisualization *> removedLinkVisualizations;
     for (auto it : linkVisualizations)
         removedLinkVisualizations.push_back(it.second);
     for (auto it : removedLinkVisualizations) {
         removeLinkVisualization(it);
         delete it;
     }
 }

void inet::visualizer::LinkVisualizerBase::removeLastModule ( int treeId )

protectedvirtual

Referenced by receiveSignal().

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

void inet::visualizer::LinkVisualizerBase::removeLinkVisualization ( const LinkVisualization * linkVisualization )

protectedvirtual

Reimplemented in inet::visualizer::LinkCanvasVisualizerBase.

Referenced by refreshDisplay(), removeAllLinkVisualizations(), and inet::visualizer::LinkCanvasVisualizerBase::removeLinkVisualization().

 {
     linkVisualizations.erase(linkVisualizations.find(std::pair<int, int>(linkVisualization->sourceModuleId, linkVisualization->destinationModuleId)));
 }

virtual void inet::visualizer::LinkVisualizerBase::setAlpha	(	const LinkVisualization *	linkVisualization,
		double	alpha
	)		const

protectedpure virtual

Implemented in inet::visualizer::LinkOsgVisualizerBase, and inet::visualizer::LinkCanvasVisualizerBase.

Referenced by refreshDisplay().

void inet::visualizer::LinkVisualizerBase::setLastModule	(	int	treeId,
		cModule *	lastModule
	)

protectedvirtual

Referenced by receiveSignal().

 {
     lastModules[treeId] = module->getId();
 }

void inet::visualizer::LinkVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

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

void inet::visualizer::LinkVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~LinkVisualizerBase().

 {
     // 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);
     }
 }

void inet::visualizer::LinkVisualizerBase::updateLinkVisualization	(	cModule *	source,
		cModule *	destination,
		cPacket *	packet
	)

protectedvirtual

Referenced by receiveSignal().

 {
     auto key = std::pair<int, int>(source->getId(), destination->getId());
     auto linkVisualization = getLinkVisualization(key);
     if (linkVisualization == nullptr) {
         linkVisualization = createLinkVisualization(source, destination, packet);
         addLinkVisualization(key, linkVisualization);
     }
     else
         refreshLinkVisualization(linkVisualization, packet);
 }