#include <PacketDropVisualizerBase.h>

Inheritance diagram for inet::visualizer::PacketDropVisualizerBase:

Classes
class	PacketDropVisualization

Public Member Functions
virtual	~PacketDropVisualizerBase ()

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 const PacketDropVisualization *	createPacketDropVisualization (cModule module, cPacket packet) const =0

virtual void	addPacketDropVisualization (const PacketDropVisualization *packetDropVisualization)

virtual void	removePacketDropVisualization (const PacketDropVisualization *packetDropVisualization)

virtual void	removeAllPacketDropVisualizations ()

virtual void	setAlpha (const PacketDropVisualization *packetDropVisualization, double alpha) const =0

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 PacketDropVisualization * >	packetDropVisualizations

Parameters
bool	displayPacketDrops = false

NetworkNodeFilter	nodeFilter

InterfaceFilter	interfaceFilter

PacketFilter	packetFilter

const char *	icon = nullptr

cFigure::Color	iconTintColor

double	iconTintAmount = NaN

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

virtual

 {
     for (auto packetDrop : packetDropVisualizations)
         delete packetDrop->packet;
     if (displayPacketDrops)
         unsubscribe();
 }

Member Function Documentation

void inet::visualizer::PacketDropVisualizerBase::addPacketDropVisualization ( const PacketDropVisualization * packetDropVisualization )

protectedvirtual

Reimplemented in inet::visualizer::PacketDropCanvasVisualizer.

Referenced by inet::visualizer::PacketDropCanvasVisualizer::addPacketDropVisualization(), and receiveSignal().

 {
     packetDropVisualizations.push_back(packetDropVisualization);
 }

virtual const PacketDropVisualization* inet::visualizer::PacketDropVisualizerBase::createPacketDropVisualization	(	cModule *	module,
		cPacket *	packet
	)		const

protectedpure virtual

Implemented in inet::visualizer::PacketDropOsgVisualizer, and inet::visualizer::PacketDropCanvasVisualizer.

Referenced by receiveSignal().

void inet::visualizer::PacketDropVisualizerBase::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"));
         removeAllPacketDropVisualizations();
     }
 }

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::PacketDropOsgVisualizer, and inet::visualizer::PacketDropCanvasVisualizer.

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

 {
     VisualizerBase::initialize(stage);
     if (!hasGUI()) return;
     if (stage == INITSTAGE_LOCAL) {
         displayPacketDrops = par("displayPacketDrops");
         nodeFilter.setPattern(par("nodeFilter"));
         interfaceFilter.setPattern(par("interfaceFilter"));
         packetFilter.setPattern(par("packetFilter"));
         icon = par("icon");
         iconTintAmount = par("iconTintAmount");
         if (iconTintAmount != 0)
             iconTintColor = cFigure::Color(par("iconTintColor"));
         labelFont = cFigure::parseFont(par("labelFont"));
         labelColor = cFigure::Color(par("labelColor"));
         fadeOutMode = par("fadeOutMode");
         fadeOutTime = par("fadeOutTime");
         fadeOutAnimationSpeed = par("fadeOutAnimationSpeed");
         if (displayPacketDrops)
             subscribe();
     }
 }

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

overridevirtual

 {
     Enter_Method_Silent();
     if (signal == LayeredProtocolBase::packetFromLowerDroppedSignal || signal == LayeredProtocolBase::packetFromUpperDroppedSignal
             || signal == PassiveQueueBase::dropPkByQueueSignal
 #ifdef WITH_ETHERNET
             || signal == EtherMACBase::dropPkIfaceDownSignal || signal == EtherMACBase::dropPkFromHLIfaceDownSignal
 #endif // WITH_ETHERNET
             ) {
         auto packet = check_and_cast<cPacket *>(object);
         if (packetFilter.matches(packet))
             addPacketDropVisualization(createPacketDropVisualization(check_and_cast<cModule*>(source), packet->dup()));
     }
     else
         throw cRuntimeError("Unknown signal");
 }

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

overrideprotectedvirtual

Reimplemented in inet::visualizer::PacketDropCanvasVisualizer.

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

 {
     AnimationPosition currentAnimationPosition;
     std::vector<const PacketDropVisualization *> removedPacketDropVisualizations;
     for (auto packetDrop : packetDropVisualizations) {
         double delta;
         if (!strcmp(fadeOutMode, "simulationTime"))
             delta = (currentAnimationPosition.getSimulationTime() - packetDrop->packetDropAnimationPosition.getSimulationTime()).dbl();
         else if (!strcmp(fadeOutMode, "animationTime"))
             delta = currentAnimationPosition.getAnimationTime() - packetDrop->packetDropAnimationPosition.getAnimationTime();
         else if (!strcmp(fadeOutMode, "realTime"))
             delta = currentAnimationPosition.getRealTime() - packetDrop->packetDropAnimationPosition.getRealTime();
         else
             throw cRuntimeError("Unknown fadeOutMode: %s", fadeOutMode);
         if (delta > fadeOutTime)
             removedPacketDropVisualizations.push_back(packetDrop);
         else
             setAlpha(packetDrop, 1 - delta / fadeOutTime);
     }
     for (auto packetDrop : removedPacketDropVisualizations) {
         const_cast<PacketDropVisualizerBase *>(this)->removePacketDropVisualization(packetDrop);
         delete packetDrop;
     }
 }

void inet::visualizer::PacketDropVisualizerBase::removeAllPacketDropVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

 {
     for (auto packetDropVisualization : packetDropVisualizations) {
         removePacketDropVisualization(packetDropVisualization);
         delete packetDropVisualization;
     }
 }

void inet::visualizer::PacketDropVisualizerBase::removePacketDropVisualization ( const PacketDropVisualization * packetDropVisualization )

protectedvirtual

Reimplemented in inet::visualizer::PacketDropCanvasVisualizer.

Referenced by refreshDisplay(), removeAllPacketDropVisualizations(), and inet::visualizer::PacketDropCanvasVisualizer::removePacketDropVisualization().

 {
     packetDropVisualizations.erase(std::remove(packetDropVisualizations.begin(), packetDropVisualizations.end(), packetDropVisualization), packetDropVisualizations.end());
 }

virtual void inet::visualizer::PacketDropVisualizerBase::setAlpha	(	const PacketDropVisualization *	packetDropVisualization,
		double	alpha
	)		const

protectedpure virtual

Implemented in inet::visualizer::PacketDropOsgVisualizer, and inet::visualizer::PacketDropCanvasVisualizer.

Referenced by refreshDisplay().

void inet::visualizer::PacketDropVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

 {
     auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
     subscriptionModule->subscribe(LayeredProtocolBase::packetFromLowerDroppedSignal, this);
     subscriptionModule->subscribe(LayeredProtocolBase::packetFromUpperDroppedSignal, this);
     subscriptionModule->subscribe(PassiveQueueBase::dropPkByQueueSignal, this);
 #ifdef WITH_ETHERNET
     subscriptionModule->subscribe(EtherMACBase::dropPkIfaceDownSignal, this);
     subscriptionModule->subscribe(EtherMACBase::dropPkFromHLIfaceDownSignal, this);
 #endif // WITH_ETHERNET
     subscriptionModule->subscribe(NF_PACKET_DROP, this);
 
 }

void inet::visualizer::PacketDropVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~PacketDropVisualizerBase().

 {
     // 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::packetFromLowerDroppedSignal, this);
         subscriptionModule->unsubscribe(LayeredProtocolBase::packetFromUpperDroppedSignal, this);
         subscriptionModule->unsubscribe(PassiveQueueBase::dropPkByQueueSignal, this);
 #ifdef WITH_ETHERNET
         subscriptionModule->unsubscribe(EtherMACBase::dropPkIfaceDownSignal, this);
         subscriptionModule->unsubscribe(EtherMACBase::dropPkFromHLIfaceDownSignal, this);
 #endif // WITH_ETHERNET
         subscriptionModule->unsubscribe(NF_PACKET_DROP, this);
     }
 }