GateScheduleVisualizerBase¶

simple module GateScheduleVisualizerBase

Base module for gate visualizer simple modules.

Format string directives:

%i: interface name
%m: gate module name
%d: gate module display name

%D: gate module display name if exists, otherwise gate module name

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
GateScheduleCanvasVisualizer	simple module	Visualizes gates on a 2D canvas.
GateScheduleOsgVisualizer	simple module	Visualizes gates 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
displayGateSchedules	bool	false
labelFormat	string	“%i %D”
gateFilter	string	“**”	Which gates are considered, matches all gates by default
width	double	100
height	double	8
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
displayDuration	double	0s	Gate operation time duration visualized in the amount of space available, use gate period by default
currentTimePosition	double	width / 2	Position of the current simulation time in the visualization, horizontally centered by default

Properties¶

Name	Value	Description
class	GateScheduleVisualizerBase
display	i=block/app

Source code¶

//
// Base module for gate visualizer simple modules.
//
// Format string directives:
//   - %i: interface name
//   - %m: gate module name
//   - %d: gate module display name
//  - %D: gate module display name if exists, otherwise gate module name
//
// @see ~GateScheduleCanvasVisualizer, ~GateScheduleOsgVisualizer, ~IGateScheduleVisualizer, ~VisualizerBase
//
simple GateScheduleVisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default

        bool displayGateSchedules = default(false);
        string labelFormat = default("%i %D");

        string gateFilter = default("**"); // Which gates are considered, matches all gates by default

        double width = default(100);
        double height = default(8);
        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

        double displayDuration @mutable @unit(s) = default(0s); // Gate operation time duration visualized in the amount of space available, use gate period by default
        double currentTimePosition = default(width / 2); // Position of the current simulation time in the visualization, horizontally centered by default

        @class(GateScheduleVisualizerBase);
}

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