NetworkConnectionVisualizerBase

Package: inet.visualizer.base

NetworkConnectionVisualizerBase

simple module

C++ definition

Base module for connection visualizer simple modules. The actual visualization of network connections is done in derived modules.

<b>See also:</b> ~NetworkConnectionCanvasVisualizer, ~NetworkConnectionOsgVisualizer, ~INetworkConnectionVisualizer, ~VisualizerBase

Inheritance diagram

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

Known subclasses

Name Type Description
NetworkConnectionCanvasVisualizer simple module

Visualizes multiple network connections on a 2D canvas.

NetworkConnectionOsgVisualizer simple module

Visualizes multiple network connections on a 3D OSG scene.

Extends

Name Type Description
VisualizerBase simple module

Base module for visualizer simple modules. It simply provides the visualization target module for 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

displayNetworkConnections bool true
nodeFilter string "*"

Determines which network connections are displayed. All connections are displayed by default.

lineColor string "black"

Connection line color.

lineStyle string "solid"

Connection line style (solid, dashed, dotted).

lineWidth double 1

Connection line width.

Properties

Name Value Description
class NetworkConnectionVisualizerBase
display i=block/app

Source code

//
// Base module for connection visualizer simple modules. The actual
// visualization of network connections is done in derived modules.
//
// @see ~NetworkConnectionCanvasVisualizer, ~NetworkConnectionOsgVisualizer, ~INetworkConnectionVisualizer, ~VisualizerBase
//
simple NetworkConnectionVisualizerBase extends VisualizerBase
{
    parameters:
        bool displayNetworkConnections = default(true);

        string nodeFilter @mutable = default("*"); // Determines which network connections are displayed. All connections are displayed by default.

        string lineColor = default("black"); // Connection line color.
        string lineStyle = default("solid"); // Connection line style (solid, dashed, dotted).
        double lineWidth = default(1); // Connection line width.

        @class(NetworkConnectionVisualizerBase);
}

File: src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned