inet::visualizer::InterfaceTableVisualizerBase Class Reference

#include <InterfaceTableVisualizerBase.h>

Inheritance diagram for inet::visualizer::InterfaceTableVisualizerBase:

Classes
class	DirectiveResolver
class	InterfaceVisualization

Public Member Functions
virtual	~InterfaceTableVisualizerBase ()
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	subscribe ()
virtual void	unsubscribe ()
virtual InterfaceVisualization *	createInterfaceVisualization (cModule *networkNode, InterfaceEntry *interfaceEntry)=0
virtual const InterfaceVisualization *	getInterfaceVisualization (cModule *networkNode, InterfaceEntry *interfaceEntry)
virtual void	addInterfaceVisualization (const InterfaceVisualization *interfaceVisualization)
virtual void	addAllInterfaceVisualizations ()
virtual void	removeInterfaceVisualization (const InterfaceVisualization *interfaceVisualization)
virtual void	removeAllInterfaceVisualizations ()
virtual void	updateAllInterfaceVisualizations ()
virtual std::string	getVisualizationText (const InterfaceEntry *interfaceEntry)
virtual void	refreshInterfaceVisualization (const InterfaceVisualization *interfaceVisualization, const InterfaceEntry *interfaceEntry)=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< std::pair< int, int >, const InterfaceVisualization * >	interfaceVisualizations
Parameters
bool	displayInterfaceTables = false
bool	displayWiredInterfacesAtConnections = false
bool	displayBackground = false
NetworkNodeFilter	nodeFilter
InterfaceFilter	interfaceFilter
StringFormat	format
Displacement	displacementHint
double	displacementPriority
cFigure::Font	font
cFigure::Color	textColor
cFigure::Color	backgroundColor
double	opacity = NaN
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizerTargetModule = nullptr
const char *	tags = nullptr

Constructor & Destructor Documentation

inet::visualizer::InterfaceTableVisualizerBase::~InterfaceTableVisualizerBase ( )

virtual

{
    if (displayInterfaceTables)
        unsubscribe();
}

Member Function Documentation

void inet::visualizer::InterfaceTableVisualizerBase::addAllInterfaceVisualizations ( )

protectedvirtual

Referenced by updateAllInterfaceVisualizations().

{
    for (cModule::SubmoduleIterator it(getSystemModule()); !it.end(); it++) {
        auto networkNode = *it;
        if (isNetworkNode(networkNode) && nodeFilter.matches(networkNode)) {
            L3AddressResolver addressResolver;
            auto interfaceTable = addressResolver.findInterfaceTableOf(networkNode);
            if (interfaceTable != nullptr) {
                for (int i = 0; i < interfaceTable->getNumInterfaces(); i++) {
                    auto interfaceEntry = interfaceTable->getInterface(i);
                    if (interfaceEntry != nullptr && interfaceFilter.matches(interfaceEntry)) {
                        auto interfaceVisualization = createInterfaceVisualization(networkNode, interfaceEntry);
                        addInterfaceVisualization(interfaceVisualization);
                    }
                }
            }
        }
    }
}

void inet::visualizer::InterfaceTableVisualizerBase::addInterfaceVisualization ( const InterfaceVisualization *  interfaceVisualization )

protectedvirtual

Reimplemented in inet::visualizer::InterfaceTableCanvasVisualizer.

Referenced by addAllInterfaceVisualizations(), inet::visualizer::InterfaceTableCanvasVisualizer::addInterfaceVisualization(), and receiveSignal().

{
    auto key = std::pair<int, int>(interfaceVisualization->networkNodeId, interfaceVisualization->interfaceId);
    interfaceVisualizations[key] = interfaceVisualization;
}

virtual InterfaceVisualization* inet::visualizer::InterfaceTableVisualizerBase::createInterfaceVisualization ( cModule *  networkNode, InterfaceEntry *  interfaceEntry  )

protectedpure virtual

Implemented in inet::visualizer::InterfaceTableOsgVisualizer, and inet::visualizer::InterfaceTableCanvasVisualizer.

Referenced by addAllInterfaceVisualizations(), and receiveSignal().

const InterfaceTableVisualizerBase::InterfaceVisualization * inet::visualizer::InterfaceTableVisualizerBase::getInterfaceVisualization ( cModule *  networkNode, InterfaceEntry *  interfaceEntry  )

protectedvirtual

Referenced by receiveSignal().

{
    auto key = std::pair<int, int>(networkNode->getId(), interfaceEntry->getInterfaceId());
    auto it = interfaceVisualizations.find(key);
    return it == interfaceVisualizations.end() ? nullptr : it->second;
}

std::string inet::visualizer::InterfaceTableVisualizerBase::getVisualizationText ( const InterfaceEntry *  interfaceEntry )

protectedvirtual

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::addInterfaceVisualization(), inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization(), and inet::visualizer::InterfaceTableCanvasVisualizer::refreshInterfaceVisualization().

{
    DirectiveResolver directiveResolver(interfaceEntry);
    return format.formatString(&directiveResolver);
}

void inet::visualizer::InterfaceTableVisualizerBase::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, "format"))
            format.parseFormat(par("format"));
        updateAllInterfaceVisualizations();
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::InterfaceTableOsgVisualizer, and inet::visualizer::InterfaceTableCanvasVisualizer.

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

{
    VisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        displayInterfaceTables = par("displayInterfaceTables");
        displayWiredInterfacesAtConnections = par("displayWiredInterfacesAtConnections");
        displayBackground = par("displayBackground");
        nodeFilter.setPattern(par("nodeFilter"));
        interfaceFilter.setPattern(par("interfaceFilter"));
        format.parseFormat(par("format"));
        displacementHint = parseDisplacement(par("displacementHint"));
        displacementPriority = par("displacementPriority");
        font = cFigure::parseFont(par("font"));
        textColor = cFigure::parseColor(par("textColor"));
        backgroundColor = cFigure::parseColor(par("backgroundColor"));
        opacity = par("opacity");
        if (displayInterfaceTables)
            subscribe();
    }
}

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

overridevirtual

{
    Enter_Method_Silent();
    if (signal == NF_INTERFACE_CREATED) {
        auto networkNode = getContainingNode(static_cast<cModule *>(source));
        if (nodeFilter.matches(networkNode)) {
            auto interfaceEntry = static_cast<InterfaceEntry *>(object);
            if (interfaceFilter.matches(interfaceEntry)) {
                auto interfaceVisualization = createInterfaceVisualization(networkNode, interfaceEntry);
                addInterfaceVisualization(interfaceVisualization);
            }
        }
    }
    else if (signal == NF_INTERFACE_DELETED) {
        auto networkNode = getContainingNode(static_cast<cModule *>(source));
        if (nodeFilter.matches(networkNode)) {
            auto interfaceEntry = static_cast<InterfaceEntry *>(object);
            if (interfaceFilter.matches(interfaceEntry)) {
                auto interfaceVisualization = getInterfaceVisualization(networkNode, interfaceEntry);
                removeInterfaceVisualization(interfaceVisualization);
            }
        }
    }
    else if (signal == NF_INTERFACE_CONFIG_CHANGED || signal == NF_INTERFACE_IPv4CONFIG_CHANGED) {
        auto networkNode = getContainingNode(static_cast<cModule *>(source));
        if (object != nullptr && nodeFilter.matches(networkNode)) {
            auto interfaceEntryDetails = static_cast<InterfaceEntryChangeDetails *>(object);
            auto interfaceEntry = interfaceEntryDetails->getInterfaceEntry();
            auto fieldId = interfaceEntryDetails->getFieldId();
            if (fieldId == InterfaceEntry::F_IPV4_DATA
#ifdef WITH_IPv4
                    || fieldId == IPv4InterfaceData::F_IP_ADDRESS
#endif // WITH_IPv4
                    ) {
                if (interfaceFilter.matches(interfaceEntry)) {
                    auto interfaceVisualization = getInterfaceVisualization(networkNode, interfaceEntry);
                    if (interfaceVisualization == nullptr) {
                        interfaceVisualization = createInterfaceVisualization(networkNode, interfaceEntry);
                        addInterfaceVisualization(interfaceVisualization);
                    }
                    else
                        refreshInterfaceVisualization(interfaceVisualization, interfaceEntry);
                }
            }
        }
    }
    else
        throw cRuntimeError("Unknown signal");
}

virtual void inet::visualizer::InterfaceTableVisualizerBase::refreshInterfaceVisualization ( const InterfaceVisualization *  interfaceVisualization, const InterfaceEntry *  interfaceEntry  )

protectedpure virtual

Implemented in inet::visualizer::InterfaceTableOsgVisualizer, and inet::visualizer::InterfaceTableCanvasVisualizer.

Referenced by receiveSignal().

void inet::visualizer::InterfaceTableVisualizerBase::removeAllInterfaceVisualizations ( )

protectedvirtual

Referenced by updateAllInterfaceVisualizations().

{
    std::vector<const InterfaceVisualization *> removedIntefaceVisualizations;
    for (auto it : interfaceVisualizations)
        removedIntefaceVisualizations.push_back(it.second);
    for (auto it : removedIntefaceVisualizations) {
        removeInterfaceVisualization(it);
        delete it;
    }
}

void inet::visualizer::InterfaceTableVisualizerBase::removeInterfaceVisualization ( const InterfaceVisualization *  interfaceVisualization )

protectedvirtual

Reimplemented in inet::visualizer::InterfaceTableCanvasVisualizer.

Referenced by receiveSignal(), removeAllInterfaceVisualizations(), and inet::visualizer::InterfaceTableCanvasVisualizer::removeInterfaceVisualization().

{
    auto key = std::pair<int, int>(interfaceVisualization->networkNodeId, interfaceVisualization->interfaceId);
    interfaceVisualizations.erase(interfaceVisualizations.find(key));
}

void inet::visualizer::InterfaceTableVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

{
    auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
    subscriptionModule->subscribe(NF_INTERFACE_CREATED, this);
    subscriptionModule->subscribe(NF_INTERFACE_DELETED, this);
    subscriptionModule->subscribe(NF_INTERFACE_CONFIG_CHANGED, this);
    subscriptionModule->subscribe(NF_INTERFACE_IPv4CONFIG_CHANGED, this);
}

void inet::visualizer::InterfaceTableVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~InterfaceTableVisualizerBase().

{
    // 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_INTERFACE_CREATED, this);
        subscriptionModule->unsubscribe(NF_INTERFACE_DELETED, this);
        subscriptionModule->unsubscribe(NF_INTERFACE_CONFIG_CHANGED, this);
        subscriptionModule->unsubscribe(NF_INTERFACE_IPv4CONFIG_CHANGED, this);
    }
}

void inet::visualizer::InterfaceTableVisualizerBase::updateAllInterfaceVisualizations ( )

protectedvirtual

Referenced by handleParameterChange().

{
    removeAllInterfaceVisualizations();
    addAllInterfaceVisualizations();
}

Member Data Documentation

cFigure::Color inet::visualizer::InterfaceTableVisualizerBase::backgroundColor

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization(), and initialize().

Displacement inet::visualizer::InterfaceTableVisualizerBase::displacementHint

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::addInterfaceVisualization(), and initialize().

double inet::visualizer::InterfaceTableVisualizerBase::displacementPriority

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::addInterfaceVisualization(), and initialize().

bool inet::visualizer::InterfaceTableVisualizerBase::displayBackground = false

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization(), and initialize().

bool inet::visualizer::InterfaceTableVisualizerBase::displayInterfaceTables = false

protected

Referenced by initialize(), and ~InterfaceTableVisualizerBase().

bool inet::visualizer::InterfaceTableVisualizerBase::displayWiredInterfacesAtConnections = false

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::addInterfaceVisualization(), inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization(), initialize(), inet::visualizer::InterfaceTableCanvasVisualizer::refreshInterfaceVisualization(), and inet::visualizer::InterfaceTableCanvasVisualizer::removeInterfaceVisualization().

cFigure::Font inet::visualizer::InterfaceTableVisualizerBase::font

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization(), and initialize().

StringFormat inet::visualizer::InterfaceTableVisualizerBase::format

protected

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

InterfaceFilter inet::visualizer::InterfaceTableVisualizerBase::interfaceFilter

protected

Referenced by addAllInterfaceVisualizations(), handleParameterChange(), initialize(), and receiveSignal().

std::map<std::pair<int, int>, const InterfaceVisualization *> inet::visualizer::InterfaceTableVisualizerBase::interfaceVisualizations

protected

Referenced by addInterfaceVisualization(), getInterfaceVisualization(), removeAllInterfaceVisualizations(), and removeInterfaceVisualization().

NetworkNodeFilter inet::visualizer::InterfaceTableVisualizerBase::nodeFilter

protected

Referenced by addAllInterfaceVisualizations(), handleParameterChange(), initialize(), and receiveSignal().

double inet::visualizer::InterfaceTableVisualizerBase::opacity = NaN

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization(), and initialize().

cFigure::Color inet::visualizer::InterfaceTableVisualizerBase::textColor

protected

Referenced by inet::visualizer::InterfaceTableCanvasVisualizer::createInterfaceVisualization(), and initialize().

---

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

• InterfaceTableVisualizerBase.h
• InterfaceTableVisualizerBase.cc