EnergyStorageCanvasVisualizer¶

simple module EnergyStorageCanvasVisualizer

Visualizes energyStorages on a 2D canvas.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
IntegratedCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
IntegratedMultiCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
EnergyStorageVisualizer	compound module	Integrates canvas and osg `energyStorage` visualizers into a single module.

Extends¶

Name	Type	Description
EnergyStorageVisualizerBase	simple module	Base module for energy storage visualizer simple 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
zIndex	double	10	Determines the drawing order of figures relative to other visualizers

Properties¶

Name	Value	Description
class	EnergyStorageCanvasVisualizer
display	i=block/app

Source code¶

//
// Visualizes `energyStorages` on a 2D canvas.
//
// @see ~EnergyStorageOsgVisualizer, ~EnergyStorageVisualizer, ~EnergyStorageVisualizerBase, ~IEnergyStorageVisualizer
//
simple EnergyStorageCanvasVisualizer extends EnergyStorageVisualizerBase like IEnergyStorageVisualizer
{
    parameters:
        double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers
        @class(EnergyStorageCanvasVisualizer);
}

File: src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.ned