VisualizerBase

Package: inet.visualizer.base

simple module VisualizerBase

Base module for visualizer simple modules. It simply provides the visualization target module for derived modules.

inet.visualizer.base.VisualizerBaseVisualizerBasesimple

Inheritance diagram

simple module VisualizerBaseVisualizerBasesimple module SimpleModuleSimpleModulesimple module ChannelVisualizerBaseChannelVisualizerBasesimple module EnergyStorageVisualizerBaseEnergyStorageVisualizerBasesimple module GateScheduleVisualizerBaseGateScheduleVisualizerBasesimple module Ieee80211VisualizerBaseIeee80211VisualizerBasesimple module InfoVisualizerBaseInfoVisualizerBasesimple module InterfaceTableVisualizerBaseInterfaceTableVisualizerBasesimple module LinkBreakVisualizerBaseLinkBreakVisualizerBasesimple module LinkVisualizerBaseLinkVisualizerBasesimple module MediumVisualizerBaseMediumVisualizerBasesimple module MobilityVisualizerBaseMobilityVisualizerBasesimple module NetworkConnectionVisualizerBaseNetworkConnectionVisualizerBasesimple module NetworkNodeVisualizerBaseNetworkNodeVisualizerBasesimple module PacketDropVisualizerBasePacketDropVisualizerBasesimple module PathVisualizerBasePathVisualizerBasesimple module PhysicalEnvironmentVisualizerBasePhysicalEnvironmentVisualizerBasesimple module QueueVisualizerBaseQueueVisualizerBasesimple module RadioVisualizerBaseRadioVisualizerBasesimple module RoutingTableVisualizerBaseRoutingTableVisualizerBasesimple module SceneVisualizerBaseSceneVisualizerBasesimple module StatisticVisualizerBaseStatisticVisualizerBasesimple module TracingObstacleLossVisualizerBaseTracingObstacleLossVisualizerBasesimple module TransportConnectionVisualizerBaseTransportConnectionVisualizerBasesimple module TreeVisualizerBaseTreeVisualizerBasesimple module GeoHorizonCanvasVisualizerGeoHorizonCanvasVisualizersimple module GeoMapCanvasVisualizerGeoMapCanvasVisualizersimple module GeoSkyViewCanvasVisualizerGeoSkyViewCanvasVisualizer

Known subclasses

Name

Type

Description

ChannelVisualizerBase

simple module

(no description)

EnergyStorageVisualizerBase

simple module

Base module for energy storage visualizer simple modules.

GateScheduleVisualizerBase

simple module

Base module for gate visualizer simple modules.

Ieee80211VisualizerBase

simple module

Base module for IEEE 802.11 association visualizer simple modules. It keeps track of wireless interface associations by subscribing to a number of signals at the provided subscription module.

InfoVisualizerBase

simple module

Base module for submodule information visualizer simple modules. It displays some information on network nodes originating from one of their corresponding submodules. No information is displayed by default, see module parameters for how to enable the visualization. The actual visualization is done in derived modules.

InterfaceTableVisualizerBase

simple module

Base module for interface table visualizer simple modules. It displays information of network interfaces at network nodes. Network interfaces are not displayed by default, see module parameters for how to enable the visualization.

LinkBreakVisualizerBase

simple module

Base module for link break visualizer simple modules. It keeps track of link breaks in a network. Link breaks are not displayed by default, see module parameters for how to enable the visualization. The actual visualization of link breaks is done in derived modules.

LinkVisualizerBase

simple module

Base module for link visualizer simple modules. It keeps track of active links in a network. A link between two network nodes is considered active if a packet has been sent recently between the corresponding layers. Active links are not displayed by default, see the module parameters for how to enable the visualization. The actual visualization of active links is done in derived modules.

MediumVisualizerBase

simple module

Base module for medium visualizer simple modules. It keeps track of ongoing signal departures, ongoing signal arrivals, and propagating signals.

MobilityVisualizerBase

simple module

Base module for mobility visualizer simple modules. It subscribes to the mobilityStateChanged signal in the module determined by the visualizationSubjectModule parameter. The actual visualization of mobility is done in derived modules.

NetworkConnectionVisualizerBase

simple module

Base module for connection visualizer simple modules. The actual visualization of network connections is done in derived modules.

NetworkNodeVisualizerBase

simple module

Base module for node visualizer simple modules. The actual visualization of network nodes is done in derived modules.

PacketDropVisualizerBase

simple module

Base module for packet drop visualizer simple modules. It keeps track of dropped packets in a network. Packet drops are not displayed by default, see module parameters for how to enable the visualization. The actual visualization of packet drops is done in derived modules.

PathVisualizerBase

simple module

Base module for path visualizer simple modules. It keeps track of active routes in a network. A route between two nodes is considered active if a packet is sent recently between their corresponding layers. Active routes are not displayed by default, see the module parameters for how to enable the visualization. The actual visualization of active routes is done in derived modules.

PhysicalEnvironmentVisualizerBase

simple module

Base module for physical environment visualizer simple modules. It provides the physical objects through the physical environment module for derived modules. The actual visualization of physical objects is done in derived modules.

QueueVisualizerBase

simple module

Base module for queue visualizer simple modules.

RadioVisualizerBase

simple module

Base module for radio visualizer simple modules.

RoutingTableVisualizerBase

simple module

Base module for routing table visualizer simple modules. It displays routes in the routing tables of the network. Routes present are not displayed by default, see the module parameters for how to enable the visualization. The actual visualization of routes is done in derived modules.

SceneVisualizerBase

simple module

Base module for scene visualizer simple modules. It determines the bounds of the scene, which is the minimum area where the whole simulation fits in. The scene encloses all physical objects and the constraint area of all mobile nodes. The visualizer also provides a timer that can be used to periodically update the user interface independently of the underlying simulation. The actual visualization of the scene is done in derived modules.

StatisticVisualizerBase

simple module

Base module for statistic visualizer simple modules. It keeps track of the last value of a statistic for multiple network nodes. The actual visualization of statistic values is done in derived modules. It subscribes for the signal determined by the signalName parameter at the module specified by the visualizationSubjectModule parameter. If the visualizer receives such a signal, it checks if the source matches the sourceFilter parameter. If the signal passes the check, it determines the last value of the statistic specified by the statisticName parameter.

TracingObstacleLossVisualizerBase

simple module

Base module for tracing obstacle loss visualizer simple modules. It subscribes to the obstacle loss module for physical object penetrated signals. The actual visualization of obstacle loss is done in derived modules.

TransportConnectionVisualizerBase

simple module

Base module for transport connection visualizer simple modules. It keeps track of open transport connections in a network. Open connections are not displayed by default, see the module parameters for how to enable the visualization. The actual visualization of transport connections is done in derived modules.

TreeVisualizerBase

simple module

Base module for tree visualizer modules that display network tree structures such as multicast routing trees, spanning trees, or other hierarchical network relationships. Visualizes tree structures as a set of connected arrows between network nodes, with configurable appearance properties for the connecting lines.

GeoHorizonCanvasVisualizer

simple module

Draws the satellite visibility footprint of the tracked nodes on top of an equirectangular map (e.g. a GeoMapCanvasVisualizer): the area on the Earth from which a node is seen above the elevationMask. The footprint is rebuilt every refresh from each node’s current position.

GeoMapCanvasVisualizer

simple module

Draws a 2D world map on the OMNeT++ canvas: a background map image stretched to the map area and optionally overlaid with a latitude/longitude graticule, plus an optional absolute UTC wall-clock in the lower-left corner. It also sets up the shared canvas projection so that other canvas visualizers drawing scene coordinates (node markers, movement trails, GeoHorizonCanvasVisualizer footprints, …) line up with this map.

GeoSkyViewCanvasVisualizer

simple module

Draws an azimuth/elevation “sky view” polar plot next to each observer node (typically a ground station using a StationaryMobility), showing where the target nodes (typically satellites) currently are in the observer’s sky. The center is the zenith (90 deg elevation), the outer rim is the horizon (0 deg); North is up and East is to the right (azimuth clockwise). Concentric rings mark elevations, the cardinal points (N/E/S/W) are drawn, and the band below elevationMask is masked translucently. Each visible target is a colored dot (optionally named, with a fading sky trail); targets below the horizon are hidden.

Extends

Name

Type

Description

SimpleModule

simple module

Base module for all INET 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

Properties

Name

Value

Description

class

VisualizerBase

display

i=block/app

Source code

//
// Base module for visualizer simple modules. It simply provides the
// visualization target module for derived modules.
//
simple VisualizerBase extends SimpleModule
{
    parameters:
        @class(VisualizerBase);
        string visualizationTargetModule = default("^"); // Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
        string visualizationSubjectModule = default("^"); // 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
        string tags = default(""); // Tag added to each visualization for disambiguation in the runtime environment
        @display("i=block/app");
}

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