TreeVisualizerBase.ned

NED File src/inet/visualizer/base/TreeVisualizerBase.ned

Name Type Description
TreeVisualizerBase simple module

Base module for tree visualizer modules that display network tree structures such as multicast routing trees, spanning trees, or other hierarchical network relationships. Visualizes tree structures as a set of connected arrows between network nodes, with configurable appearance properties for the connecting lines.

Source code

//
// Copyright (C) 2020 OpenSim Ltd.
//
// SPDX-License-Identifier: LGPL-3.0-or-later
//


package inet.visualizer.base;

//
// Base module for tree visualizer modules that display network tree structures
// such as multicast routing trees, spanning trees, or other hierarchical network
// relationships. Visualizes tree structures as a set of connected arrows between
// network nodes, with configurable appearance properties for the connecting lines.
//
simple TreeVisualizerBase extends VisualizerBase
{
    parameters:
        bool displayTrees = default(false); // Display a set of polyline arrows for trees, disabled by default

        string lineColor = default("dark"); // Line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default
        string lineStyle = default("solid"); // Line style (solid, dashed, dotted)
        double lineWidth = default(3); // Line width
        bool lineSmooth = default(false); // When true polylines are displayed as curves

        double lineShift = default(16); // Line shift to avoid overlapping lines
        string lineShiftMode = default("normal"); // Determines how overlapping lines are shifted, possible values are: 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

        @class(TreeVisualizerBase);
}