#include <RadioVisualizerBase.h>

Inheritance diagram for inet::visualizer::RadioVisualizerBase:

Classes
class	RadioVisualization

Public Member Functions
virtual	~RadioVisualizerBase ()

virtual void	receiveSignal (cComponent source, simsignal_t signal, long value, 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 RadioVisualization *	createRadioVisualization (const IRadio *radio) const =0

virtual const RadioVisualization *	getRadioVisualization (int radioModuleId)

virtual void	addRadioVisualization (const RadioVisualization *radioVisualization)

virtual void	removeRadioVisualization (const RadioVisualization *radioVisualization)

virtual void	refreshRadioVisualization (const RadioVisualization *radioVisualization) 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::map< int, const RadioVisualization * >	radioVisualizations

Parameters
bool	displayRadios = false

bool	displayRadioMode = false

bool	displayReceptionState = false

bool	displayTransmissionState = false

std::vector< std::string >	radioModeImages

std::vector< std::string >	receptionStateImages

std::vector< std::string >	transmissionStateImages

ModuleFilter	radioFilter

double	width

double	height

Displacement	displacementHint

double	displacementPriority

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

const char *	tags = nullptr

Constructor & Destructor Documentation

inet::visualizer::RadioVisualizerBase::~RadioVisualizerBase ( )

virtual

 {
     if (displayRadios)
         unsubscribe();
 }

Member Function Documentation

void inet::visualizer::RadioVisualizerBase::addRadioVisualization ( const RadioVisualization * radioVisualization )

protectedvirtual

Reimplemented in inet::visualizer::RadioCanvasVisualizer.

Referenced by inet::visualizer::RadioCanvasVisualizer::addRadioVisualization(), and receiveSignal().

 {
     radioVisualizations[radioVisualization->radioModuleId] = radioVisualization;
 }

virtual RadioVisualization* inet::visualizer::RadioVisualizerBase::createRadioVisualization ( const IRadio * radio ) const

protectedpure virtual

Implemented in inet::visualizer::RadioOsgVisualizer, and inet::visualizer::RadioCanvasVisualizer.

Referenced by receiveSignal().

const RadioVisualizerBase::RadioVisualization * inet::visualizer::RadioVisualizerBase::getRadioVisualization ( int radioModuleId )

protectedvirtual

Referenced by receiveSignal().

 {
     auto it = radioVisualizations.find(radioModuleId);
     if (it == radioVisualizations.end())
         return nullptr;
     else
         return it->second;
 }

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

overrideprotectedvirtual

 {
     if (name != nullptr) {
         if (!strcmp(name, "radioFilter"))
             radioFilter.setPattern(par("radioFilter"));
     }
 }

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::RadioOsgVisualizer, and inet::visualizer::RadioCanvasVisualizer.

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

 {
     VisualizerBase::initialize(stage);
     if (!hasGUI()) return;
     if (stage == INITSTAGE_LOCAL) {
         displayRadios = par("displayRadios");
         displayRadioMode = par("displayRadioMode");
         displayReceptionState = par("displayReceptionState");
         displayTransmissionState = par("displayTransmissionState");
         cStringTokenizer radioModeImagesTokenizer(par("radioModeImages"));
         while (radioModeImagesTokenizer.hasMoreTokens())
             radioModeImages.push_back(radioModeImagesTokenizer.nextToken());
         cStringTokenizer receptionStateImagesTokenizer(par("receptionStateImages"));
         while (receptionStateImagesTokenizer.hasMoreTokens())
             receptionStateImages.push_back(receptionStateImagesTokenizer.nextToken());
         cStringTokenizer transmissionStateImagesTokenizer(par("transmissionStateImages"));
         while (transmissionStateImagesTokenizer.hasMoreTokens())
             transmissionStateImages.push_back(transmissionStateImagesTokenizer.nextToken());
         radioFilter.setPattern(par("radioFilter"));
         width = par("width");
         height = par("height");
         displacementHint = parseDisplacement(par("displacementHint"));
         displacementPriority = par("displacementPriority");
         if (displayRadios)
             subscribe();
     }
 }

void inet::visualizer::RadioVisualizerBase::receiveSignal	(	cComponent *	source,
		simsignal_t	signal,
		long	value,
		cObject *	details
	)

overridevirtual

 {
     Enter_Method_Silent();
     if (signal == IRadio::radioModeChangedSignal || signal == IRadio::receptionStateChangedSignal || signal == IRadio::transmissionStateChangedSignal) {
         auto module = check_and_cast<cModule *>(source);
         auto radio = check_and_cast<IRadio *>(module);
         if (getRadioVisualization(module->getId()) == nullptr && radioFilter.matches(module))
             addRadioVisualization(createRadioVisualization(radio));
     }
     else
         throw cRuntimeError("Unknown signal");
 }

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

overrideprotectedvirtual

 {
     for (auto it : radioVisualizations)
         refreshRadioVisualization(it.second);
 }

virtual void inet::visualizer::RadioVisualizerBase::refreshRadioVisualization ( const RadioVisualization * radioVisualization ) const

protectedpure virtual

Implemented in inet::visualizer::RadioOsgVisualizer, and inet::visualizer::RadioCanvasVisualizer.

Referenced by refreshDisplay().

void inet::visualizer::RadioVisualizerBase::removeRadioVisualization ( const RadioVisualization * radioVisualization )

protectedvirtual

Reimplemented in inet::visualizer::RadioCanvasVisualizer.

Referenced by inet::visualizer::RadioCanvasVisualizer::removeRadioVisualization().

 {
     radioVisualizations.erase(radioVisualizations.find(radioVisualization->radioModuleId));
 }

void inet::visualizer::RadioVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

 {
     auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
     subscriptionModule->subscribe(IRadio::radioModeChangedSignal, this);
     subscriptionModule->subscribe(IRadio::receptionStateChangedSignal, this);
     subscriptionModule->subscribe(IRadio::transmissionStateChangedSignal, this);
 }

void inet::visualizer::RadioVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~RadioVisualizerBase().

 {
     // 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(IRadio::radioModeChangedSignal, this);
         subscriptionModule->unsubscribe(IRadio::receptionStateChangedSignal, this);
         subscriptionModule->unsubscribe(IRadio::transmissionStateChangedSignal, this);
     }
 }