DataLinkVisualizer¶

compound module DataLinkVisualizer

Integrates canvas and osg data link 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.displayLinks	bool	false	Display arrows for active links, disabled by default
canvasVisualizer.activityLevel	string	“service”	Determines what level of activity is displayed, service level by default
canvasVisualizer.nodeFilter	string	“*”	Which nodes are considered, matches all nodes by default
canvasVisualizer.interfaceFilter	string	“*”	Which interfaces are considered, matches all interfaces by default
canvasVisualizer.packetFilter	object	“*”	Which packets are considered, matches all packets by default
canvasVisualizer.lineColor	string	“darkcyan”	Link arrow color, black by default
canvasVisualizer.lineStyle	string	“solid”	Link arrow style (solid, dashed, dotted)
canvasVisualizer.lineWidth	double	3	Link arrow width
canvasVisualizer.lineShift	double	16	Line shift to avoid overlapping arrows
canvasVisualizer.lineShiftMode	string	“normal”	Determines how overlapping arrows 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	“%n”	Determines what link data is displayed
canvasVisualizer.labelFont	string	“<default>, 8px”	Label font, automatic by default
canvasVisualizer.labelColor	string	“darkcyan”	Label color, black by default
canvasVisualizer.fadeOutMode	string	“realTime”	Specifies how inactive links fade out
canvasVisualizer.fadeOutTime	double	1s	How quickly inactive links fade away, 1 second by default
canvasVisualizer.fadeOutAnimationSpeed	double	0	Animation speed while there are active links, value must be in the range (0, +inf)
canvasVisualizer.holdAnimationTime	double	0s	Hold simulation (no progress) for the specified amount of animation time when the link is activated
canvasVisualizer.zIndex	double	2	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.displayLinks	bool	false	Display arrows for active links, disabled by default
osgVisualizer.activityLevel	string	“service”	Determines what level of activity is displayed, service level by default
osgVisualizer.nodeFilter	string	“*”	Which nodes are considered, matches all nodes by default
osgVisualizer.interfaceFilter	string	“*”	Which interfaces are considered, matches all interfaces by default
osgVisualizer.packetFilter	object	“*”	Which packets are considered, matches all packets by default
osgVisualizer.lineColor	string	“darkcyan”	Link arrow color, black by default
osgVisualizer.lineStyle	string	“solid”	Link arrow style (solid, dashed, dotted)
osgVisualizer.lineWidth	double	3	Link arrow width
osgVisualizer.lineShift	double	16	Line shift to avoid overlapping arrows
osgVisualizer.lineShiftMode	string	“normal”	Determines how overlapping arrows 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	“%n”	Determines what link data is displayed
osgVisualizer.labelFont	string	“<default>, 8px”	Label font, automatic by default
osgVisualizer.labelColor	string	“darkcyan”	Label color, black by default
osgVisualizer.fadeOutMode	string	“realTime”	Specifies how inactive links fade out
osgVisualizer.fadeOutTime	double	1s	How quickly inactive links fade away, 1 second by default
osgVisualizer.fadeOutAnimationSpeed	double	0	Animation speed while there are active links, value must be in the range (0, +inf)
osgVisualizer.holdAnimationTime	double	0s	Hold simulation (no progress) for the specified amount of animation time when the link is activated

Source code¶

//
// Integrates canvas and osg data link visualizers into a single module.
//
// @see ~DataLinkCanvasVisualizer, ~DataLinkOsgVisualizer, ~LinkVisualizerBase, ~IDataLinkVisualizer
//
module DataLinkVisualizer like IDataLinkVisualizer
{
    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("DataLinkCanvasVisualizer"))> like IDataLinkVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("DataLinkOsgVisualizer"))> like IDataLinkVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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