TransportPathVisualizerSimpleWiredShowcase

Package: inet.showcases.visualizer.canvas.transportpathactivity

TransportPathVisualizerSimpleWiredShowcase

network

(no description)

pathVisualizer : TransportRouteCanvasVisualizer Visualizes transport layer routes on a 2D canvas. Source: pathVisualizer: TransportRouteCanvasVisualizer { @display("p=80,80"); } configurator : Ipv4NetworkConfigurator Assigns IPv4 addresses and sets up static routing for an IPv4 network. Source: configurator: Ipv4NetworkConfigurator { @display("p=80,150"); } source : StandardHost A comprehensive model of an IPv4/IPv6 host that provides a complete network stack with configurable... Source: source: StandardHost { @display("p=200,110"); } destination : StandardHost A comprehensive model of an IPv4/IPv6 host that provides a complete network stack with configurable... Source: destination: StandardHost { @display("p=400,110"); }

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Properties

Name Value Description
isNetwork
display bgb=500,250

Unassigned submodule parameters

Name Type Default value Description
pathVisualizer.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
pathVisualizer.visualizationTargetModule string "^"

Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default
pathVisualizer.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
pathVisualizer.tags string ""

Tag added to each visualization for disambiguation in the runtime environment
pathVisualizer.displayRoutes bool false

Display polyline arrow for active routes, disabled by default
pathVisualizer.startPathSignal string "packetReceivedFromUpper"
pathVisualizer.extendPathSignal string "packetReceivedFromLower"
pathVisualizer.endPathSignal string "packetSentToUpper"
pathVisualizer.nodeFilter string "*"

Which nodes are considered, matches all nodes by default
pathVisualizer.packetFilter object "*"

Which packets are considered, matches all packets by default
pathVisualizer.lineColor string "dark"

Route color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default
pathVisualizer.lineStyle string "solid"

Route line style (solid, dashed, dotted)
pathVisualizer.lineWidth double 3

Route line width
pathVisualizer.lineSmooth bool false

When true polylines are displayed as curves
pathVisualizer.lineShift double 16

Route line shift to avoid overlapping routes
pathVisualizer.lineShiftMode string "normal"

Determines how overlapping lines are shifted, possible values are: normal, x, y, z; optional prefix + or -
pathVisualizer.lineContactSpacing double 3

Spacing between arrow end and submodule icon
pathVisualizer.lineContactMode string "rectangular"

Determines how arrows are clipped at the submodules
pathVisualizer.labelFormat string "%n"

Determines what path data is displayed
pathVisualizer.labelFont string ", 8px"

Label font, automatic by default
pathVisualizer.labelColor string ""

Label color, same as line by default
pathVisualizer.fadeOutMode string "realTime"

Specifies how inactive routes fade out
pathVisualizer.fadeOutTime double 1s

How quickly inactive routes fade away, 1 second by default
pathVisualizer.fadeOutAnimationSpeed double 0

Animation speed while there are active routes, value must be in the range (0, +inf)
pathVisualizer.zIndex double 4

Determines the drawing order of figures relative to other visualizers
configurator.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
configurator.minLinkWeight double 1E-3
configurator.configureIsolatedNetworksSeparatly bool false
configurator.config xml xml("")

XML configuration parameters for IP address assignment and adding manual routes
configurator.assignAddresses bool true

Assign IP addresses to all interfaces in the network
configurator.assignUniqueAddresses bool true

Avoid using the same address and raise an error if not possible
configurator.assignDisjunctSubnetAddresses bool true

Avoid using the same address prefix and netmask on different links when assigning IP addresses to interfaces
configurator.addStaticRoutes bool true

Add static routes to the routing tables of all nodes to route to all destination interfaces (only where applicable; turn off when config file contains manual routes)
configurator.addDefaultRoutes bool true

Add default routes if all routes from a source node go through the same gateway (used only if addStaticRoutes is true)
configurator.addSubnetRoutes bool true

Add subnet routes instead of destination interface routes (only where applicable; used only if addStaticRoutes is true)
configurator.addDirectRoutes bool true

Add direct routes towards local network members (i.e. directly connected interfaces) to the routing table (used only if addStaticRoutes is true)
configurator.optimizeRoutes bool true

Optimize routing tables by merging routes, the resulting routing table might route more packets than the original (used only if addStaticRoutes is true)
configurator.updateRoutes bool false

Recalculate static routes if an interface goes down/up or a carrier is lost/back
configurator.dumpTopology bool false

Print extracted network topology to the module output
configurator.dumpLinks bool false

Print recognized network links to the module output
configurator.dumpAddresses bool false

Print assigned IP addresses for all interfaces to the module output
configurator.dumpRoutes bool false

Print configured and optimized routing tables for all nodes to the module output
configurator.dumpConfig string ""

Write configuration into the given config file that can be fed back to speed up subsequent runs (network configurations)
source.status.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.status.initialStatus string "UP"

TODO @signal, @statistic
source.environment.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.environment.initStage int 0

Initialization stage for the setup command
source.environment.globalNamespace bool false

Create new network namespaces under /var/run/netns/ (Linux only)
source.environment.namespace string ""

Name of the host OS network namespace (optional) (Linux only)
source.environment.setupCommand string ""

A host OS system command
source.environment.teardownCommand string ""

A host OS system command
source.pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.pcapRecorder.verbose bool true

Whether to log packets on the module output
source.pcapRecorder.recordEmptyPackets bool true

Specifies if zero length packets are recorded or not
source.pcapRecorder.enableConvertingPackets bool true

Specifies if converting packets to link type is allowed or not
source.pcapRecorder.pcapFile string ""

The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"
source.pcapRecorder.fileFormat string "pcapng"
source.pcapRecorder.snaplen int 65535

Maximum number of bytes to record per packet
source.pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
source.pcapRecorder.dumpBadFrames bool true

Enable dump of frames with hasBitError
source.pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

Space-separated list of sibling module names to listen on
source.pcapRecorder.sendingSignalNames string "transmissionEnded"

Space-separated list of outbound packet signals to subscribe to
source.pcapRecorder.receivingSignalNames string "receptionEnded"

Space-separated list of inbound packet signals to subscribe to
source.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

Space-separated list of protocol names as defined in the Protocol class
source.pcapRecorder.packetFilter object "*"

Which packets are considered, matches all packets by default
source.pcapRecorder.helpers string ""

Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
source.pcapRecorder.alwaysFlush bool false

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
source.interfaceTable.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.interfaceTable.displayAddresses bool false

Whether to display IP addresses on links
source.cb.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
source.cb.forwardServiceRegistration bool true
source.cb.forwardProtocolRegistration bool true
source.cb.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
source.cb.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
source.cb.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
source.bl.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
source.bl.forwardServiceRegistration bool true
source.bl.forwardProtocolRegistration bool true
source.bl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
source.bl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
source.bl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
source.li.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.li.interfaceTableModule string

Module path to the ~InterfaceTable module
source.li.forwardServiceRegistration bool true
source.li.forwardProtocolRegistration bool true
source.li.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
source.li.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
source.li.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
source.eth.bitrate double
source.nl.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.nl.interfaceTableModule string

Module path to the ~InterfaceTable module
source.nl.forwardServiceRegistration bool true
source.nl.forwardProtocolRegistration bool true
source.nl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
source.nl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
source.nl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
source.tn.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.tn.interfaceTableModule string

Module path to the ~InterfaceTable module
source.tn.forwardServiceRegistration bool true
source.tn.forwardProtocolRegistration bool true
source.tn.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
source.tn.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
source.tn.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
source.at.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
source.at.interfaceTableModule string

Module path to the ~InterfaceTable module
source.at.forwardServiceRegistration bool true
source.at.forwardProtocolRegistration bool true
source.at.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
source.at.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
source.at.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
destination.status.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.status.initialStatus string "UP"

TODO @signal, @statistic
destination.environment.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.environment.initStage int 0

Initialization stage for the setup command
destination.environment.globalNamespace bool false

Create new network namespaces under /var/run/netns/ (Linux only)
destination.environment.namespace string ""

Name of the host OS network namespace (optional) (Linux only)
destination.environment.setupCommand string ""

A host OS system command
destination.environment.teardownCommand string ""

A host OS system command
destination.pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.pcapRecorder.verbose bool true

Whether to log packets on the module output
destination.pcapRecorder.recordEmptyPackets bool true

Specifies if zero length packets are recorded or not
destination.pcapRecorder.enableConvertingPackets bool true

Specifies if converting packets to link type is allowed or not
destination.pcapRecorder.pcapFile string ""

The PCAP file to be written, suggested value: pcapFile = "${resultdir}/${configname}-#${runnumber}" + fullpath() + ".pcap"
destination.pcapRecorder.fileFormat string "pcapng"
destination.pcapRecorder.snaplen int 65535

Maximum number of bytes to record per packet
destination.pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
destination.pcapRecorder.dumpBadFrames bool true

Enable dump of frames with hasBitError
destination.pcapRecorder.moduleNamePatterns string "wlan[*] eth[*] ppp[*]"

Space-separated list of sibling module names to listen on
destination.pcapRecorder.sendingSignalNames string "transmissionEnded"

Space-separated list of outbound packet signals to subscribe to
destination.pcapRecorder.receivingSignalNames string "receptionEnded"

Space-separated list of inbound packet signals to subscribe to
destination.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

Space-separated list of protocol names as defined in the Protocol class
destination.pcapRecorder.packetFilter object "*"

Which packets are considered, matches all packets by default
destination.pcapRecorder.helpers string ""

Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype currently available: "inet::AckingMacToEthernetPcapRecorderHelper"
destination.pcapRecorder.alwaysFlush bool false

Flush the pcapFile after each write to ensure that all packets are captured in case of a crash
destination.interfaceTable.displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.interfaceTable.displayAddresses bool false

Whether to display IP addresses on links
destination.cb.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
destination.cb.forwardServiceRegistration bool true
destination.cb.forwardProtocolRegistration bool true
destination.cb.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
destination.cb.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
destination.cb.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
destination.bl.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
destination.bl.forwardServiceRegistration bool true
destination.bl.forwardProtocolRegistration bool true
destination.bl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
destination.bl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
destination.bl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
destination.li.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.li.interfaceTableModule string

Module path to the ~InterfaceTable module
destination.li.forwardServiceRegistration bool true
destination.li.forwardProtocolRegistration bool true
destination.li.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
destination.li.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
destination.li.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
destination.eth.bitrate double
destination.nl.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.nl.interfaceTableModule string

Module path to the ~InterfaceTable module
destination.nl.forwardServiceRegistration bool true
destination.nl.forwardProtocolRegistration bool true
destination.nl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
destination.nl.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
destination.nl.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
destination.tn.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.tn.interfaceTableModule string

Module path to the ~InterfaceTable module
destination.tn.forwardServiceRegistration bool true
destination.tn.forwardProtocolRegistration bool true
destination.tn.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
destination.tn.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
destination.tn.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
destination.at.displayStringTextFormat string "processed %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
destination.at.interfaceTableModule string

Module path to the ~InterfaceTable module
destination.at.forwardServiceRegistration bool true
destination.at.forwardProtocolRegistration bool true
destination.at.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
destination.at.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
destination.at.protocolMapping object {}

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default

Source code

network TransportPathVisualizerSimpleWiredShowcase
{
    @display("bgb=500,250");
    submodules:
        pathVisualizer: TransportRouteCanvasVisualizer {
            @display("p=80,80");
        }
        configurator: Ipv4NetworkConfigurator {
            @display("p=80,150");
        }
        source: StandardHost {
            @display("p=200,110");
        }
        destination: StandardHost {
            @display("p=400,110");
        }
    connections:
        source.ethg++ <--> Eth100M <--> destination.ethg++;
}
File: showcases/visualizer/canvas/transportpathactivity/TransportPathVisualizerShowcase.ned

This documentation is released under the Creative Commons license