GateScheduleVisualizer¶

compound module GateScheduleVisualizer

Integrates canvas and osg gate 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.displayGateSchedules	bool	false
canvasVisualizer.labelFormat	string	“%i %D”
canvasVisualizer.gateFilter	string	“**”	Which gates are considered, matches all gates by default
canvasVisualizer.width	double	100
canvasVisualizer.height	double	8
canvasVisualizer.spacing	double	2
canvasVisualizer.placementHint	string	“right”	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.displayDuration	double	0s	Gate operation time duration visualized in the amount of space available, use gate period by default
canvasVisualizer.currentTimePosition	double	width / 2	Position of the current simulation time in the visualization, horizontally centered by default
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.displayGateSchedules	bool	false
osgVisualizer.labelFormat	string	“%i %D”
osgVisualizer.gateFilter	string	“**”	Which gates are considered, matches all gates by default
osgVisualizer.width	double	100
osgVisualizer.height	double	8
osgVisualizer.spacing	double	2
osgVisualizer.placementHint	string	“right”	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
osgVisualizer.displayDuration	double	0s	Gate operation time duration visualized in the amount of space available, use gate period by default
osgVisualizer.currentTimePosition	double	width / 2	Position of the current simulation time in the visualization, horizontally centered by default

Source code¶

//
// Integrates canvas and osg gate visualizers into a single module.
//
// @see ~GateScheduleCanvasVisualizer, ~GateScheduleOsgVisualizer, ~GateScheduleVisualizerBase, ~IGateScheduleVisualizer
//
module GateScheduleVisualizer like IGateScheduleVisualizer
{
    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("GateScheduleCanvasVisualizer"))> like IGateScheduleVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("GateScheduleOsgVisualizer"))> like IGateScheduleVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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