StatisticVisualizer¶

compound module StatisticVisualizer

Integrates canvas and osg statistic 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”	The network node visualizer module, refers to a sibling submodule by default
canvasVisualizer.displayStatistics	bool	false
canvasVisualizer.signalName	string	“”	Signal name to subscribe, no signal name by default
canvasVisualizer.statisticName	string	signalName	Statistic name to get the value, signal name by default
canvasVisualizer.statisticUnit	string	“”	Statistic unit, undefined by default
canvasVisualizer.statisticExpression	string	“”	Statistic expression, received value by default
canvasVisualizer.sourceFilter	string	“**”	Pattern that must match the signal source, no source filter by default
canvasVisualizer.format	string	“%n: %v %u”	Determines what is displayed, info by default
canvasVisualizer.unit	string	“”	Display the value in one of the specified units, statistic unit by default
canvasVisualizer.font	string	“<default>”	Statistic value font, automatic by default
canvasVisualizer.textColor	string	“black”	Statistic value font color, black by default
canvasVisualizer.backgroundColor	string	“white”	Statistic value background color, white by default
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
canvasVisualizer.propertyName	string	“”	Optional property name of a figure template along the module path of the visualizer
canvasVisualizer.propertyIndex	string	“”	Optional property index of a figure template along the module path of the visualizer
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”	The network node visualizer module, refers to a sibling submodule by default
osgVisualizer.displayStatistics	bool	false
osgVisualizer.signalName	string	“”	Signal name to subscribe, no signal name by default
osgVisualizer.statisticName	string	signalName	Statistic name to get the value, signal name by default
osgVisualizer.statisticUnit	string	“”	Statistic unit, undefined by default
osgVisualizer.statisticExpression	string	“”	Statistic expression, received value by default
osgVisualizer.sourceFilter	string	“**”	Pattern that must match the signal source, no source filter by default
osgVisualizer.format	string	“%n: %v %u”	Determines what is displayed, info by default
osgVisualizer.unit	string	“”	Display the value in one of the specified units, statistic unit by default
osgVisualizer.font	string	“<default>”	Statistic value font, automatic by default
osgVisualizer.textColor	string	“black”	Statistic value font color, black by default
osgVisualizer.backgroundColor	string	“white”	Statistic value background color, white by default
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 statistic visualizers into a single module.
//
// @see ~StatisticCanvasVisualizer, ~StatisticOsgVisualizer, ~StatisticVisualizerBase, ~IStatisticVisualizer
//
module StatisticVisualizer like IStatisticVisualizer
{
    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("StatisticCanvasVisualizer"))> like IStatisticVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("StatisticOsgVisualizer"))> like IStatisticVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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