Package: inet.visualizer.canvas.networklayer
NetworkRouteCanvasVisualizer
simple moduleThis module visualizes network routes on a 2D canvas. It displays an 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.
See also: NetworkRouteOsgVisualizer, NetworkRouteVisualizer, PathVisualizerBase, INetworkRouteVisualizer
Inheritance diagram
The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.
Extends
Name | Type | Description |
---|---|---|
PathVisualizerBase | simple module |
This is a base module for path visualizer simple modules. It keeps track of active routes in a network. A route between two node 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. |
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 |
displayRoutes | bool | false |
display polyline arrow for active routes, disabled by default |
startPathSignal | string | "packetReceivedFromUpper" | |
extendPathSignal | string | "packetReceivedFromLower" | |
endPathSignal | string | "packetSentToUpper" | |
nodeFilter | string | "*" |
which nodes are considered, matches all nodes by default |
packetFilter | object | "*" |
which packets are considered, matches all packets by default |
lineColor | string | "dark" |
route color is a list of colors, a set of dark colors by default |
lineStyle | string | "solid" |
route line style (solid, dashed, dotted) |
lineWidth | double | 3 |
route line width |
lineSmooth | bool | false |
when true polylines are displayed as curves |
lineShift | double | 16 |
route line shift to avoid overlapping routes |
lineShiftMode | string | "normal" |
determines how overlapping lines are shifted, possible values are: normal, x, y, z; optional prefix + or - |
lineContactSpacing | double | 3 |
spacing between arrow end and submodule icon |
lineContactMode | string | "rectangular" |
determines how arrows are clipped at the submodules |
labelFormat | string | "%n" |
determines what path data is displayed |
labelFont | string | " |
label font, automatic by default |
labelColor | string | "" |
label color, same as line by default |
fadeOutMode | string | "realTime" |
specifies how inactive routes fade out |
fadeOutTime | double | 1s |
how quickly inactive routes fade away, 1 second by default |
fadeOutAnimationSpeed | double | 0 |
animation speed while there are active routes, value must be in the range (0, +inf) |
zIndex | double | 3 |
determines the drawing order of figures relative to other visualizers |
Properties
Name | Value | Description |
---|---|---|
class | NetworkRouteCanvasVisualizer | |
display | i=block/app |
Source code
// // This module visualizes network routes on a 2D canvas. It displays an // 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. // // @see ~NetworkRouteOsgVisualizer, ~NetworkRouteVisualizer, ~PathVisualizerBase, ~INetworkRouteVisualizer // simple NetworkRouteCanvasVisualizer extends PathVisualizerBase like INetworkRouteVisualizer { parameters: double zIndex = default(3); // determines the drawing order of figures relative to other visualizers @class(NetworkRouteCanvasVisualizer); }File: src/inet/visualizer/canvas/networklayer/NetworkRouteCanvasVisualizer.ned