Package: inet.visualizer.base
GateScheduleVisualizerBase
simple moduleThis is a 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 also: GateScheduleCanvasVisualizer, GateScheduleOsgVisualizer, IGateScheduleVisualizer, VisualizerBase
Inheritance diagram
The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.
Known subclasses
Name | Type | Description |
---|---|---|
GateScheduleCanvasVisualizer | simple module |
This module visualizes gates on a 2D canvas. |
GateScheduleOsgVisualizer | simple module |
This module visualizes gates 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 |
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, horizontal center by default |
Properties
Name | Value | Description |
---|---|---|
class | GateScheduleVisualizerBase | |
display | i=block/app |
Source code
// // This is a 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, horizontal center by default @class(GateScheduleVisualizerBase); }File: src/inet/visualizer/base/GateScheduleVisualizerBase.ned