LinkBreakCanvasVisualizer¶

Package: inet.visualizer.canvas.linklayer

simple module LinkBreakCanvasVisualizer

Visualizes link breaks on a 2D canvas. It displays an icon for each link break in the network. See the documentation of the base module for what constitutes a link break. The icon is positioned at the midpoint of the link.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
IntegratedCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
IntegratedMultiCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
LinkBreakVisualizer	compound module	Integrates canvas and osg link break visualizers into a single module.

Extends¶

Name	Type	Description
LinkBreakVisualizerBase	simple module	Base module for link break visualizer simple modules. It keeps track of link breaks in a network. Link breaks are not displayed by default, see module parameters for how to enable the visualization. The actual visualization of link breaks is done in derived modules.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
visualizationTargetModule	string	“^”	Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
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
tags	string	“”	Tag added to each visualization for disambiguation in the runtime environment
displayLinkBreaks	bool	false	Display icons for link breaks, disabled by default
nodeFilter	string	“*”	Which network nodes are considered, matches all nodes by default
interfaceFilter	string	“*”	Which interfaces are considered, matches all interfaces by default
packetFilter	object	“*”	Which packets are considered, matches all packets by default
icon	string	“status/stop”
iconTintAmount	double	0
iconTintColor	string	“”
fadeOutMode	string	“realTime”	Specifies how inactive link breaks fade out
fadeOutTime	double	1s	How quickly link breaks fade away, 1 second by default
fadeOutAnimationSpeed	double	0	Animation speed while there are link breaks, value must be in the range (0, +inf)
zIndex	double	2	Determines the drawing order of figures relative to other visualizers

Properties¶

Name	Value	Description
class	LinkBreakCanvasVisualizer
display	i=block/app

Source code¶

//
// Visualizes link breaks on a 2D canvas. It displays an icon
// for each link break in the network. See the documentation of the base
// module for what constitutes a link break. The icon is positioned at the
// midpoint of the link.
//
// @see ~LinkBreakOsgVisualizer, ~LinkBreakVisualizer, ~LinkBreakVisualizerBase, ~ILinkBreakVisualizer
//
simple LinkBreakCanvasVisualizer extends LinkBreakVisualizerBase like ILinkBreakVisualizer
{
    parameters:
        double zIndex = default(2); // Determines the drawing order of figures relative to other visualizers
        @class(LinkBreakCanvasVisualizer);
}

File: src/inet/visualizer/canvas/linklayer/LinkBreakCanvasVisualizer.ned