InfoVisualizer¶

compound module InfoVisualizer

Integrates canvas and osg info visualizers into a single module.

Usage diagram¶

Inheritance diagram¶

Parameters¶

Name	Type	Default value	Description
visualizationTargetModule	string	“^”
visualizationSubjectModule	string	“^”

Properties¶

Name	Value	Description
display	i=block/app

Unassigned submodule parameters¶

Name	Type	Default value	Description
canvasVisualizer.displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
canvasVisualizer.visualizationTargetModule	string	“^”	Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
canvasVisualizer.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
canvasVisualizer.tags	string	“”	Tag added to each visualization for disambiguation in the runtime environment
canvasVisualizer.networkNodeVisualizerModule	string	“^.networkNodeVisualizer”	Module path to the network node visualizer module, refers to a sibling submodule by default
canvasVisualizer.displayInfos	bool	true
canvasVisualizer.modules	string	“”	Specifies the path of the submodules of network nodes, no submodules by default
canvasVisualizer.format	string	“%t”	Determines what is displayed on network nodes
canvasVisualizer.font	string	“<default>”	Info text font, automatic by default
canvasVisualizer.textColor	string	“black”	Info text font color
canvasVisualizer.textAlignment	string	“left”	Alignment of multi-line text
canvasVisualizer.backgroundColor	string	“white”	Text box fill color, specify an empty string for no fill
canvasVisualizer.lineColor	string	“black”	Text box outline color, specify an empty string for no line
canvasVisualizer.opacity	double	1.0	Opacity of the visualization
canvasVisualizer.placementHint	string	“top”	Annotation placement hint, space-separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
canvasVisualizer.placementPriority	double	0	Determines the order of annotation positioning
canvasVisualizer.zIndex	double	10	Determines the drawing order of figures relative to other visualizers
osgVisualizer.displayStringTextFormat	string	“”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
osgVisualizer.visualizationTargetModule	string	“^”	Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
osgVisualizer.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
osgVisualizer.tags	string	“”	Tag added to each visualization for disambiguation in the runtime environment
osgVisualizer.networkNodeVisualizerModule	string	“^.networkNodeVisualizer”	Module path to the network node visualizer module, refers to a sibling submodule by default
osgVisualizer.displayInfos	bool	true
osgVisualizer.modules	string	“”	Specifies the path of the submodules of network nodes, no submodules by default
osgVisualizer.format	string	“%t”	Determines what is displayed on network nodes
osgVisualizer.font	string	“<default>”	Info text font, automatic by default
osgVisualizer.textColor	string	“black”	Info text font color
osgVisualizer.textAlignment	string	“left”	Alignment of multi-line text
osgVisualizer.backgroundColor	string	“white”	Text box fill color, specify an empty string for no fill
osgVisualizer.lineColor	string	“black”	Text box outline color, specify an empty string for no line
osgVisualizer.opacity	double	1.0	Opacity of the visualization
osgVisualizer.placementHint	string	“top”	Annotation placement hint, space-separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
osgVisualizer.placementPriority	double	0	Determines the order of annotation positioning

Source code¶

//
// Integrates canvas and osg info visualizers into a single module.
//
// @see ~InfoCanvasVisualizer, ~InfoOsgVisualizer, ~InfoVisualizerBase, ~IInfoVisualizer
//
module InfoVisualizer like IInfoVisualizer
{
    parameters:
        @display("i=block/app");
        string visualizationTargetModule = default("^");
        string visualizationSubjectModule = default("^");
        *.visualizationTargetModule = default(absPath(this.visualizationTargetModule));
        *.visualizationSubjectModule = default(absPath(this.visualizationSubjectModule));
    submodules:
        canvasVisualizer: <default(firstAvailableOrEmpty("InfoCanvasVisualizer"))> like IInfoVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("InfoOsgVisualizer"))> like IInfoVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

File: src/inet/visualizer/common/InfoVisualizer.ned