inet::visualizer::RoutingTableVisualizerBase Class Reference

#include <RoutingTableVisualizerBase.h>

Inheritance diagram for inet::visualizer::RoutingTableVisualizerBase:

Classes
class	DirectiveResolver
class	RouteVisualization

Public Member Functions
virtual	~RoutingTableVisualizerBase ()
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *obj, 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 const RouteVisualization *	createRouteVisualization (IPv4Route *route, cModule *node, cModule *nextHop) const =0
virtual const RouteVisualization *	getRouteVisualization (IPv4Route *route, int nodeModuleId, int nextHopModuleId)
virtual void	addRouteVisualization (const RouteVisualization *routeVisualization)
virtual void	removeRouteVisualization (const RouteVisualization *routeVisualization)
virtual std::vector< IPv4Address >	getDestinations ()
virtual void	addRouteVisualizations (IIPv4RoutingTable *routingTable)
virtual void	removeRouteVisualizations (IIPv4RoutingTable *routingTable)
virtual void	removeAllRouteVisualizations ()
virtual void	updateRouteVisualizations (IIPv4RoutingTable *routingTable)
virtual void	updateAllRouteVisualizations ()
virtual std::string	getRouteVisualizationText (const IPv4Route *route) const
virtual void	refreshRouteVisualization (const RouteVisualization *routeVisualization) 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
LineManager *	lineManager = nullptr
std::map< std::tuple< const IPv4Route *, int, int >, const RouteVisualization * >	routeVisualizations
Parameters
bool	displayRoutingTables = false
bool	displayRoutesIndividually = false
bool	displayLabels = false
NetworkNodeFilter	destinationFilter
NetworkNodeFilter	nodeFilter
cFigure::Color	lineColor
cFigure::LineStyle	lineStyle
double	lineShift = NaN
const char *	lineShiftMode = nullptr
double	lineWidth = NaN
double	lineContactSpacing = NaN
const char *	lineContactMode = nullptr
StringFormat	labelFormat
cFigure::Font	labelFont
cFigure::Color	labelColor
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizerTargetModule = nullptr
const char *	tags = nullptr

Constructor & Destructor Documentation

inet::visualizer::RoutingTableVisualizerBase::~RoutingTableVisualizerBase ( )

virtual

{
    if (displayRoutingTables)
        unsubscribe();
}

Member Function Documentation

void inet::visualizer::RoutingTableVisualizerBase::addRouteVisualization ( const RouteVisualization *  routeVisualization )

protectedvirtual

Reimplemented in inet::visualizer::RoutingTableCanvasVisualizer.

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::addRouteVisualization(), and addRouteVisualizations().

{
    auto key = std::make_tuple(routeVisualization->route, routeVisualization->sourceModuleId, routeVisualization->destinationModuleId);
    routeVisualizations[key] = routeVisualization;
}

void inet::visualizer::RoutingTableVisualizerBase::addRouteVisualizations ( IIPv4RoutingTable *  routingTable )

protectedvirtual

Referenced by updateAllRouteVisualizations(), and updateRouteVisualizations().

{
    L3AddressResolver addressResolver;
    auto node = getContainingNode(check_and_cast<cModule *>(routingTable));
    for (auto destination : getDestinations()) {
        if (!routingTable->isLocalAddress(destination)) {
            auto route = routingTable->findBestMatchingRoute(destination);
            if (route != nullptr) {
                auto gateway = route->getGateway();
                auto nextHop = addressResolver.findHostWithAddress(gateway.isUnspecified() ? destination : gateway);
                if (nextHop != nullptr) {
                    auto routeVisualization = getRouteVisualization(displayRoutesIndividually ? route : nullptr, node->getId(), nextHop->getId());
                    if (routeVisualization == nullptr)
                        addRouteVisualization(createRouteVisualization(displayRoutesIndividually ? route : nullptr, node, nextHop));
                    else {
                        routeVisualization->numRoutes++;
                        refreshRouteVisualization(routeVisualization);
                    }
                }
            }
        }
    }
}

virtual const RouteVisualization* inet::visualizer::RoutingTableVisualizerBase::createRouteVisualization ( IPv4Route *  route, cModule *  node, cModule *  nextHop  ) const

protectedpure virtual

Implemented in inet::visualizer::RoutingTableOsgVisualizer, and inet::visualizer::RoutingTableCanvasVisualizer.

Referenced by addRouteVisualizations().

std::vector< IPv4Address > inet::visualizer::RoutingTableVisualizerBase::getDestinations ( )

protectedvirtual

Referenced by addRouteVisualizations().

{
    L3AddressResolver addressResolver;
    std::vector<IPv4Address> destinations;
    for (cModule::SubmoduleIterator it(getSystemModule()); !it.end(); it++) {
        auto networkNode = *it;
        if (isNetworkNode(networkNode) && destinationFilter.matches(networkNode)) {
            auto interfaceTable = addressResolver.findInterfaceTableOf(networkNode);
            for (int i = 0; i < interfaceTable->getNumInterfaces(); i++) {
                auto interface = interfaceTable->getInterface(i);
                if (interface->ipv4Data() != nullptr) {
                    auto address = interface->ipv4Data()->getIPAddress();
                    if (!address.isUnspecified())
                        destinations.push_back(address);
                }
            }
        }
    }
    return destinations;
}

const RoutingTableVisualizerBase::RouteVisualization * inet::visualizer::RoutingTableVisualizerBase::getRouteVisualization ( IPv4Route *  route, int  nodeModuleId, int  nextHopModuleId  )

protectedvirtual

Referenced by addRouteVisualizations().

{
    auto key = std::make_tuple(route, nodeModuleId, nextHopModuleId);
    auto it = routeVisualizations.find(key);
    return it == routeVisualizations.end() ? nullptr : it->second;
}

std::string inet::visualizer::RoutingTableVisualizerBase::getRouteVisualizationText ( const IPv4Route *  route ) const

protectedvirtual

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::refreshRouteVisualization().

{
    DirectiveResolver directiveResolver(route);
    return labelFormat.formatString(&directiveResolver);
}

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

overrideprotectedvirtual

{
    if (name != nullptr) {
        if (!strcmp(name, "destinationFilter"))
            destinationFilter.setPattern(par("destinationFilter"));
        else if (!strcmp(name, "nodeFilter"))
            nodeFilter.setPattern(par("nodeFilter"));
        else if (!strcmp(name, "labelFormat"))
            labelFormat.parseFormat(par("labelFormat"));
        updateAllRouteVisualizations();
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::RoutingTableOsgVisualizer, and inet::visualizer::RoutingTableCanvasVisualizer.

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

{
    VisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        displayRoutingTables = par("displayRoutingTables");
        displayRoutesIndividually = par("displayRoutesIndividually");
        displayLabels = par("displayLabels");
        destinationFilter.setPattern(par("destinationFilter"));
        nodeFilter.setPattern(par("nodeFilter"));
        lineColor = cFigure::Color(par("lineColor"));
        lineStyle = cFigure::parseLineStyle(par("lineStyle"));
        lineWidth = par("lineWidth");
        lineShift = par("lineShift");
        lineShiftMode = par("lineShiftMode");
        lineContactSpacing = par("lineContactSpacing");
        lineContactMode = par("lineContactMode");
        lineManager = LineManager::getLineManager(visualizerTargetModule->getCanvas());
        labelFormat.parseFormat(par("labelFormat"));
        labelFont = cFigure::parseFont(par("labelFont"));
        labelColor = cFigure::Color(par("labelColor"));
        if (displayRoutingTables)
            subscribe();
    }
}

void inet::visualizer::RoutingTableVisualizerBase::receiveSignal ( cComponent *  source, simsignal_t  signal, cObject *  obj, cObject *  details  )

overridevirtual

{
    Enter_Method_Silent();
    if (signal == NF_ROUTE_ADDED || signal == NF_ROUTE_DELETED || signal == NF_ROUTE_CHANGED) {
        auto routingTable = check_and_cast<IIPv4RoutingTable *>(source);
        auto networkNode = getContainingNode(check_and_cast<cModule *>(source));
        if (nodeFilter.matches(networkNode))
            updateRouteVisualizations(routingTable);
    }
    else if (signal == NF_INTERFACE_IPv4CONFIG_CHANGED)
        updateAllRouteVisualizations();
    else
        throw cRuntimeError("Unknown signal");
}

virtual void inet::visualizer::RoutingTableVisualizerBase::refreshRouteVisualization ( const RouteVisualization *  routeVisualization ) const

protectedpure virtual

Implemented in inet::visualizer::RoutingTableCanvasVisualizer, and inet::visualizer::RoutingTableOsgVisualizer.

Referenced by addRouteVisualizations().

void inet::visualizer::RoutingTableVisualizerBase::removeAllRouteVisualizations ( )

protectedvirtual

Referenced by updateAllRouteVisualizations().

{
    std::vector<const RouteVisualization *> removedRouteVisualizations;
    for (auto it : routeVisualizations)
        removedRouteVisualizations.push_back(it.second);
    for (auto it : removedRouteVisualizations) {
        removeRouteVisualization(it);
        delete it;
    }
}

void inet::visualizer::RoutingTableVisualizerBase::removeRouteVisualization ( const RouteVisualization *  routeVisualization )

protectedvirtual

Reimplemented in inet::visualizer::RoutingTableCanvasVisualizer.

Referenced by removeAllRouteVisualizations(), inet::visualizer::RoutingTableCanvasVisualizer::removeRouteVisualization(), and removeRouteVisualizations().

{
    auto key = std::make_tuple(routeVisualization->route, routeVisualization->sourceModuleId, routeVisualization->destinationModuleId);
    routeVisualizations.erase(routeVisualizations.find(key));
}

void inet::visualizer::RoutingTableVisualizerBase::removeRouteVisualizations ( IIPv4RoutingTable *  routingTable )

protectedvirtual

Referenced by updateRouteVisualizations().

{
    auto networkNode = getContainingNode(check_and_cast<cModule *>(routingTable));
    std::vector<const RouteVisualization *> removedRouteVisualizations;
    for (auto it : routeVisualizations)
        if (std::get<1>(it.first) == networkNode->getId() && it.second)
            removedRouteVisualizations.push_back(it.second);
    for (auto it : removedRouteVisualizations) {
        removeRouteVisualization(it);
        delete it;
    }
}

void inet::visualizer::RoutingTableVisualizerBase::subscribe ( )

protectedvirtual

Referenced by initialize().

{
    auto subscriptionModule = getModuleFromPar<cModule>(par("subscriptionModule"), this);
    subscriptionModule->subscribe(NF_ROUTE_ADDED, this);
    subscriptionModule->subscribe(NF_ROUTE_DELETED, this);
    subscriptionModule->subscribe(NF_ROUTE_CHANGED, this);
    subscriptionModule->subscribe(NF_INTERFACE_IPv4CONFIG_CHANGED, this);
}

void inet::visualizer::RoutingTableVisualizerBase::unsubscribe ( )

protectedvirtual

Referenced by ~RoutingTableVisualizerBase().

{
    // 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_ROUTE_ADDED, this);
        subscriptionModule->unsubscribe(NF_ROUTE_DELETED, this);
        subscriptionModule->unsubscribe(NF_ROUTE_CHANGED, this);
        subscriptionModule->unsubscribe(NF_INTERFACE_IPv4CONFIG_CHANGED, this);
    }
}

void inet::visualizer::RoutingTableVisualizerBase::updateAllRouteVisualizations ( )

protectedvirtual

Referenced by handleParameterChange(), and receiveSignal().

{
    removeAllRouteVisualizations();
    for (cModule::SubmoduleIterator it(getSystemModule()); !it.end(); it++) {
        auto networkNode = *it;
        if (isNetworkNode(networkNode) && nodeFilter.matches(networkNode)) {
            L3AddressResolver addressResolver;
            auto routingTable = addressResolver.findIPv4RoutingTableOf(networkNode);
            if (routingTable != nullptr)
                addRouteVisualizations(routingTable);
        }
    }
}

void inet::visualizer::RoutingTableVisualizerBase::updateRouteVisualizations ( IIPv4RoutingTable *  routingTable )

protectedvirtual

Referenced by receiveSignal().

{
    removeRouteVisualizations(routingTable);
    addRouteVisualizations(routingTable);
}

Member Data Documentation

NetworkNodeFilter inet::visualizer::RoutingTableVisualizerBase::destinationFilter

protected

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

bool inet::visualizer::RoutingTableVisualizerBase::displayLabels = false

protected

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::createRouteVisualization(), and initialize().

bool inet::visualizer::RoutingTableVisualizerBase::displayRoutesIndividually = false

protected

Referenced by addRouteVisualizations(), initialize(), and inet::visualizer::RoutingTableCanvasVisualizer::refreshRouteVisualization().

bool inet::visualizer::RoutingTableVisualizerBase::displayRoutingTables = false

protected

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

cFigure::Color inet::visualizer::RoutingTableVisualizerBase::labelColor

protected

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::createRouteVisualization(), and initialize().

cFigure::Font inet::visualizer::RoutingTableVisualizerBase::labelFont

protected

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::createRouteVisualization(), and initialize().

StringFormat inet::visualizer::RoutingTableVisualizerBase::labelFormat

protected

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

cFigure::Color inet::visualizer::RoutingTableVisualizerBase::lineColor

protected

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::createRouteVisualization(), and initialize().

const char* inet::visualizer::RoutingTableVisualizerBase::lineContactMode = nullptr

protected

Referenced by initialize(), and inet::visualizer::RoutingTableCanvasVisualizer::refreshDisplay().

double inet::visualizer::RoutingTableVisualizerBase::lineContactSpacing = NaN

protected

Referenced by initialize(), and inet::visualizer::RoutingTableCanvasVisualizer::refreshDisplay().

LineManager* inet::visualizer::RoutingTableVisualizerBase::lineManager = nullptr

protected

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::addRouteVisualization(), initialize(), inet::visualizer::RoutingTableCanvasVisualizer::refreshDisplay(), and inet::visualizer::RoutingTableCanvasVisualizer::removeRouteVisualization().

double inet::visualizer::RoutingTableVisualizerBase::lineShift = NaN

protected

Referenced by initialize(), and inet::visualizer::RoutingTableCanvasVisualizer::refreshDisplay().

const char* inet::visualizer::RoutingTableVisualizerBase::lineShiftMode = nullptr

protected

Referenced by initialize(), and inet::visualizer::RoutingTableCanvasVisualizer::refreshDisplay().

cFigure::LineStyle inet::visualizer::RoutingTableVisualizerBase::lineStyle

protected

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::createRouteVisualization(), and initialize().

double inet::visualizer::RoutingTableVisualizerBase::lineWidth = NaN

protected

Referenced by inet::visualizer::RoutingTableCanvasVisualizer::createRouteVisualization(), and initialize().

NetworkNodeFilter inet::visualizer::RoutingTableVisualizerBase::nodeFilter

protected

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

std::map<std::tuple<const IPv4Route *, int, int>, const RouteVisualization *> inet::visualizer::RoutingTableVisualizerBase::routeVisualizations

protected

Referenced by addRouteVisualization(), getRouteVisualization(), inet::visualizer::RoutingTableCanvasVisualizer::refreshDisplay(), removeAllRouteVisualizations(), removeRouteVisualization(), and removeRouteVisualizations().

---

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

• RoutingTableVisualizerBase.h
• RoutingTableVisualizerBase.cc