#include <LinkBreakVisualizerBase.h>

Inheritance diagram for inet::visualizer::LinkBreakVisualizerBase:

Classes
class	LinkBreakVisualization

Public Member Functions
virtual	~LinkBreakVisualizerBase ()

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 LinkBreakVisualization *	createLinkBreakVisualization (cModule transmitter, cModule receiver) const =0

virtual void	addLinkBreakVisualization (const LinkBreakVisualization *linkBreakVisualization)

virtual void	removeLinkBreakVisualization (const LinkBreakVisualization *linkBreakVisualization)

virtual void	removeAllLinkBreakVisualizations ()

virtual void	setAlpha (const LinkBreakVisualization *linkBreakVisualization, double alpha) const =0

virtual cModule *	findNode (MACAddress address)

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::map< std::pair< int, int >, const LinkBreakVisualization * >	linkBreakVisualizations

Parameters
bool	displayLinkBreaks = false

NetworkNodeFilter	nodeFilter

InterfaceFilter	interfaceFilter

PacketFilter	packetFilter

const char *	icon = nullptr

double	iconTintAmount = NaN

cFigure::Color	iconTintColor

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

virtual

 {
     if (displayLinkBreaks)
         unsubscribe();
 }

Member Function Documentation

void inet::visualizer::LinkBreakVisualizerBase::addLinkBreakVisualization ( const LinkBreakVisualization * linkBreakVisualization )

protectedvirtual

Reimplemented in inet::visualizer::LinkBreakCanvasVisualizer.

Referenced by inet::visualizer::LinkBreakCanvasVisualizer::addLinkBreakVisualization(), and receiveSignal().

 {
     auto key = std::pair<int, int>(linkBreakVisualization->transmitterModuleId, linkBreakVisualization->receiverModuleId);
     linkBreakVisualizations[key] = linkBreakVisualization;
 }

virtual const LinkBreakVisualization* inet::visualizer::LinkBreakVisualizerBase::createLinkBreakVisualization	(	cModule *	transmitter,
		cModule *	receiver
	)		const

protectedpure virtual

Implemented in inet::visualizer::LinkBreakOsgVisualizer, and inet::visualizer::LinkBreakCanvasVisualizer.

Referenced by receiveSignal().

cModule * inet::visualizer::LinkBreakVisualizerBase::findNode ( MACAddress address )

protectedvirtual

Referenced by receiveSignal().

 {
     L3AddressResolver addressResolver;
     for (cModule::SubmoduleIterator it(getSystemModule()); !it.end(); it++) {
         auto networkNode = *it;
         if (isNetworkNode(networkNode)) {
             auto interfaceTable = addressResolver.findInterfaceTableOf(networkNode);
             for (int i = 0; i < interfaceTable->getNumInterfaces(); i++)
                 if (interfaceTable->getInterface(i)->getMacAddress() == address)
                     return networkNode;
         }
     }
     return nullptr;
 }

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

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::LinkBreakOsgVisualizer, and inet::visualizer::LinkBreakCanvasVisualizer.

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

 {
     VisualizerBase::initialize(stage);
     if (!hasGUI()) return;
     if (stage == INITSTAGE_LOCAL) {
         displayLinkBreaks = par("displayLinkBreaks");
         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"));
         fadeOutMode = par("fadeOutMode");
         fadeOutTime = par("fadeOutTime");
         fadeOutAnimationSpeed = par("fadeOutAnimationSpeed");
         if (displayLinkBreaks)
             subscribe();
     }
 }

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

overridevirtual

 {
     Enter_Method_Silent();
     if (signal == NF_LINK_BREAK) {
         MACAddress transmitterAddress;
         MACAddress receiverAddress;
         if (auto frame = dynamic_cast<IMACFrame *>(object)) {
             transmitterAddress = frame->getTransmitterAddress();
             receiverAddress = frame->getReceiverAddress();
         }
 #ifdef WITH_IEEE80211
         if (auto frame = dynamic_cast<ieee80211::Ieee80211TwoAddressFrame *>(object)) {
             transmitterAddress = frame->getTransmitterAddress();
             receiverAddress = frame->getReceiverAddress();
         }
 #endif // WITH_IEEE80211
         auto transmitter = findNode(transmitterAddress);
         auto receiver = findNode(receiverAddress);
         if (nodeFilter.matches(transmitter) && nodeFilter.matches(receiver)) {
             auto key = std::pair<int, int>(transmitter->getId(), receiver->getId());
             auto it = linkBreakVisualizations.find(key);
             if (it == linkBreakVisualizations.end())
                 addLinkBreakVisualization(createLinkBreakVisualization(transmitter, receiver));
             else {
                 auto linkBreakVisualization = it->second;
                 linkBreakVisualization->linkBreakAnimationPosition = AnimationPosition();
             }
         }
     }
     else
         throw cRuntimeError("Unknown signal");
 }

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

overrideprotectedvirtual

Reimplemented in inet::visualizer::LinkBreakCanvasVisualizer.

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

 {
     AnimationPosition currentAnimationPosition;
     std::vector<const LinkBreakVisualization *> removedLinkBreakVisualizations;
     for (auto it : linkBreakVisualizations) {
         auto linkBreakVisualization = it.second;
         double delta;
         if (!strcmp(fadeOutMode, "simulationTime"))
             delta = (currentAnimationPosition.getSimulationTime() - linkBreakVisualization->linkBreakAnimationPosition.getSimulationTime()).dbl();
         else if (!strcmp(fadeOutMode, "animationTime"))
             delta = currentAnimationPosition.getAnimationTime() - linkBreakVisualization->linkBreakAnimationPosition.getAnimationTime();
         else if (!strcmp(fadeOutMode, "realTime"))
             delta = currentAnimationPosition.getRealTime() - linkBreakVisualization->linkBreakAnimationPosition.getRealTime();
         else
             throw cRuntimeError("Unknown fadeOutMode: %s", fadeOutMode);
         if (delta > fadeOutTime)
             removedLinkBreakVisualizations.push_back(linkBreakVisualization);
         else
             setAlpha(linkBreakVisualization, 1 - delta / fadeOutTime);
     }
     for (auto linkBreakVisualization : removedLinkBreakVisualizations) {
         const_cast<LinkBreakVisualizerBase *>(this)->removeLinkBreakVisualization(linkBreakVisualization);
         delete linkBreakVisualization;
     }
 }

void inet::visualizer::LinkBreakVisualizerBase::removeAllLinkBreakVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

 {
     std::vector<const LinkBreakVisualization *> removedLinkBreakVisualizations;
     for (auto it : linkBreakVisualizations)
         removedLinkBreakVisualizations.push_back(it.second);
     for (auto it : removedLinkBreakVisualizations) {
         removeLinkBreakVisualization(it);
         delete it;
     }
 }

void inet::visualizer::LinkBreakVisualizerBase::removeLinkBreakVisualization ( const LinkBreakVisualization * linkBreakVisualization )

protectedvirtual

Reimplemented in inet::visualizer::LinkBreakCanvasVisualizer.

Referenced by refreshDisplay(), removeAllLinkBreakVisualizations(), and inet::visualizer::LinkBreakCanvasVisualizer::removeLinkBreakVisualization().

 {
     auto key = std::pair<int, int>(linkBreakVisualization->transmitterModuleId, linkBreakVisualization->receiverModuleId);
     auto it = linkBreakVisualizations.find(key);
     linkBreakVisualizations.erase(it);
 }

virtual void inet::visualizer::LinkBreakVisualizerBase::setAlpha	(	const LinkBreakVisualization *	linkBreakVisualization,
		double	alpha
	)		const

protectedpure virtual

Implemented in inet::visualizer::LinkBreakOsgVisualizer, and inet::visualizer::LinkBreakCanvasVisualizer.

Referenced by refreshDisplay().

void inet::visualizer::LinkBreakVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

 {
     auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
     subscriptionModule->subscribe(NF_LINK_BREAK, this);
 }

void inet::visualizer::LinkBreakVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~LinkBreakVisualizerBase().

 {
     // 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(NF_LINK_BREAK, this);
 }