NetworkRouteVisualizer¶

compound module NetworkRouteVisualizer

Integrates canvas and osg network route 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.displayRoutes	bool	false	Display polyline arrow for active routes, disabled by default
canvasVisualizer.startPathSignal	string	“packetReceivedFromUpper”
canvasVisualizer.extendPathSignal	string	“packetReceivedFromLower”
canvasVisualizer.endPathSignal	string	“packetSentToUpper”
canvasVisualizer.nodeFilter	string	“*”	Which nodes are considered, matches all nodes by default
canvasVisualizer.packetFilter	object	“*”	Which packets are considered, matches all packets by default
canvasVisualizer.lineColor	string	“dark”	Route color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default
canvasVisualizer.lineStyle	string	“solid”	Route line style (solid, dashed, dotted)
canvasVisualizer.lineWidth	double	3	Route line width
canvasVisualizer.lineSmooth	bool	false	When true polylines are displayed as curves
canvasVisualizer.lineShift	double	16	Route line shift to avoid overlapping routes
canvasVisualizer.lineShiftMode	string	“normal”	Determines how overlapping lines are shifted, possible values are: 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	“%n”	Determines what path data is displayed
canvasVisualizer.labelFont	string	“<default>, 8px”	Label font, automatic by default
canvasVisualizer.labelColor	string	“”	Label color, same as line by default
canvasVisualizer.fadeOutMode	string	“realTime”	Specifies how inactive routes fade out
canvasVisualizer.fadeOutTime	double	1s	How quickly inactive routes fade away, 1 second by default
canvasVisualizer.fadeOutAnimationSpeed	double	0	Animation speed while there are active routes, value must be in the range (0, +inf)
canvasVisualizer.zIndex	double	3	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.displayRoutes	bool	false	Display polyline arrow for active routes, disabled by default
osgVisualizer.startPathSignal	string	“packetReceivedFromUpper”
osgVisualizer.extendPathSignal	string	“packetReceivedFromLower”
osgVisualizer.endPathSignal	string	“packetSentToUpper”
osgVisualizer.nodeFilter	string	“*”	Which nodes are considered, matches all nodes by default
osgVisualizer.packetFilter	object	“*”	Which packets are considered, matches all packets by default
osgVisualizer.lineColor	string	“dark”	Route color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default
osgVisualizer.lineStyle	string	“solid”	Route line style (solid, dashed, dotted)
osgVisualizer.lineWidth	double	3	Route line width
osgVisualizer.lineSmooth	bool	false	When true polylines are displayed as curves
osgVisualizer.lineShift	double	16	Route line shift to avoid overlapping routes
osgVisualizer.lineShiftMode	string	“normal”	Determines how overlapping lines are shifted, possible values are: 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	“%n”	Determines what path data is displayed
osgVisualizer.labelFont	string	“<default>, 8px”	Label font, automatic by default
osgVisualizer.labelColor	string	“”	Label color, same as line by default
osgVisualizer.fadeOutMode	string	“realTime”	Specifies how inactive routes fade out
osgVisualizer.fadeOutTime	double	1s	How quickly inactive routes fade away, 1 second by default
osgVisualizer.fadeOutAnimationSpeed	double	0	Animation speed while there are active routes, value must be in the range (0, +inf)

Source code¶

//
// Integrates canvas and osg network route visualizers into a single module.
//
// @see ~NetworkRouteCanvasVisualizer, ~NetworkRouteOsgVisualizer, ~PathVisualizerBase, ~INetworkRouteVisualizer
//
module NetworkRouteVisualizer like INetworkRouteVisualizer
{
    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("NetworkRouteCanvasVisualizer"))> like INetworkRouteVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("NetworkRouteOsgVisualizer"))> like INetworkRouteVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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