inet::visualizer::RoutingTableCanvasVisualizer Class Reference

#include <RoutingTableCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::RoutingTableCanvasVisualizer:

Classes
class	RouteCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	refreshDisplay () const override
virtual const RouteVisualization *	createRouteVisualization (Ipv4Route *route, cModule *node, cModule *nextHop) const override
virtual void	addRouteVisualization (const RouteVisualization *routeVisualization) override
virtual void	removeRouteVisualization (const RouteVisualization *routeVisualization) override
virtual void	refreshRouteVisualization (const RouteVisualization *routeVisualization) const override
Protected Member Functions inherited from inet::visualizer::RoutingTableVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	preDelete (cComponent *root) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual const RouteVisualization *	getRouteVisualization (Ipv4Route *route, int nodeModuleId, int nextHopModuleId)
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
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
double	zIndex = NaN
const CanvasProjection *	canvasProjection = nullptr
cGroupFigure *	routeGroup = nullptr
Protected Attributes inherited from inet::visualizer::RoutingTableVisualizerBase
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
LineManager *	lineManager = nullptr
std::map< std::tuple< Ipv4Address, int, int >, const RouteVisualization * >	routeVisualizations
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizationTargetModule = nullptr
cModule *	visualizationSubjectModule = nullptr
const char *	tags = nullptr

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

Member Function Documentation

addRouteVisualization()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::RoutingTableVisualizerBase.

{
    RoutingTableVisualizerBase::addRouteVisualization(routeVisualization);
    auto routeCanvasVisualization = static_cast<const RouteCanvasVisualization *>(routeVisualization);
    lineManager->addModuleLine(routeVisualization);
    routeGroup->addFigure(routeCanvasVisualization->figure);
}

createRouteVisualization()

const RoutingTableVisualizerBase::RouteVisualization * inet::visualizer::RoutingTableCanvasVisualizer::createRouteVisualization ( Ipv4Route *  route, cModule *  node, cModule *  nextHop  ) const

overrideprotectedvirtual

Implements inet::visualizer::RoutingTableVisualizerBase.

{
    auto figure = new LabeledLineFigure("routing entry");
    figure->setTags((std::string("route ") + tags).c_str());
    figure->setTooltip("This arrow represents a route in a routing table");
    figure->setAssociatedObject(route);
    auto lineFigure = figure->getLineFigure();
    lineFigure->setEndArrowhead(cFigure::ARROW_TRIANGLE);
    lineFigure->setLineWidth(lineWidth);
    lineFigure->setLineColor(lineColor);
    lineFigure->setLineStyle(lineStyle);
    auto labelFigure = figure->getLabelFigure();
    labelFigure->setFont(labelFont);
    labelFigure->setColor(labelColor);
    labelFigure->setVisible(displayLabels);
    auto routeVisualization = new RouteCanvasVisualization(figure, route, node->getId(), nextHop->getId());
    routeVisualization->shiftPriority = 0.5;
    refreshRouteVisualization(routeVisualization);
    return routeVisualization;
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::RoutingTableVisualizerBase.

{
    RoutingTableVisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        zIndex = par("zIndex");
        auto canvas = visualizationTargetModule->getCanvas();
        lineManager = LineManager::getCanvasLineManager(canvas);
        canvasProjection = CanvasProjection::getCanvasProjection(canvas);
        routeGroup = new cGroupFigure("routing tables");
        routeGroup->setZIndex(zIndex);
        canvas->addFigure(routeGroup);
    }
}

refreshDisplay()

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

overrideprotectedvirtual

{
    auto simulation = getSimulation();
    for (auto it : routeVisualizations) {
        auto routeVisualization = it.second;
        auto routeCanvasVisualization = static_cast<const RouteCanvasVisualization *>(routeVisualization);
        auto figure = routeCanvasVisualization->figure;
        auto sourceModule = simulation->getModule(routeVisualization->sourceModuleId);
        auto destinationModule = simulation->getModule(routeVisualization->destinationModuleId);
        auto sourcePosition = getContactPosition(sourceModule, getPosition(destinationModule), lineContactMode, lineContactSpacing);
        auto destinationPosition = getContactPosition(destinationModule, getPosition(sourceModule), lineContactMode, lineContactSpacing);
        auto shift = lineManager->getLineShift(routeVisualization->sourceModuleId, routeVisualization->destinationModuleId, sourcePosition, destinationPosition, lineShiftMode, routeVisualization->shiftOffset) * lineShift;
        figure->setStart(canvasProjection->computeCanvasPoint(sourcePosition + shift));
        figure->setEnd(canvasProjection->computeCanvasPoint(destinationPosition + shift));
    }
}

refreshRouteVisualization()

void inet::visualizer::RoutingTableCanvasVisualizer::refreshRouteVisualization ( const RouteVisualization *  routeVisualization ) const

overrideprotectedvirtual

Implements inet::visualizer::RoutingTableVisualizerBase.

{
    auto routeCanvasVisualization = static_cast<const RouteCanvasVisualization *>(routeVisualization);
    auto labelFigure = routeCanvasVisualization->figure->getLabelFigure();
    auto text = displayRoutesIndividually ? getRouteVisualizationText(routeCanvasVisualization->route) : std::to_string(routeVisualization->numRoutes) + (routeVisualization->numRoutes > 1 ? " routes" : " route");
    labelFigure->setText(text.c_str());
}

Referenced by createRouteVisualization().

removeRouteVisualization()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::RoutingTableVisualizerBase.

{
    RoutingTableVisualizerBase::removeRouteVisualization(routeVisualization);
    auto routeCanvasVisualization = static_cast<const RouteCanvasVisualization *>(routeVisualization);
    lineManager->removeModuleLine(routeVisualization);
    routeGroup->removeFigure(routeCanvasVisualization->figure);
}

Member Data Documentation

canvasProjection

const CanvasProjection* inet::visualizer::RoutingTableCanvasVisualizer::canvasProjection = nullptr

protected

Referenced by initialize(), and refreshDisplay().

routeGroup

cGroupFigure* inet::visualizer::RoutingTableCanvasVisualizer::routeGroup = nullptr

protected

Referenced by addRouteVisualization(), initialize(), and removeRouteVisualization().

zIndex

double inet::visualizer::RoutingTableCanvasVisualizer::zIndex = NaN

protected

Referenced by initialize().

---

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

• RoutingTableCanvasVisualizer.h
• RoutingTableCanvasVisualizer.cc