inet::visualizer::RadioCanvasVisualizer Class Reference

#include <RadioCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::RadioCanvasVisualizer:

Classes
class	RadioCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual RadioVisualization *	createRadioVisualization (const IRadio *radio) const override
virtual void	addRadioVisualization (const RadioVisualization *radioVisualization) override
virtual void	removeRadioVisualization (const RadioVisualization *radioVisualization) override
virtual void	refreshRadioVisualization (const RadioVisualization *radioVisualization) const override
virtual void	setImageIndex (IndexedImageFigure *indexedImageFigure, int index) const
Protected Member Functions inherited from inet::visualizer::RadioVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	refreshDisplay () const override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual const RadioVisualization *	getRadioVisualization (int radioModuleId)
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
double	zIndex = NaN
NetworkNodeCanvasVisualizer *	networkNodeVisualizer = nullptr
Protected Attributes inherited from inet::visualizer::RadioVisualizerBase
std::map< int, const RadioVisualization * >	radioVisualizations
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

Additional Inherited Members
Public Member Functions inherited from inet::visualizer::RadioVisualizerBase
virtual	~RadioVisualizerBase ()
virtual void	receiveSignal (cComponent *source, simsignal_t signal, long value, cObject *details) override

Member Function Documentation

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::RadioVisualizerBase.

{
    RadioVisualizerBase::addRadioVisualization(radioVisualization);
    auto radioCanvasVisualization = static_cast<const RadioCanvasVisualization *>(radioVisualization);
    radioCanvasVisualization->networkNodeVisualization->addAnnotation(radioCanvasVisualization->radioModeFigure, radioCanvasVisualization->radioModeFigure->getSize(), displacementHint, displacementPriority);
    radioCanvasVisualization->networkNodeVisualization->addAnnotation(radioCanvasVisualization->receptionStateFigure, radioCanvasVisualization->receptionStateFigure->getSize(), displacementHint, displacementPriority);
    radioCanvasVisualization->networkNodeVisualization->addAnnotation(radioCanvasVisualization->transmissionStateFigure, radioCanvasVisualization->transmissionStateFigure->getSize(), displacementHint, displacementPriority);
}

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

overrideprotectedvirtual

Implements inet::visualizer::RadioVisualizerBase.

{
    auto module = check_and_cast<const cModule *>(radio);
    // TODO: use RadioFigure?
    auto radioModeFigure = new IndexedImageFigure("radioMode");
    radioModeFigure->setTags((std::string("radioMode ") + tags).c_str());
    radioModeFigure->setTooltip("This figure represents the radio mode of a radio");
    radioModeFigure->setAssociatedObject(const_cast<cModule *>(module));
    radioModeFigure->setImages(radioModeImages);
    radioModeFigure->setSize(cFigure::Point(width, height));
    auto receptionStateFigure = new IndexedImageFigure("receptionState");
    receptionStateFigure->setTags((std::string("receptionState ") + tags).c_str());
    receptionStateFigure->setTooltip("This figure represents the reception state of a radio");
    receptionStateFigure->setImages(receptionStateImages);
    receptionStateFigure->setSize(cFigure::Point(width, height));
    auto transmissionStateFigure = new IndexedImageFigure("transmissionState");
    transmissionStateFigure->setTags((std::string("transmissionState ") + tags).c_str());
    transmissionStateFigure->setTooltip("This figure represents the transmission state of a radio");
    transmissionStateFigure->setImages(transmissionStateImages);
    transmissionStateFigure->setSize(cFigure::Point(width, height));
    auto networkNode = getContainingNode(module);
    auto networkNodeVisualization = networkNodeVisualizer->getNetworkNodeVisualization(networkNode);
    return new RadioCanvasVisualization(networkNodeVisualization, radioModeFigure, receptionStateFigure, transmissionStateFigure, module->getId());
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::RadioVisualizerBase.

{
    RadioVisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        zIndex = par("zIndex");
        networkNodeVisualizer = getModuleFromPar<NetworkNodeCanvasVisualizer>(par("networkNodeVisualizerModule"), this);
    }
}

void inet::visualizer::RadioCanvasVisualizer::refreshRadioVisualization ( const RadioVisualization *  radioVisualization ) const

overrideprotectedvirtual

Implements inet::visualizer::RadioVisualizerBase.

{
    auto radioCanvasVisualization = static_cast<const RadioCanvasVisualization *>(radioVisualization);
    auto module = getSimulation()->getComponent(radioCanvasVisualization->radioModuleId);
    if (module != nullptr) {
        auto radio = check_and_cast<IRadio *>(module);
        setImageIndex(radioCanvasVisualization->radioModeFigure, radio->getRadioMode());
        setImageIndex(radioCanvasVisualization->receptionStateFigure, radio->getReceptionState());
        setImageIndex(radioCanvasVisualization->transmissionStateFigure, radio->getTransmissionState());
        radioCanvasVisualization->receptionStateFigure->setAssociatedObject(const_cast<cObject *>(dynamic_cast<const cObject *>(radio->getReceptionInProgress())));
        radioCanvasVisualization->transmissionStateFigure->setAssociatedObject(const_cast<cObject *>(dynamic_cast<const cObject *>(radio->getTransmissionInProgress())));
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::RadioVisualizerBase.

{
    RadioVisualizerBase::removeRadioVisualization(radioVisualization);
    auto radioCanvasVisualization = static_cast<const RadioCanvasVisualization *>(radioVisualization);
    radioCanvasVisualization->networkNodeVisualization->removeAnnotation(radioCanvasVisualization->radioModeFigure);
    radioCanvasVisualization->networkNodeVisualization->removeAnnotation(radioCanvasVisualization->receptionStateFigure);
    radioCanvasVisualization->networkNodeVisualization->removeAnnotation(radioCanvasVisualization->transmissionStateFigure);
}

void inet::visualizer::RadioCanvasVisualizer::setImageIndex ( IndexedImageFigure *  indexedImageFigure, int  index  ) const

protectedvirtual

Referenced by refreshRadioVisualization().

{
    indexedImageFigure->setValue(0, simTime(), index);
    indexedImageFigure->setVisible(indexedImageFigure->getImages()[index] != "-");
}

Member Data Documentation

NetworkNodeCanvasVisualizer* inet::visualizer::RadioCanvasVisualizer::networkNodeVisualizer = nullptr

protected

Referenced by createRadioVisualization(), and initialize().

double inet::visualizer::RadioCanvasVisualizer::zIndex = NaN

protected

Referenced by initialize().

---

The documentation for this class was generated from the following files:

• RadioCanvasVisualizer.h
• RadioCanvasVisualizer.cc