inet::visualizer::MediumVisualizerBase Class Reference

#include <MediumVisualizerBase.h>

Inheritance diagram for inet::visualizer::MediumVisualizerBase:

Public Member Functions
virtual	~MediumVisualizerBase ()
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *object, cObject *details) override

Protected Types
enum	SignalShape { SIGNAL_SHAPE_RING, SIGNAL_SHAPE_SPHERE, SIGNAL_SHAPE_BOTH }

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	handleParameterChange (const char *name) override
virtual bool	isSignalPropagationInProgress (const ITransmission *transmission) const
virtual bool	isSignalTransmissionInProgress (const ITransmission *transmission) const
virtual bool	matchesTransmission (const ITransmission *transmission) const
virtual void	radioAdded (const IRadio *radio)=0
virtual void	radioRemoved (const IRadio *radio)=0
virtual void	transmissionAdded (const ITransmission *transmission)=0
virtual void	transmissionRemoved (const ITransmission *transmission)=0
virtual void	transmissionStarted (const ITransmission *transmission)=0
virtual void	transmissionEnded (const ITransmission *transmission)=0
virtual void	receptionStarted (const IReception *reception)=0
virtual void	receptionEnded (const IReception *reception)=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
Parameters
IRadioMedium *	radioMedium = nullptr
NetworkNodeFilter	networkNodeFilter
InterfaceFilter	interfaceFilter
PacketFilter	packetFilter
bool	displaySignals = false
ColorSet	signalColorSet
double	signalPropagationAnimationSpeed = NaN
double	signalPropagationAnimationTime = NaN
double	signalPropagationAdditionalTime = NaN
double	signalTransmissionAnimationSpeed = NaN
double	signalTransmissionAnimationTime = NaN
double	signalAnimationSpeedChangeTime = NaN
bool	displayTransmissions = false
bool	displayReceptions = false
Displacement	transmissionDisplacementHint
Displacement	receptionDisplacementHint
double	transmissionDisplacementPriority
double	receptionDisplacementPriority
bool	displayInterferenceRanges = false
cFigure::Color	interferenceRangeLineColor
cFigure::LineStyle	interferenceRangeLineStyle
double	interferenceRangeLineWidth = NaN
bool	displayCommunicationRanges = false
cFigure::Color	communicationRangeLineColor
cFigure::LineStyle	communicationRangeLineStyle
double	communicationRangeLineWidth = NaN
State
double	defaultSignalPropagationAnimationSpeed = NaN
double	defaultSignalTransmissionAnimationSpeed = NaN
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizerTargetModule = nullptr
const char *	tags = nullptr

Member Enumeration Documentation

enum inet::visualizer::MediumVisualizerBase::SignalShape

protected

Enumerator
SIGNAL_SHAPE_RING
SIGNAL_SHAPE_SPHERE
SIGNAL_SHAPE_BOTH

    {
        SIGNAL_SHAPE_RING,
        SIGNAL_SHAPE_SPHERE,
        SIGNAL_SHAPE_BOTH,
    };

Constructor & Destructor Documentation

inet::visualizer::MediumVisualizerBase::~MediumVisualizerBase ( )

virtual

{
    // NOTE: lookup the medium module again because it may have been deleted first
    auto radioMediumModule = getModuleFromPar<cModule>(par("mediumModule"), this, false);
    if (radioMediumModule != nullptr) {
        radioMediumModule->unsubscribe(IRadioMedium::radioAddedSignal, this);
        radioMediumModule->unsubscribe(IRadioMedium::radioRemovedSignal, this);
        radioMediumModule->unsubscribe(IRadioMedium::transmissionAddedSignal, this);
        radioMediumModule->unsubscribe(IRadioMedium::transmissionRemovedSignal, this);
        radioMediumModule->unsubscribe(IRadioMedium::transmissionStartedSignal, this);
        radioMediumModule->unsubscribe(IRadioMedium::transmissionEndedSignal, this);
        radioMediumModule->unsubscribe(IRadioMedium::receptionStartedSignal, this);
        radioMediumModule->unsubscribe(IRadioMedium::receptionEndedSignal, this);
    }
}

Member Function Documentation

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

overrideprotectedvirtual

{
    if (name != nullptr) {
        if (!strcmp(name, "networkNodeFilter"))
            networkNodeFilter.setPattern(par("nodeFilter"));
        else if (!strcmp(name, "interfaceFilter"))
            interfaceFilter.setPattern(par("interfaceFilter"));
        else if (!strcmp(name, "packetFilter"))
            packetFilter.setPattern(par("packetFilter"));
        else if (!strcmp(name, "signalPropagationAnimationSpeed"))
            signalPropagationAnimationSpeed = par("signalPropagationAnimationSpeed");
        else if (!strcmp(name, "signalTransmissionAnimationSpeed"))
            signalTransmissionAnimationSpeed = par("signalTransmissionAnimationSpeed");
        // TODO:
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::MediumOsgVisualizer, and inet::visualizer::MediumCanvasVisualizer.

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

{
    VisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        networkNodeFilter.setPattern(par("nodeFilter"));
        interfaceFilter.setPattern(par("interfaceFilter"));
        packetFilter.setPattern(par("packetFilter"));
        displaySignals = par("displaySignals");
        signalColorSet.parseColors(par("signalColor"));
        signalPropagationAnimationSpeed = par("signalPropagationAnimationSpeed");
        signalPropagationAnimationTime = par("signalPropagationAnimationTime");
        signalPropagationAdditionalTime = par("signalPropagationAdditionalTime");
        signalTransmissionAnimationSpeed = par("signalTransmissionAnimationSpeed");
        signalTransmissionAnimationTime = par("signalTransmissionAnimationTime");
        signalAnimationSpeedChangeTime = par("signalAnimationSpeedChangeTime");
        displayTransmissions = par("displayTransmissions");
        displayReceptions = par("displayReceptions");
        transmissionDisplacementHint = parseDisplacement(par("transmissionDisplacementHint"));
        receptionDisplacementHint = parseDisplacement(par("receptionDisplacementHint"));
        transmissionDisplacementPriority = par("transmissionDisplacementPriority");
        receptionDisplacementPriority = par("receptionDisplacementPriority");
        displayInterferenceRanges = par("displayInterferenceRanges");
        interferenceRangeLineColor = cFigure::Color(par("interferenceRangeLineColor"));
        interferenceRangeLineStyle = cFigure::parseLineStyle(par("interferenceRangeLineStyle"));
        interferenceRangeLineWidth = par("interferenceRangeLineWidth");
        displayCommunicationRanges = par("displayCommunicationRanges");
        communicationRangeLineColor = cFigure::Color(par("communicationRangeLineColor"));
        communicationRangeLineStyle = cFigure::parseLineStyle(par("communicationRangeLineStyle"));
        communicationRangeLineWidth = par("communicationRangeLineWidth");
        signalPropagationAnimationSpeed = par("signalPropagationAnimationSpeed");
        signalTransmissionAnimationSpeed = par("signalTransmissionAnimationSpeed");
        radioMedium = getModuleFromPar<IRadioMedium>(par("mediumModule"), this, false);
        if (radioMedium != nullptr) {
            cModule *radioMediumModule = check_and_cast<cModule *>(radioMedium);
            radioMediumModule->subscribe(IRadioMedium::radioAddedSignal, this);
            radioMediumModule->subscribe(IRadioMedium::radioRemovedSignal, this);
            radioMediumModule->subscribe(IRadioMedium::transmissionAddedSignal, this);
            radioMediumModule->subscribe(IRadioMedium::transmissionRemovedSignal, this);
            radioMediumModule->subscribe(IRadioMedium::transmissionStartedSignal, this);
            radioMediumModule->subscribe(IRadioMedium::transmissionEndedSignal, this);
            radioMediumModule->subscribe(IRadioMedium::receptionStartedSignal, this);
            radioMediumModule->subscribe(IRadioMedium::receptionEndedSignal, this);
        }
    }
    else if (stage == INITSTAGE_LAST) {
        if (std::isnan(signalPropagationAnimationSpeed) && radioMedium != nullptr) {
            double maxPropagationDuration = radioMedium->getMediumLimitCache()->getMaxConstraintArea().distance(radioMedium->getMediumLimitCache()->getMinConstraintArea()) / mps(radioMedium->getPropagation()->getPropagationSpeed()).get();
            defaultSignalPropagationAnimationSpeed = maxPropagationDuration / signalPropagationAnimationTime;
        }
    }
}

bool inet::visualizer::MediumVisualizerBase::isSignalPropagationInProgress ( const ITransmission *  transmission ) const

protectedvirtual

Referenced by inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

{
    simtime_t now = simTime();
    ICommunicationCache *communicationCache = const_cast<ICommunicationCache *>(radioMedium->getCommunicationCache());
    const IMediumLimitCache *mediumLimitCache = radioMedium->getMediumLimitCache();
    const simtime_t transmissionStartTime = transmission->getStartTime();
    const simtime_t transmissionEndTime = transmission->getEndTime();
    const simtime_t interferenceEndTime = communicationCache->getCachedInterferenceEndTime(transmission);
    simtime_t maxPropagationTime = interferenceEndTime - transmissionEndTime - mediumLimitCache->getMaxTransmissionDuration() + signalPropagationAdditionalTime;
    return (transmissionStartTime <= now && now < transmissionStartTime + maxPropagationTime) ||
           (transmissionEndTime <= now && now < transmissionEndTime + maxPropagationTime);
}

bool inet::visualizer::MediumVisualizerBase::isSignalTransmissionInProgress ( const ITransmission *  transmission ) const

protectedvirtual

Referenced by inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

{
    simtime_t now = simTime();
    return transmission->getStartTime() <= now && now < transmission->getEndTime();
}

bool inet::visualizer::MediumVisualizerBase::matchesTransmission ( const ITransmission *  transmission ) const

protectedvirtual

Referenced by inet::visualizer::MediumCanvasVisualizer::receptionEnded(), inet::visualizer::MediumCanvasVisualizer::receptionStarted(), inet::visualizer::MediumCanvasVisualizer::refreshDisplay(), inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed(), inet::visualizer::MediumCanvasVisualizer::transmissionAdded(), inet::visualizer::MediumCanvasVisualizer::transmissionEnded(), inet::visualizer::MediumCanvasVisualizer::transmissionRemoved(), and inet::visualizer::MediumCanvasVisualizer::transmissionStarted().

{
    auto radio = check_and_cast<const cModule *>(transmission->getTransmitter());
    auto networkNode = getContainingNode(radio);
    if (!networkNodeFilter.matches(networkNode))
        return false;
    L3AddressResolver addressResolver;
    if (auto interfaceTable = addressResolver.findInterfaceTableOf(networkNode)) {
        auto interfaceEntry = interfaceTable->getInterfaceByInterfaceModule(radio->getParentModule());
        if (!interfaceFilter.matches(interfaceEntry))
            return false;
    }
    auto packet = transmission->getPhyFrame() != nullptr ? transmission->getPhyFrame() : transmission->getMacFrame();
    return packetFilter.matches(packet);
}

virtual void inet::visualizer::MediumVisualizerBase::radioAdded ( const IRadio *  radio )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

virtual void inet::visualizer::MediumVisualizerBase::radioRemoved ( const IRadio *  radio )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

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

overridevirtual

{
    Enter_Method_Silent();
    if (signal == IRadioMedium::radioAddedSignal)
        radioAdded(check_and_cast<IRadio *>(object));
    else if (signal == IRadioMedium::radioRemovedSignal)
        radioRemoved(check_and_cast<IRadio *>(object));
    else if (signal == IRadioMedium::transmissionAddedSignal)
        transmissionAdded(check_and_cast<ITransmission *>(object));
    else if (signal == IRadioMedium::transmissionRemovedSignal)
        transmissionRemoved(check_and_cast<ITransmission *>(object));
    else if (signal == IRadioMedium::transmissionStartedSignal)
        transmissionStarted(check_and_cast<ITransmission *>(object));
    else if (signal == IRadioMedium::transmissionEndedSignal)
        transmissionEnded(check_and_cast<ITransmission *>(object));
    else if (signal == IRadioMedium::receptionStartedSignal)
        receptionStarted(check_and_cast<IReception *>(object));
    else if (signal == IRadioMedium::receptionEndedSignal)
        receptionEnded(check_and_cast<IReception *>(object));
    else
        throw cRuntimeError("Unknown signal");
}

virtual void inet::visualizer::MediumVisualizerBase::receptionEnded ( const IReception *  reception )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

virtual void inet::visualizer::MediumVisualizerBase::receptionStarted ( const IReception *  reception )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

virtual void inet::visualizer::MediumVisualizerBase::transmissionAdded ( const ITransmission *  transmission )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

virtual void inet::visualizer::MediumVisualizerBase::transmissionEnded ( const ITransmission *  transmission )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

virtual void inet::visualizer::MediumVisualizerBase::transmissionRemoved ( const ITransmission *  transmission )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

virtual void inet::visualizer::MediumVisualizerBase::transmissionStarted ( const ITransmission *  transmission )

protectedpure virtual

Implemented in inet::visualizer::MediumCanvasVisualizer, and inet::visualizer::MediumOsgVisualizer.

Referenced by receiveSignal().

Member Data Documentation

cFigure::Color inet::visualizer::MediumVisualizerBase::communicationRangeLineColor

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

cFigure::LineStyle inet::visualizer::MediumVisualizerBase::communicationRangeLineStyle

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

double inet::visualizer::MediumVisualizerBase::communicationRangeLineWidth = NaN

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

double inet::visualizer::MediumVisualizerBase::defaultSignalPropagationAnimationSpeed = NaN

protected

Referenced by initialize(), inet::visualizer::MediumCanvasVisualizer::refreshSignalFigure(), and inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

double inet::visualizer::MediumVisualizerBase::defaultSignalTransmissionAnimationSpeed = NaN

protected

Referenced by inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

bool inet::visualizer::MediumVisualizerBase::displayCommunicationRanges = false

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

bool inet::visualizer::MediumVisualizerBase::displayInterferenceRanges = false

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

bool inet::visualizer::MediumVisualizerBase::displayReceptions = false

protected

Referenced by initialize(), inet::visualizer::MediumCanvasVisualizer::radioAdded(), inet::visualizer::MediumCanvasVisualizer::receptionEnded(), and inet::visualizer::MediumCanvasVisualizer::receptionStarted().

bool inet::visualizer::MediumVisualizerBase::displaySignals = false

protected

Referenced by initialize(), inet::visualizer::MediumCanvasVisualizer::initialize(), inet::visualizer::MediumCanvasVisualizer::receptionEnded(), inet::visualizer::MediumCanvasVisualizer::receptionStarted(), inet::visualizer::MediumCanvasVisualizer::refreshDisplay(), inet::visualizer::MediumCanvasVisualizer::transmissionAdded(), inet::visualizer::MediumCanvasVisualizer::transmissionEnded(), inet::visualizer::MediumCanvasVisualizer::transmissionRemoved(), and inet::visualizer::MediumCanvasVisualizer::transmissionStarted().

bool inet::visualizer::MediumVisualizerBase::displayTransmissions = false

protected

Referenced by initialize(), inet::visualizer::MediumCanvasVisualizer::radioAdded(), inet::visualizer::MediumCanvasVisualizer::transmissionEnded(), and inet::visualizer::MediumCanvasVisualizer::transmissionStarted().

InterfaceFilter inet::visualizer::MediumVisualizerBase::interfaceFilter

protected

Referenced by handleParameterChange(), initialize(), and matchesTransmission().

cFigure::Color inet::visualizer::MediumVisualizerBase::interferenceRangeLineColor

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

cFigure::LineStyle inet::visualizer::MediumVisualizerBase::interferenceRangeLineStyle

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

double inet::visualizer::MediumVisualizerBase::interferenceRangeLineWidth = NaN

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

NetworkNodeFilter inet::visualizer::MediumVisualizerBase::networkNodeFilter

protected

Referenced by handleParameterChange(), initialize(), matchesTransmission(), inet::visualizer::MediumCanvasVisualizer::radioAdded(), inet::visualizer::MediumCanvasVisualizer::receptionEnded(), and inet::visualizer::MediumCanvasVisualizer::receptionStarted().

PacketFilter inet::visualizer::MediumVisualizerBase::packetFilter

protected

Referenced by handleParameterChange(), initialize(), and matchesTransmission().

IRadioMedium* inet::visualizer::MediumVisualizerBase::radioMedium = nullptr

protected

Referenced by initialize(), inet::visualizer::MediumCanvasVisualizer::initialize(), isSignalPropagationInProgress(), inet::visualizer::MediumCanvasVisualizer::receptionStarted(), and inet::visualizer::MediumCanvasVisualizer::refreshSignalFigure().

Displacement inet::visualizer::MediumVisualizerBase::receptionDisplacementHint

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

double inet::visualizer::MediumVisualizerBase::receptionDisplacementPriority

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

double inet::visualizer::MediumVisualizerBase::signalAnimationSpeedChangeTime = NaN

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

ColorSet inet::visualizer::MediumVisualizerBase::signalColorSet

protected

Referenced by inet::visualizer::MediumCanvasVisualizer::createSignalFigure(), and initialize().

double inet::visualizer::MediumVisualizerBase::signalPropagationAdditionalTime = NaN

protected

Referenced by initialize(), and isSignalPropagationInProgress().

double inet::visualizer::MediumVisualizerBase::signalPropagationAnimationSpeed = NaN

protected

Referenced by handleParameterChange(), initialize(), inet::visualizer::MediumCanvasVisualizer::refreshSignalFigure(), and inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

double inet::visualizer::MediumVisualizerBase::signalPropagationAnimationTime = NaN

protected

Referenced by initialize().

double inet::visualizer::MediumVisualizerBase::signalTransmissionAnimationSpeed = NaN

protected

Referenced by handleParameterChange(), initialize(), and inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

double inet::visualizer::MediumVisualizerBase::signalTransmissionAnimationTime = NaN

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::setAnimationSpeed().

Displacement inet::visualizer::MediumVisualizerBase::transmissionDisplacementHint

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

double inet::visualizer::MediumVisualizerBase::transmissionDisplacementPriority

protected

Referenced by initialize(), and inet::visualizer::MediumCanvasVisualizer::radioAdded().

---

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

• MediumVisualizerBase.h
• MediumVisualizerBase.cc