EnergyStorageVisualizer¶

compound module EnergyStorageVisualizer

Integrates canvas and osg energyStorage 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.displayEnergyStorages	bool	false
canvasVisualizer.energyStorageFilter	string	“**”	Which energy storages are considered; matches all energy storages by default
canvasVisualizer.color	string	“green”
canvasVisualizer.width	double	8
canvasVisualizer.height	double	24
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.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.displayEnergyStorages	bool	false
osgVisualizer.energyStorageFilter	string	“**”	Which energy storages are considered; matches all energy storages by default
osgVisualizer.color	string	“green”
osgVisualizer.width	double	8
osgVisualizer.height	double	24
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

Source code¶

//
// Integrates canvas and osg `energyStorage` visualizers into a single module.
//
// @see ~EnergyStorageCanvasVisualizer, ~EnergyStorageOsgVisualizer, ~EnergyStorageVisualizerBase, ~IEnergyStorageVisualizer
//
module EnergyStorageVisualizer like IEnergyStorageVisualizer
{
    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("EnergyStorageCanvasVisualizer"))> like IEnergyStorageVisualizer if typename != "" {
            parameters:
                @display("p=100,100");
        }
        osgVisualizer: <default(firstAvailableOrEmpty("EnergyStorageOsgVisualizer"))> like IEnergyStorageVisualizer if typename != "" {
            parameters:
                @display("p=100,200");
        }
}

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