InfoCanvasVisualizer¶

simple module InfoCanvasVisualizer

Visualizes some information of a submodule for each network node on a 2D canvas.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
IntegratedCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
IntegratedMultiCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
InfoVisualizer	compound module	Integrates canvas and osg info visualizers into a single module.

Extends¶

Name	Type	Description
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.

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	“<default>”	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
zIndex	double	10	Determines the drawing order of figures relative to other visualizers

Properties¶

Name	Value	Description
class	InfoCanvasVisualizer
display	i=block/app

Source code¶

//
// Visualizes some information of a submodule for each network node
// on a 2D canvas.
//
// @see ~InfoOsgVisualizer, ~InfoVisualizer, ~InfoVisualizerBase, ~IInfoVisualizer
//
simple InfoCanvasVisualizer extends InfoVisualizerBase like IInfoVisualizer
{
    parameters:
        double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers
        @class(InfoCanvasVisualizer);
}

File: src/inet/visualizer/canvas/common/InfoCanvasVisualizer.ned