ChannelVisualizerBase

simple module

(no description)

Inheritance diagram

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

Known subclasses

Name	Type	Description
ChannelCanvasVisualizer	simple module	(no description)

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
displayChannelActivity	bool	false	Display arrows for active channels. Disabled by default.
nodeFilter	string	"*"	Which nodes are considered. Matches all nodes by default.
packetFilter	object	"*"	Which packets are considered. Matches all packets by default.
lineColor	string	"blue"	Arrow color. Black by default.
lineStyle	string	"solid"	Arrow style (solid, dashed, dotted).
lineWidth	double	3	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 data is displayed.
labelFont	string	", 8px"	Label font. Automatic by default.
labelColor	string	"blue"	Label color. Black by default.
fadeOutMode	string	"realTime"	Specifies how inactive channels fade out.
fadeOutTime	double	1s	How quickly inactive channels fade away. 1 second by default.
fadeOutAnimationSpeed	double	0	Animation speed while there are active channels. Value must be in the range (0, +inf).
holdAnimationTime	double	0s	Hold simulation (no progress) for the specified amount of animation time when the channel is activated.

Properties

Name	Value	Description
class	ChannelVisualizerBase
display	i=block/app

Source code

simple ChannelVisualizerBase extends VisualizerBase
{
    parameters:
        bool displayChannelActivity = default(false); // Display arrows for active channels. Disabled by default.

        string nodeFilter @mutable = default("*"); // Which nodes are considered. Matches all nodes by default.
        object packetFilter @mutable = default("*"); // Which packets are considered. Matches all packets by default.

        string lineColor = default("blue"); // Arrow color. Black by default.
        string lineStyle = default("solid"); // Arrow style (solid, dashed, dotted).
        double lineWidth = default(3); // 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 data is displayed.
        string labelFont = default("<default>, 8px"); // Label font. Automatic by default.
        string labelColor = default("blue"); // Label color. Black by default.

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

        double holdAnimationTime @unit(s) = default(0s); // Hold simulation (no progress) for the specified amount of animation time when the channel is activated.

        @class(ChannelVisualizerBase);
}

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