Simple Module LinkVisualizerBase

Package: inet.visualizer.base
File: src/inet/visualizer/base/LinkVisualizerBase.ned

C++ definition

This is a base module for 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 the corresponding 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.

This module subscribes for signals at the provided subscription module. When determining active links, it only considers packets matched by the provided filters. The filters use the format of cMatchExpression with the packet name as the default attribute.

The format string can contain the following directives:

See also: PhysicalLinkVisualizerBase, DataLinkVisualizerBase, VisualizerBase

LinkVisualizerBase

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

This is a base module for visualizer simple modules. It simply provides the visualization target module for derived modules.

Known subclasses:

Name Type Description
DataLinkVisualizerBase simple module

This is a base module for data link 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 link 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.

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 "black"

link arrow color, black by default

lineStyle string "solid"

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 "black"

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)

Properties:

Name Value Description
class LinkVisualizerBase
display i=block/app_s

Source code:

//
// This is a base module for 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 the corresponding 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.
//
// This module subscribes for signals at the provided subscription module. When
// determining active links, it only considers packets matched by the provided
// filters. The filters use the format of cMatchExpression with the packet name
// as the default attribute.
//
// The format string can contain the following directives:
//  - %n packet name
//  - %c packet class
//
// @see ~PhysicalLinkVisualizerBase, ~DataLinkVisualizerBase, ~VisualizerBase
//
simple LinkVisualizerBase extends VisualizerBase
{
    parameters:
        string subscriptionModule = default("<root>"); // module where the visualizer subscribes for signals, root module by default

        bool displayLinks = default(false); // display arrows for active links, disabled by default

        string nodeFilter = default("*"); // which nodes are considered, matches all nodes by default
        string interfaceFilter = default("*"); // which interfaces are considered, matches all interfaces by default
        string packetFilter = default("*"); // which packets are considered, matches all packets by default

        string lineColor = default("black"); // link arrow color, black by default
        string lineStyle = default("solid"); // link arrow style (solid, dashed, dotted)
        double lineWidth = default(3); // link arrow width

        double lineShift = default(16); // line shift to avoid overlapping arrows
        string lineShiftMode = default("normal"); // determines how overlapping arrows are shifted, possible values are: none, normal, x, y, z; optional prefix + or -

        double lineContactSpacing = default(3); // spacing between arrow end and submodule icon
        string lineContactMode @enum("circular","rectangular") = default("rectangular"); // determines how arrows are clipped at the submodules

        string labelFormat = default("%n"); // determines what link data is displayed
        string labelFont = default("<default>, 8px"); // label font, automatic by default
        string labelColor = default("black"); // label color, black by default

        string fadeOutMode @enum("realTime","animationTime","simulationTime") = default("realTime"); // specifies how inactive links fade out
        double fadeOutTime @unit(s) = default(1s); // how quickly inactive links fade away, 1 second by default
        double fadeOutAnimationSpeed = default(0); // animation speed while there are active links, value must be in the range (0, +inf)

        @class(LinkVisualizerBase);
}