#include <PacketDropVisualizerBase.h>

Inheritance diagram for inet::visualizer::PacketDropVisualizerBase:

Classes
class	DetailsFilter

class	DirectiveResolver

class	PacketDropVisualization

Parameters
bool	displayPacketDrops = false

NetworkNodeFilter	nodeFilter

InterfaceFilter	interfaceFilter

PacketFilter	packetFilter

DetailsFilter	detailsFilter

const char *	icon = nullptr

ColorSet	iconTintColorSet

double	iconTintAmount = NaN

StringFormat	labelFormat

cFigure::Font	labelFont

cFigure::Color	labelColor

const char *	fadeOutMode = nullptr

double	fadeOutTime = NaN

double	fadeOutAnimationSpeed = NaN

std::vector< const PacketDropVisualization * >	packetDropVisualizations

virtual void	initialize (int stage) override

virtual void	handleParameterChange (const char *name) override

virtual void	refreshDisplay () const override

virtual void	preDelete (cComponent *root) override

virtual void	subscribe ()

virtual void	unsubscribe ()

virtual const PacketDropVisualization *	createPacketDropVisualization (PacketDrop *packetDrop) 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

virtual std::string	getPacketDropVisualizationText (const PacketDrop *packetDrop) const

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

◆ addPacketDropVisualization()

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

protectedvirtual

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

 {
     packetDropVisualizations.push_back(packetDropVisualization);
 }

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

◆ createPacketDropVisualization()

virtual const PacketDropVisualization* inet::visualizer::PacketDropVisualizerBase::createPacketDropVisualization ( PacketDrop * packetDrop ) const

protectedpure virtual

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

Referenced by receiveSignal().

◆ getPacketDropVisualizationText()

std::string inet::visualizer::PacketDropVisualizerBase::getPacketDropVisualizationText ( const PacketDrop * packetDrop ) const

protectedvirtual

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

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

◆ handleParameterChange()

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

overrideprotectedvirtual

 {
     if (!hasGUI()) return;
     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.setExpression(par("packetFilter").objectValue());
         else if (!strcmp(name, "detailsFilter"))
             detailsFilter.setPattern(par("detailsFilter"));
         else if (!strcmp(name, "labelFormat"))
             labelFormat.parseFormat(par("labelFormat"));
         removeAllPacketDropVisualizations();
     }
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::PacketDropCanvasVisualizer.

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

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

◆ preDelete()

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

overrideprotectedvirtual

 {
     if (displayPacketDrops) {
         unsubscribe();
         removeAllPacketDropVisualizations();
     }
 }

◆ receiveSignal()

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

overridevirtual

 {
     Enter_Method("%s", cComponent::getSignalName(signal));
  
     if (signal == packetDroppedSignal) {
         auto module = check_and_cast<cModule *>(source);
         auto packet = check_and_cast<cPacket *>(object);
         auto packetDropDetails = check_and_cast<PacketDropDetails *>(details);
         auto networkNode = findContainingNode(module);
         auto networkInterface = findContainingNicModule(module);
         if ((networkNode == nullptr || nodeFilter.matches(networkNode)) && (networkInterface == nullptr || interfaceFilter.matches(networkInterface)) &&
             packetFilter.matches(packet) && detailsFilter.matches(packetDropDetails))
         {
             auto position = networkNode != nullptr ? getPosition(networkNode) : Coord::NIL;
             auto packetDrop = new PacketDrop(packetDropDetails->getReason(), packet->dup(), module->getId(), position);
             auto packetDropVisualization = createPacketDropVisualization(packetDrop);
             addPacketDropVisualization(packetDropVisualization);
         }
     }
     else
         throw cRuntimeError("Unknown signal");
 }

◆ refreshDisplay()

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

overrideprotectedvirtual

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

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

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

◆ removeAllPacketDropVisualizations()

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

protectedvirtual

 {
     for (auto packetDropVisualization : std::vector<const PacketDropVisualization *>(packetDropVisualizations)) {
         removePacketDropVisualization(packetDropVisualization);
         delete packetDropVisualization;
     }
 }

Referenced by handleParameterChange(), and preDelete().

◆ removePacketDropVisualization()

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

protectedvirtual

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

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

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

◆ setAlpha()

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().

◆ subscribe()

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

protectedvirtual

 {
     visualizationSubjectModule->subscribe(packetDroppedSignal, this);
  
 }

Referenced by initialize().

◆ unsubscribe()

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

protectedvirtual

 {
     // NOTE: lookup the module again because it may have been deleted first
     auto visualizationSubjectModule = findModuleFromPar<cModule>(par("visualizationSubjectModule"), this);
     if (visualizationSubjectModule != nullptr)
         visualizationSubjectModule->unsubscribe(packetDroppedSignal, this);
 }