RoutingTableVisualizer¶

compound module RoutingTableVisualizer

Integrates canvas and osg routing table visualizers into a single module.

Usage diagram¶

Inheritance diagram¶

Parameters¶

Name	Type	Default value	Description
visualizationTargetModule	string	“^”
visualizationSubjectModule	string	“^”

Properties¶

Name	Value	Description
display	i=block/app

Unassigned submodule parameters¶

Name	Type	Default value	Description
canvasVisualizer.displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
canvasVisualizer.visualizationTargetModule	string	“^”	Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
canvasVisualizer.visualizationSubjectModule	string	“^”	Module path relative to the visualizer which determines what part of the simulation model the visualizer displays in the user interface, parent module by default
canvasVisualizer.tags	string	“”	Tag added to each visualization for disambiguation in the runtime environment
canvasVisualizer.displayRoutingTables	bool	false	Displays routing table data, disabled by default
canvasVisualizer.displayRoutesIndividually	bool	true	Displays routes between the same network nodes individually, enabled by default
canvasVisualizer.displayLabels	bool	true	Displays labels on arrows, enabled by default
canvasVisualizer.destinationFilter	string	“*”	Determines the destinations that are considered, matches all destinations by default
canvasVisualizer.nodeFilter	string	“*”	Determines the nodes that are considered, matches all nodes by default
canvasVisualizer.multicastSourceNodeFilter	string	“*”	Determines the multicast source nodes that are considered, matches all nodes by default
canvasVisualizer.multicastSourceAddressFilter	string	“*”	Determines the multicast source addresses that are considered, matches all addresses by default
canvasVisualizer.multicastGroupFilter	string	“*”	Determines the multicast group addresses that are considered, matches all group addresses by default
canvasVisualizer.lineColor	string	“black”	Route line color, black by default
canvasVisualizer.lineStyle	string	“solid”	Route line style (solid, dashed, dotted)
canvasVisualizer.lineWidth	double	2	Route line width
canvasVisualizer.lineShift	double	16	Line shift to avoid overlapping lines
canvasVisualizer.lineShiftMode	string	“normal”	Determines how overlapping lines are shifted, possible values are: none, normal, x, y, z; optional prefix + or -
canvasVisualizer.lineContactSpacing	double	3	Spacing between arrow end and submodule icon
canvasVisualizer.lineContactMode	string	“rectangular”	Determines how arrows are clipped at the submodules
canvasVisualizer.labelFormat	string	“%d/%m -> %g (%n)”	Determines what route data is displayed
canvasVisualizer.labelFont	string	“<default>, 8px”	Label font, automatic by default
canvasVisualizer.labelColor	string	“black”	Label color, black by default
canvasVisualizer.zIndex	double	0	Determines the drawing order of figures relative to other visualizers
osgVisualizer.displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
osgVisualizer.visualizationTargetModule	string	“^”	Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
osgVisualizer.visualizationSubjectModule	string	“^”	Module path relative to the visualizer which determines what part of the simulation model the visualizer displays in the user interface, parent module by default
osgVisualizer.tags	string	“”	Tag added to each visualization for disambiguation in the runtime environment
osgVisualizer.displayRoutingTables	bool	false	Displays routing table data, disabled by default
osgVisualizer.displayRoutesIndividually	bool	true	Displays routes between the same network nodes individually, enabled by default
osgVisualizer.displayLabels	bool	true	Displays labels on arrows, enabled by default
osgVisualizer.destinationFilter	string	“*”	Determines the destinations that are considered, matches all destinations by default
osgVisualizer.nodeFilter	string	“*”	Determines the nodes that are considered, matches all nodes by default
osgVisualizer.multicastSourceNodeFilter	string	“*”	Determines the multicast source nodes that are considered, matches all nodes by default
osgVisualizer.multicastSourceAddressFilter	string	“*”	Determines the multicast source addresses that are considered, matches all addresses by default
osgVisualizer.multicastGroupFilter	string	“*”	Determines the multicast group addresses that are considered, matches all group addresses by default
osgVisualizer.lineColor	string	“black”	Route line color, black by default
osgVisualizer.lineStyle	string	“solid”	Route line style (solid, dashed, dotted)
osgVisualizer.lineWidth	double	2	Route line width
osgVisualizer.lineShift	double	16	Line shift to avoid overlapping lines
osgVisualizer.lineShiftMode	string	“normal”	Determines how overlapping lines are shifted, possible values are: none, normal, x, y, z; optional prefix + or -
osgVisualizer.lineContactSpacing	double	3	Spacing between arrow end and submodule icon
osgVisualizer.lineContactMode	string	“rectangular”	Determines how arrows are clipped at the submodules
osgVisualizer.labelFormat	string	“%d/%m -> %g (%n)”	Determines what route data is displayed
osgVisualizer.labelFont	string	“<default>, 8px”	Label font, automatic by default
osgVisualizer.labelColor	string	“black”	Label color, black by default

Source code¶

//
// Integrates canvas and osg routing table visualizers into a single module.
//
// @see ~RoutingTableCanvasVisualizer, ~RoutingTableOsgVisualizer, ~RoutingTableVisualizerBase, ~IRoutingTableVisualizer
//
module RoutingTableVisualizer like IRoutingTableVisualizer
{
    parameters:
        @display("i=block/app");
        string visualizationTargetModule = default("^");
        string visualizationSubjectModule = default("^");
        *.visualizationTargetModule = default(absPath(this.visualizationTargetModule));
        *.visualizationSubjectModule = default(absPath(this.visualizationSubjectModule));
    submodules:
        canvasVisualizer: <default(firstAvailableOrEmpty("RoutingTableCanvasVisualizer"))> like IRoutingTableVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("RoutingTableOsgVisualizer"))> like IRoutingTableVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

File: src/inet/visualizer/common/RoutingTableVisualizer.ned