#include <RadioVisualizerBase.h>

Inheritance diagram for inet::visualizer::RadioVisualizerBase:

Classes
class	RadioVisualization

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

Placement	placementHint

double	placementPriority

bool	antennaLobeNormalize = false

bool	antennaLobeRelativeLabels = false

bool	displayAntennaLobes = false

bool	antennaLobePlaneGlobal = false

const char *	antennaLobePlane = nullptr

const char *	antennaLobeMode = nullptr

double	antennaLobeLogarithmicBase = NaN

double	antennaLobeLogarithmicScale = NaN

double	antennaLobeRadius = NaN

deg	antennaLobeStep = deg(NaN)

double	antennaLobeOpacity = NaN

bool	antennaLobeLineSmooth = false

cFigure::Color	antennaLobeLineColor

cFigure::LineStyle	antennaLobeLineStyle

double	antennaLobeLineWidth = NaN

cFigure::Color	antennaLobeFillColor

std::map< int, const RadioVisualization * >	radioVisualizations

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 RadioVisualization *	createRadioVisualization (const physicallayer::IRadio *radio) const =0

virtual const RadioVisualization *	getRadioVisualization (int radioModuleId)

virtual void	addRadioVisualization (const RadioVisualization *radioVisualization)

virtual void	removeRadioVisualization (const RadioVisualization *radioVisualization)

virtual void	removeAllRadioVisualizations ()

virtual void	refreshRadioVisualization (const RadioVisualization *radioVisualization) const =0

virtual void	receiveSignal (cComponent source, simsignal_t signal, intval_t value, 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

◆ addRadioVisualization()

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

protectedvirtual

Reimplemented in inet::visualizer::RadioCanvasVisualizer.

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

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

◆ createRadioVisualization()

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

protectedpure virtual

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

Referenced by receiveSignal().

◆ getRadioVisualization()

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

protectedvirtual

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

Referenced by receiveSignal().

◆ handleParameterChange()

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

overrideprotectedvirtual

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

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

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

 {
     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");
         placementHint = parsePlacement(par("placementHint"));
         placementPriority = par("placementPriority");
         // antenna lobe
         displayAntennaLobes = par("displayAntennaLobes");
         antennaLobeNormalize = par("antennaLobeNormalize");
         antennaLobeRelativeLabels = par("antennaLobeRelativeLabels");
         antennaLobePlaneGlobal = par("antennaLobePlaneGlobal");
         antennaLobePlane = par("antennaLobePlane");
         antennaLobeMode = par("antennaLobeMode");
         antennaLobeLogarithmicBase = par("antennaLobeLogarithmicBase");
         antennaLobeLogarithmicScale = par("antennaLobeLogarithmicScale");
         antennaLobeRadius = par("antennaLobeRadius");
         antennaLobeStep = deg(par("antennaLobeStep"));
         antennaLobeOpacity = par("antennaLobeOpacity");
         antennaLobeLineSmooth = par("antennaLobeLineSmooth");
         antennaLobeLineColor = cFigure::parseColor(par("antennaLobeLineColor"));
         antennaLobeLineStyle = cFigure::parseLineStyle(par("antennaLobeLineStyle"));
         antennaLobeLineWidth = par("antennaLobeLineWidth");
         antennaLobeFillColor = cFigure::parseColor(par("antennaLobeFillColor"));
         if (displayRadios)
             subscribe();
     }
 }

Referenced by inet::visualizer::RadioOsgVisualizer::initialize(), and inet::visualizer::RadioCanvasVisualizer::initialize().

◆ preDelete()

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

overrideprotectedvirtual

 {
     if (displayRadios) {
         unsubscribe();
         removeAllRadioVisualizations();
     }
 }

◆ receiveSignal()

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

overridevirtual

 {
     Enter_Method("%s", cComponent::getSignalName(signal));
  
     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");
 }

◆ refreshDisplay()

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

overrideprotectedvirtual

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

◆ refreshRadioVisualization()

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

protectedpure virtual

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

Referenced by refreshDisplay().

◆ removeAllRadioVisualizations()

void inet::visualizer::RadioVisualizerBase::removeAllRadioVisualizations ( )

protectedvirtual

 {
     for (auto radioVisualization : std::map<int, const RadioVisualization *>(radioVisualizations)) {
         removeRadioVisualization(radioVisualization.second);
         delete radioVisualization.second;
     }
 }

Referenced by preDelete().

◆ removeRadioVisualization()

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

protectedvirtual

Reimplemented in inet::visualizer::RadioCanvasVisualizer.

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

Referenced by removeAllRadioVisualizations(), and inet::visualizer::RadioCanvasVisualizer::removeRadioVisualization().

◆ subscribe()

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

protectedvirtual

 {
     visualizationSubjectModule->subscribe(IRadio::radioModeChangedSignal, this);
     visualizationSubjectModule->subscribe(IRadio::receptionStateChangedSignal, this);
     visualizationSubjectModule->subscribe(IRadio::transmissionStateChangedSignal, this);
 }

Referenced by initialize().

◆ unsubscribe()

void inet::visualizer::RadioVisualizerBase::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(IRadio::radioModeChangedSignal, this);
         visualizationSubjectModule->unsubscribe(IRadio::receptionStateChangedSignal, this);
         visualizationSubjectModule->unsubscribe(IRadio::transmissionStateChangedSignal, this);
     }
 }