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.

Inheritance diagram

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

Known subclasses

Name	Type	Description
FailureProtectionConfigurationCanvasVisualizer	simple module	(no description)
StreamRedundancyConfigurationCanvasVisualizer	simple module	Visualizes stream redundancy configurations on a canvas by displaying polyline arrows representing redundant paths for streams. Uses information from the ~StreamRedundancyConfigurator module to identify and display the network paths used for redundant stream transmission in Time-Sensitive Networking (TSN) applications.

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
displayTrees	bool	false	Display a set of polyline arrows for trees, disabled by default
lineColor	string	"dark"	Line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default
lineStyle	string	"solid"	Line style (solid, dashed, dotted)
lineWidth	double	3	Line width
lineSmooth	bool	false	When true polylines are displayed as curves
lineShift	double	16	Line shift to avoid overlapping lines
lineShiftMode	string	"normal"	Determines how overlapping lines are shifted, possible values are: 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

Properties

Name	Value	Description
class	TreeVisualizerBase
display	i=block/app

Source code

//
// 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);
}

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