InfoVisualizerBase

simple module

Base module for submodule information visualizer simple modules. It displays some information on network nodes originating from one of their corresponding submodules. No information is displayed by default, see module parameters for how to enable the visualization. The actual visualization is done in derived modules.

The format string can contain the following directives:

%n module full name
%p module full path
%t display string text
%s cModule::str()

Inheritance diagram

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

Known subclasses

Name	Type	Description
InfoCanvasVisualizer	simple module	Visualizes some information of a submodule for each network node on a 2D canvas.
InfoOsgVisualizer	simple module	Visualizes some information of a submodule for each network node 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
networkNodeVisualizerModule	string	"^.networkNodeVisualizer"	Module path to the network node visualizer module, refers to a sibling submodule by default
displayInfos	bool	true
modules	string	""	Specifies the path of the submodules of network nodes, no submodules by default
format	string	"%t"	Determines what is displayed on network nodes
font	string	""	Info text font, automatic by default
textColor	string	"black"	Info text font color
textAlignment	string	"left"	Alignment of multi-line text
backgroundColor	string	"white"	Text box fill color, specify an empty string for no fill
lineColor	string	"black"	Text box outline color, specify an empty string for no line
opacity	double	1.0	Opacity of the visualization
placementHint	string	"top"	Annotation placement hint, space-separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
placementPriority	double	0	Determines the order of annotation positioning

Properties

Name	Value	Description
class	InfoVisualizerBase
display	i=block/app

Source code

//
// Base module for submodule information visualizer simple modules.
// It displays some information on network nodes originating from one of their
// corresponding submodules. No information is displayed by default, see module
// parameters for how to enable the visualization. The actual visualization is
// done in derived modules.
//
// The format string can contain the following directives:
//  - %n module full name
//  - %p module full path
//  - %t display string text
//  - %s `cModule`::str()
//
// @see ~InfoCanvasVisualizer, ~InfoOsgVisualizer, ~IInfoVisualizer, ~VisualizerBase
//
simple InfoVisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default

        bool displayInfos = default(true);

        string modules @mutable = default(""); // Specifies the path of the submodules of network nodes, no submodules by default
        string format @mutable = default("%t"); // Determines what is displayed on network nodes

        string font = default("<default>"); // Info text font, automatic by default
        string textColor = default("black"); // Info text font color
        string textAlignment @enum("left","right","center") = default("left"); // Alignment of multi-line text
        string backgroundColor = default("white"); // Text box fill color, specify an empty string for no fill
        string lineColor = default("black"); // Text box outline color, specify an empty string for no line
        double opacity = default(1.0); // Opacity of the visualization
        string placementHint = default("top"); // Annotation placement hint, space-separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
        double placementPriority = default(0); // Determines the order of annotation positioning

        @class(InfoVisualizerBase);
}

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