LinkBreakVisualizer¶

compound module LinkBreakVisualizer

Integrates canvas and osg link break 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.displayLinkBreaks	bool	false	Display icons for link breaks, disabled by default
canvasVisualizer.nodeFilter	string	“*”	Which network 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.icon	string	“status/stop”
canvasVisualizer.iconTintAmount	double	0
canvasVisualizer.iconTintColor	string	“”
canvasVisualizer.fadeOutMode	string	“realTime”	Specifies how inactive link breaks fade out
canvasVisualizer.fadeOutTime	double	1s	How quickly link breaks fade away, 1 second by default
canvasVisualizer.fadeOutAnimationSpeed	double	0	Animation speed while there are link breaks, value must be in the range (0, +inf)
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.displayLinkBreaks	bool	false	Display icons for link breaks, disabled by default
osgVisualizer.nodeFilter	string	“*”	Which network 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.icon	string	“status/stop”
osgVisualizer.iconTintAmount	double	0
osgVisualizer.iconTintColor	string	“”
osgVisualizer.fadeOutMode	string	“realTime”	Specifies how inactive link breaks fade out
osgVisualizer.fadeOutTime	double	1s	How quickly link breaks fade away, 1 second by default
osgVisualizer.fadeOutAnimationSpeed	double	0	Animation speed while there are link breaks, value must be in the range (0, +inf)

Source code¶

//
// Integrates canvas and osg link break visualizers into a single module.
//
// @see ~LinkBreakCanvasVisualizer, ~LinkBreakOsgVisualizer, ~LinkBreakVisualizerBase, ~ILinkBreakVisualizer
//
module LinkBreakVisualizer like ILinkBreakVisualizer
{
    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("LinkBreakCanvasVisualizer"))> like ILinkBreakVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("LinkBreakOsgVisualizer"))> like ILinkBreakVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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