Simple Module LinkBreakCanvasVisualizer

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

C++ definition

This module 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 middle point of the link.

See also: LinkBreakOsgVisualizer, LinkBreakVisualizer, LinkBreakVisualizerBase, ILinkBreakVisualizer

LinkBreakCanvasVisualizer

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends:

Name Type Description
LinkBreakVisualizerBase simple module

This is a 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
visualizerTargetModule string ""

module path relative to the visualizer where the visualization should appear in the user interface, root module by default

tags string ""

tag added to each visualization for disambiguation in the runtime environment

subscriptionModule string ""

module where the visualizer subscribes for link break signals, root module by default

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 string "*"

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_s

Source code:

//
// This module 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
// middle point 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);
}