IVisualizer¶

module interface IVisualizer

Base interface for all visualizer module interfaces in the INET Framework. Defines common parameters for specifying visualization target and subject modules. Visualizers provide graphical representation of various aspects of network simulation, such as links, traffic flows, routing paths, and network state information.

Inheritance diagram¶

Implemented by¶

Name	Type	Description
GateScheduleCanvasVisualizer	simple module	Visualizes gates on a 2D canvas.
InfoCanvasVisualizer	simple module	Visualizes some information of a submodule for each network node on a 2D canvas.
PacketDropCanvasVisualizer	simple module	Visualizes packet drops on a 2D canvas. It displays an icon for each packet drop in the network. See the documentation of the base module for what constitutes a packet drop.
QueueCanvasVisualizer	simple module	Visualizes queues on a 2D canvas.
StatisticCanvasVisualizer	simple module	Visualizes statistics on a 2D canvas. See the base module for how to configure which statistic is displayed. If configured properly, then it displays the last value of the statistic to the right of the visualization of the corresponding network node. The value and the unit are wrapped in a filled white rectangle.
FailureProtectionConfigurationCanvasVisualizer	simple module	(no description)
StreamRedundancyConfigurationCanvasVisualizer	simple module	Visualizes stream redundancy configurations on a canvas by displaying polyline arrows representing redundant paths for streams. Uses information from the StreamRedundancyConfigurator module to identify and display the network paths used for redundant stream transmission in Time-Sensitive Networking (TSN) applications.
PhysicalEnvironmentCanvasVisualizer	simple module	Visualizes a physical environment on a 2D canvas. It displays the physical objects present in the physical environment. Since this is not a 3D visualization, the physical objects are projected to a 2D plane according to the view angle of the corresponding SceneCanvasVisualizer. Apart from this, the visualizer considers all object properties that affect the appearance such as position, orientation, shape, colors, opacity, etc.
PacketFlowCanvasVisualizer	simple module	(no description)
DataLinkCanvasVisualizer	simple module	Visualizes data link layer links on a 2D canvas. It displays an arrow for each active link in the network. See the documentation of the base module for what constitutes an active link. The arrow points from the source towards the destination. If a link is used in both directions, then there are separate arrows for them. Each arrow fades out over time as the link becomes inactive unless it is reinforced by another packet. The arrow automatically follows the movement of mobile nodes.
Ieee80211CanvasVisualizer	simple module	Visualizes IEEE 802.11 associations on a 2D canvas. It displays an icon labeled with the SSID for each associated wireless interface.
InterfaceTableCanvasVisualizer	simple module	Visualizes interface tables on a 2D canvas. It displays a label for each selected network interface at the owner network node.
LinkBreakCanvasVisualizer	simple module	Visualizes link breaks on a 2D canvas. It displays an icon for each link break in the network. See the documentation of the base module for what constitutes a link break. The icon is positioned at the midpoint of the link.
MobilityCanvasVisualizer	simple module	Visualizes multiple mobilities on a 2D canvas. It moves visual representations according to their mobility model. It also displays recent movement as a polyline, current velocity vector, and current orientation.
NetworkRouteCanvasVisualizer	simple module	Visualizes network routes on a 2D canvas. It displays a polyline arrow for each active route in the network. See the documentation of the base module for what constitutes an active route. The arrow points from the source towards the destination. If a link is used in both directions, then there are arrowheads on both ends of the arrow. Each polyline fades out over time until the route becomes inactive unless it is reinforced by another packet. The polyline automatically follows the movement of mobile nodes.
RoutingTableCanvasVisualizer	simple module	Visualizes routes in the routing tables on a 2D canvas. It displays an arrow for each route in the routing tables of the network. The arrow points from the node containing the routing table towards the gateway. The arrow automatically follows the movement of mobile nodes.
MediumCanvasVisualizer	simple module	Visualizes a medium on a 2D canvas. It displays communication ranges and interference ranges as circles around network nodes. It displays an image at network nodes which are currently transmitting, and a different image at other network nodes which are currently receiving. It also displays radio signals as a 2D ring or a 3D sphere as they propagate through the medium.
PhysicalLinkCanvasVisualizer	simple module	Visualizes physical layer links on a 2D canvas. It displays an arrow for each active link in the network. See the documentation of the base module for what constitutes an active link. The arrow points from the source towards the destination. If a link is used in both directions then there are separate arrows for them. Each arrow fades out over time as the link becomes inactive unless it is reinforced by another packet. The arrow automatically follows the movement of mobile nodes.
RadioCanvasVisualizer	simple module	Visualizes radios on a 2D canvas.
TracingObstacleLossCanvasVisualizer	simple module	Visualizes obstacle loss on a 2D canvas. It displays a line at the intersections of signal propagation paths with physical objects, and normal vectors of physical object faces at intersection points.
EnergyStorageCanvasVisualizer	simple module	Visualizes `energyStorages` on a 2D canvas.
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.
NetworkConnectionCanvasVisualizer	simple module	Visualizes multiple network connections on a 2D canvas.
NetworkNodeCanvasVisualizer	simple module	Visualizes multiple network nodes on a 2D canvas. It maintains a `NetworkNodeCanvasVisualization` figure for each node in the network which can be annotated by other visualizers.
OpenStreetMapSceneCanvasVisualizer	simple module	Visualizes a stream map given in an OpenStreetMap (openstreetmap.org) file. Other objects of the scene are placed on the map according to the coordinate system module.
SceneCanvasVisualizer	simple module	Visualizes the scene on a 2D canvas. It provides the 3D coordinate system’s 2D orthographic projection for other visualizers. This is used to get a consistent visualization across all visualizers. It can also display the coordinate system axes.
TransportConnectionCanvasVisualizer	simple module	Visualizes transport layer connections on a 2D canvas. It displays a pair of colored icons for each connection at the network nodes where the connection starts or ends.
TransportRouteCanvasVisualizer	simple module	Visualizes transport layer routes on a 2D canvas. It displays a polyline arrow for each active route in the network. See the documentation of the base module for what constitutes an active route. The arrow points from the source towards the destination. If a route is used in both directions then there are separate paths for them. Each polyline fades out over time as the route becomes inactive unless it is reinforced by another packet. The polyline automatically follows the movement of mobile nodes.
DataLinkVisualizer	compound module	Integrates canvas and osg data link visualizers into a single module.
EnergyStorageVisualizer	compound module	Integrates canvas and osg `energyStorage` visualizers into a single module.
GateScheduleVisualizer	compound module	Integrates canvas and osg gate visualizers into a single module.
Ieee80211Visualizer	compound module	Integrates canvas and osg IEEE 802.11 association visualizers into a single module.
InfoVisualizer	compound module	Integrates canvas and osg info visualizers into a single module.
InterfaceTableVisualizer	compound module	(no description)
LinkBreakVisualizer	compound module	Integrates canvas and osg link break visualizers into a single module.
MediumVisualizer	compound module	Integrates canvas and osg medium visualizers into a single module.
MobilityVisualizer	compound module	Integrates canvas and osg mobility visualizers into a single module.
NetworkConnectionVisualizer	compound module	Integrates canvas and OSG connection visualizers into a single module.
NetworkNodeVisualizer	compound module	Integrates canvas and osg node visualizers into a single module.
NetworkRouteVisualizer	compound module	Integrates canvas and osg network route visualizers into a single module.
PacketDropVisualizer	compound module	Integrates canvas and osg packet drop visualizers into a single module.
PacketFlowVisualizer	compound module	(no description)
PhysicalEnvironmentVisualizer	compound module	Integrates canvas and OSG physical environment visualizers into a single module.
PhysicalLinkVisualizer	compound module	Integrates canvas and osg data link visualizers into a single module.
QueueVisualizer	compound module	Integrates canvas and osg queue visualizers into a single module.
RadioVisualizer	compound module	Integrates canvas and osg radio visualizers into a single module.
RoutingTableVisualizer	compound module	Integrates canvas and osg routing table visualizers into a single module.
SceneVisualizer	compound module	Integrates canvas and osg scene visualizers into a single module.
StatisticVisualizer	compound module	Integrates canvas and osg statistic visualizers into a single module.
TracingObstacleLossVisualizer	compound module	Integrates canvas and osg obstacle loss visualizers into a single module.
TransportConnectionVisualizer	compound module	Integrates canvas and osg transport connection visualizers into a single module.
TransportRouteVisualizer	compound module	Integrates canvas and osg transport route visualizers into a single module.
GateScheduleOsgVisualizer	simple module	Visualizes gates on a 3D osg scene.
InfoOsgVisualizer	simple module	Visualizes some information of a submodule for each network node on a 3D osg scene.
PacketDropOsgVisualizer	simple module	Visualizes packet drops on a 3D osg scene. It displays an icon for each packet drop in the network. See the documentation of the base module for what constitutes a packet drop.
QueueOsgVisualizer	simple module	Visualizes queues on a 3D osg scene.
StatisticOsgVisualizer	simple module	Visualizes a statistic on a 3D osg scene. See the base module for how to configure which statistic is displayed. If configured properly, then it displays the last value of the statistic just above the visualization of the corresponding network node. The value and the unit are wrapped in a filled rectangle.
PhysicalEnvironmentOsgVisualizer	simple module	Visualizes a physical environment on a 3D osg scene. It displays the physical objects present in the physical environment. The visualizer considers all object properties that affect appearance such as position, orientation, shape, colors, opacity, etc.
PacketFlowOsgVisualizer	simple module	(no description)
DataLinkOsgVisualizer	simple module	Visualizes data link layer links on a 3D osg scene. It displays an arrow for each active link in the network. See the documentation of the base module for what constitutes an active link. The arrow points from the source towards the destination. If a link is used in both directions then there are separate arrows for them. Each arrow fades out over time as the link becomes inactive unless it is reinforced by another packet. The arrow automatically follows the movement of mobile nodes.
Ieee80211OsgVisualizer	simple module	Visualizes IEEE 802.11 associations in a 3D osg scene. It displays an icon labeled with the SSID for each associated wireless interface.
InterfaceTableOsgVisualizer	simple module	Visualizes interface tables on a 3D osg scene. It displays a label for each selected network interface at the owner network node.
LinkBreakOsgVisualizer	simple module	Visualizes link breaks on a 3D osg scene. It displays an icon for each link break in the network. See the documentation of the base module for what constitutes a link break. The icon is positioned at the middle point of the link.
MobilityOsgVisualizer	simple module	Visualizes multiple mobilities on a 3D osg scene. It moves the visual representation according to their mobility model. It also displays recent movement as a polyline, current velocity vector, and current orientation.
NetworkRouteOsgVisualizer	simple module	Visualizes network routes on a 3D osg scene. It displays a polyline for each active route in the network. See the documentation of the base module for what constitutes an active route. Each polyline fades out over time until the route becomes inactive unless it is reinforced by another packet. The polyline automatically follows the movement of mobile nodes.
RoutingTableOsgVisualizer	simple module	Visualizes routes in the routing tables on a 3D osg scene. It displays an arrow for each route in the routing tables of the network. The arrow points from the node containing the routing table towards the gateway. The arrow automatically follows the movement of mobile nodes.
MediumOsgVisualizer	simple module	Visualizes a medium using a 3D osg scene. It displays communication ranges and interference ranges as circles around network nodes. It displays an image at network nodes which are currently transmitting, and a different image at other network nodes which are currently receiving. It also displays radio signals as a growing 2D ring or a 3D sphere as they propagate through the medium. All 2D shapes such as circles, rings, and images can be displayed in 4 different planes: camera, xy, xz, and yz. It’s also possible to use animated images.
PhysicalLinkOsgVisualizer	simple module	Visualizes physical layer links on a 3D osg scene. It displays an arrow for each active link in the network. See the documentation of the base module for what constitutes an active link. The arrow points from the source towards the destination. If a link is used in both directions, then there are separate arrows for them. Each arrow fades out over time as the link becomes inactive unless it is reinforced by another packet. The arrow automatically follows the movement of mobile nodes.
RadioOsgVisualizer	simple module	Visualizes radios on a 3D osg scene.
TracingObstacleLossOsgVisualizer	simple module	Visualizes obstacle loss on a 3D osg scene. It displays a line at the intersections of signal propagation paths with physical objects, and normal vectors of physical object faces at intersection points.
EnergyStorageOsgVisualizer	simple module	Visualizes energy storages on a 3D OSG scene.
NetworkConnectionOsgVisualizer	simple module	Visualizes multiple network connections on a 3D OSG scene.
NetworkNodeOsgVisualizer	simple module	Visualizes multiple network nodes on a 3D osg scene. The visual representation is either a 3D external model or a 2D icon that is rotated automatically towards the camera. The 3D external model is specified in the `osgModel` module parameter of the network node. The 2D icon is the image specified in the display string of the network node. The visualizer maintains a `NetworkNodeOsgVisualization` instance for each network node which can be annotated by other visualizers.
SceneOsgEarthVisualizer	simple module	Visualizes the scene using `osgEarth`. It displays a 3D osg map of some part of the earth as an integrated part of the 3D visualization of the simulation. The map is loaded from an external resource specified by the `mapFile` parameter. The scene is placed on the map according to the coordinate system module.
SceneOsgVisualizer	simple module	Visualizes the scene using osg. It displays the scene and the coordinate system axes. It sets the initial viewpoint of the 3D scene based on the bounding sphere of all network nodes. The viewpoint is located opposite to the coordinate system origin with respect to the sphere, and it faces towards the center of the sphere.
TransportConnectionOsgVisualizer	simple module	Visualizes transport layer connections in a 3D osg scene. It displays a pair of colored icons for each connection at the network nodes where the connection starts or ends.
TransportRouteOsgVisualizer	simple module	Visualizes transport layer routes on a 3D osg scene. It displays a polyline arrow for each active route in the network. See the documentation of the base module for what constitutes an active route. The arrow points from the source towards the destination. If a route is used in both directions then there are separate paths for them. Each polyline fades out over time as the route becomes inactive unless it is reinforced by another packet. The polyline automatically follows the movement of mobile nodes.

Known subclasses¶

Name	Type	Description
IDataLinkVisualizer	module interface	Interface allows configuring different IDataLinkVisualizer submodules from INI files. Such a visualizer displays the active data link layer links in a network.
IEnergyStorageVisualizer	module interface	Interface allows configuring different IEnergyStorageVisualizer submodules from INI files. Such a visualizer displays energy storages.
IFailureProtectionConfigurationVisualizer	module interface	Interface allows configuring different IFailureProtectionConfigurationVisualizer submodules from INI files. Such a visualizer displays the TSN configuration in a network.
IGateScheduleVisualizer	module interface	Interface allows configuring different IGateScheduleVisualizer submodules from INI files. Such a visualizer displays gates.
IGeoHorizonVisualizer	module interface	Interface allows configuring different IGeoHorizonVisualizer submodules from INI files. Such a visualizer draws the satellite visibility footprint (the area on the Earth from which a node is seen above an elevation mask) on a 2D map.
IGeoMapVisualizer	module interface	Interface allows configuring different IGeoMapVisualizer submodules from INI files. Such a visualizer projects geographically located network nodes onto a 2D world map.
IGeoSkyViewVisualizer	module interface	Interface allows configuring different IGeoSkyViewVisualizer submodules from INI files. Such a visualizer draws an azimuth/elevation sky view polar plot next to each observer node, showing where the target nodes (e.g. satellites) are in the observer’s sky.
IIeee80211Visualizer	module interface	Interface allows configuring different IIeee80211Visualizer submodules from INI files. Such a visualizer displays IEEE 802.11 network interface associations.
IInfoVisualizer	module interface	Interface allows configuring different IInfoVisualizer submodules from INI files. Such a visualizer displays various information from submodules of network nodes.
IInterfaceTableVisualizer	module interface	Interface allows configuring different IInterfaceTableVisualizer submodules from INI files. Such a visualizer displays various information for network interfaces present in the interface tables of a network.
ILinkBreakVisualizer	module interface	Interface allows configuring different ILinkBreakVisualizer submodules from INI files. Such a visualizer displays the data link breaks in a network.
IMediumVisualizer	module interface	Interface allows configuring different IMediumVisualizer submodules from INI files. Such a visualizer displays transmitting nodes, receiving nodes, and propagating radio signals on a medium.
IMobilityVisualizer	module interface	Interface allows configuring different IMobilityVisualizer submodules from INI files. Such a visualizer updates the position (among others) of visual representations according to the corresponding mobility model.
INetworkConnectionVisualizer	module interface	Interface allows configuring different INetworkConnectionVisualizer submodules from INI files. Such a visualizer creates the visual representations of network connections.
INetworkNodeVisualizer	module interface	Interface allows configuring different INetworkNodeVisualizer submodules from INI files. Such a visualizer creates the visual representations of network nodes.
INetworkRouteVisualizer	module interface	Interface allows configuring different INetworkRouteVisualizer submodules from INI files. Such a visualizer displays active network routes in a network.
IPacketDropVisualizer	module interface	Interface allows configuring different IPacketDropVisualizer submodules from INI files. Such a visualizer displays the packet drops in a network.
IPacketFlowVisualizer	module interface	(no description)
IPhysicalEnvironmentVisualizer	module interface	Interface allows configuring different IPhysicalEnvironmentVisualizer submodules from INI files. Such a visualizer displays the physical objects present in the physical environment.
IPhysicalLinkVisualizer	module interface	Interface allows configuring different IPhysicalLinkVisualizer submodules from INI files. Such a visualizer displays the active physical layer links in a network.
IQueueVisualizer	module interface	Interface allows configuring different IQueueVisualizer submodules from INI files. Such a visualizer displays queues.
IRadioVisualizer	module interface	Interface allows configuring different IRadioVisualizer submodules from INI files. Such a visualizer displays radios.
IRoutingTableVisualizer	module interface	Interface allows configuring different IRoutingTableVisualizer submodules from INI files. Such a visualizer displays routes present in the routing tables of a network.
ISceneVisualizer	module interface	Interface allows configuring different ISceneVisualizer submodules from INI files. Such a visualizer displays the scene, the coordinate axes, sets up the initial viewpoint, etc.
IStatisticVisualizer	module interface	Interface allows configuring different IStatisticVisualizer submodules from INI files. Such a visualizer displays a statistic for multiple network nodes.
IStreamRedundancyConfigurationVisualizer	module interface	Interface allows configuring different IStreamRedundancyConfigurationVisualizer submodules from INI files. Such a visualizer displays the `StreamRedundancy` configuration in a network.
ITracingObstacleLossVisualizer	module interface	Interface allows configuring different ITracingObstacleLossVisualizer submodules from INI files. Such a visualizer displays obstacle loss during wireless signal propagation.
ITransportConnectionVisualizer	module interface	Interface allows configuring different ITransportConnectionVisualizer submodules from INI files. Such a visualizer displays the active transport connections in a network.
ITransportRouteVisualizer	module interface	Interface allows configuring different ITransportRouteVisualizer submodules from INI files. Such a visualizer displays active transport routes in a network.

Parameters¶

Name	Type	Default value	Description
visualizationTargetModule	string
visualizationSubjectModule	string

Properties¶

Name	Value	Description
display	i=block/app

Source code¶

//
// Base interface for all visualizer module interfaces in the INET Framework.
// Defines common parameters for specifying visualization target and subject
// modules. Visualizers provide graphical representation of various aspects of
// network simulation, such as links, traffic flows, routing paths, and network
// state information.
//
moduleinterface IVisualizer
{
    parameters:
        string visualizationTargetModule;
        string visualizationSubjectModule;
        @display("i=block/app");
}

File: src/inet/visualizer/contract/IVisualizer.ned