EnergyStorageVisualizerBase¶

simple module EnergyStorageVisualizerBase

Base module for energy storage visualizer simple modules.

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
EnergyStorageCanvasVisualizer	simple module	Visualizes `energyStorages` on a 2D canvas.
EnergyStorageOsgVisualizer	simple module	Visualizes energy storages on a 3D OSG scene.

Extends¶

Name	Type	Description
VisualizerBase	simple module	Base module for visualizer simple modules. It simply provides the visualization target module for 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
displayEnergyStorages	bool	false
energyStorageFilter	string	“**”	Which energy storages are considered; matches all energy storages by default
color	string	“green”
width	double	8
height	double	24
spacing	double	2
placementHint	string	“right”	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

Properties¶

Name	Value	Description
class	EnergyStorageVisualizerBase
display	i=block/app

Source code¶

//
// Base module for energy storage visualizer simple modules.
//
// @see ~EnergyStorageCanvasVisualizer, ~EnergyStorageOsgVisualizer, ~IEnergyStorageVisualizer, ~VisualizerBase
//
simple EnergyStorageVisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default

        bool displayEnergyStorages = default(false);

        string energyStorageFilter = default("**"); // Which energy storages are considered; matches all energy storages by default

        string color = default("green");
        double width = default(8);
        double height = default(24);
        double spacing = default(2);
        string placementHint = default("right"); // Annotation placement hint; space-separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc.
        double placementPriority = default(0); // Determines the order of annotation positioning

        @class(EnergyStorageVisualizerBase);
}

File: src/inet/visualizer/base/EnergyStorageVisualizerBase.ned