EnergyStorageVisualizerBase

simple module

This is a base module for energy storage visualizer simple modules.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Known subclasses

Name	Type	Description
EnergyStorageCanvasVisualizer	simple module	This module visualizes energyStorages on a 2D canvas.
EnergyStorageOsgVisualizer	simple module	This module visualizes energyStorages on a 3D osg scene.

Extends

Name	Type	Description
VisualizerBase	simple module	This is a base module for visualizer simple modules. It simply provides the visualization target module for derived modules.

Parameters

Name	Type	Default value	Description
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

//
// This is a 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