Simple Module InfoVisualizerBase

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

This is a 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
%d display string text
%i cModule::info()
%s cModule::str()

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

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

Extends:

Name	Type	Description
VisualizerBase	simple module	This is a base module for visualizer simple modules. It simply provides the visualization target module for derived modules.

Known subclasses:

Name	Type	Description
InfoCanvasVisualizer	simple module	This module visualizes some information of a submodule for each network node on a 2D canvas.
InfoOsgVisualizer	simple module	This module visualizes some information of a submodule for each network node on a 3D osg scene.

Parameters:

Name	Type	Default value	Description
visualizerTargetModule	string	""	module path relative to the visualizer where the visualization should appear in the user interface, root 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	"%s"	determines what is displayed on network nodes
font	string	""	info text font, automatic by default
textColor	string	"black"	info text font color, black by default
backgroundColor	string	"white"	info text background color, white by default
opacity	double	1.0	opacity of the visualization
displacementHint	string	"top"	annotation displacement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
displacementPriority	double	0	determines the order of annotation positioning

Properties:

Name	Value	Description
class	InfoVisualizerBase
display	i=block/app_s

Source code:

//
// This is a 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
//  - %d display string text
//  - %i cModule::info()
//  - %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 = default(""); // specifies the path of the submodules of network nodes, no submodules by default
        string format = default("%s"); // 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, black by default
        string backgroundColor = default("white"); // info text background color, white by default
        double opacity = default(1.0); // opacity of the visualization
        string displacementHint = default("top"); // annotation displacement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
        double displacementPriority = default(0); // determines the order of annotation positioning

        @class(InfoVisualizerBase);
}