Simple Module PhysicalLinkCanvasVisualizer

Package: inet.visualizer.physicallayer
File: src/inet/visualizer/physicallayer/PhysicalLinkCanvasVisualizer.ned

C++ definition

This module visualizes physical layer links on a 2D canvas. It displays an arrow for each active link in the network. See the documentation of the base module for what constitutes an active link. The arrow points from the source towards the destination. If a link is used in both directions then there are separate arrows for them. Each arrow fades out over time as the link becomes inactive unless it is reinforced by another packet. The arrow automatically follows the movement of mobile nodes.

See also: PhysicalLinkOsgVisualizer, PhysicalLinkVisualizer, PhysicalLinkVisualizerBase, IPhysicalLinkVisualizer

PhysicalLinkCanvasVisualizer

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
PhysicalLinkVisualizerBase simple module

This is a base module for physical layer link visualizer simple modules. It keeps track of active links in a network. A link between two network node is considered active if a packet is sent recently between their physical layers. Active links are not displayed by default, see the module parameters for how to enable the visualization. The actual visualization of active links 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 signals, root module by default

displayLinks bool false

display arrows for active links, disabled by default

nodeFilter string "*"

which 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

lineColor string "olive"

link arrow color, black by default

lineStyle string "dotted"

link arrow style (solid, dashed, dotted)

lineWidth double 3

link arrow width

lineShift double 16

line shift to avoid overlapping arrows

lineShiftMode string "normal"

determines how overlapping arrows are shifted, possible values are: none, normal, x, y, z; optional prefix + or -

lineContactSpacing double 3

spacing between arrow end and submodule icon

lineContactMode string "rectangular"

determines how arrows are clipped at the submodules

labelFormat string "%n"

determines what link data is displayed

labelFont string ", 8px"

label font, automatic by default

labelColor string "olive"

label color, black by default

fadeOutMode string "realTime"

specifies how inactive links fade out

fadeOutTime double 1s

how quickly inactive links fade away, 1 second by default

fadeOutAnimationSpeed double 0

animation speed while there are active links, value must be in the range (0, +inf)

zIndex double 1

determines the drawing order of figures relative to other visualizers

Properties:

Name Value Description
class PhysicalLinkCanvasVisualizer
display i=block/app_s

Source code:

//
// This module visualizes physical layer links on a 2D canvas. It displays an
// arrow for each active link in the network. See the documentation of the base
// module for what constitutes an active link. The arrow points from the source
// towards the destination. If a link is used in both directions then there are
// separate arrows for them. Each arrow fades out over time as the link becomes
// inactive unless it is reinforced by another packet. The arrow automatically
// follows the movement of mobile nodes.
//
// @see ~PhysicalLinkOsgVisualizer, ~PhysicalLinkVisualizer, ~PhysicalLinkVisualizerBase, ~IPhysicalLinkVisualizer
//
simple PhysicalLinkCanvasVisualizer extends PhysicalLinkVisualizerBase like IPhysicalLinkVisualizer
{
    parameters:
        double zIndex = default(1); // determines the drawing order of figures relative to other visualizers
        @class(PhysicalLinkCanvasVisualizer);
}