NetworkNodeVisualizerShowcase

Package: inet.showcases.visualizer.osg.networknode

NetworkNodeVisualizerShowcase

network

(no description)

visualizer : IntegratedVisualizer Integrates canvas and osg visualizers into a single module. Source: visualizer: IntegratedVisualizer { @display("p=50,50"); } car : AdhocHost A mobile wireless node that participates in ad hoc networks without centralized infrastructure. Source: car: AdhocHost { @display("p=168,117;i=misc/car2"); } pedestrian : AdhocHost A mobile wireless node that participates in ad hoc networks without centralized infrastructure. Source: pedestrian: AdhocHost { @display("p=113,156;i=misc/person"); }

Usage diagram

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

Properties

Name Value Description
isNetwork
display bgb=300,300

Unassigned submodule parameters

Name Type Default value Description
car.status.displayStringTextFormat string ""

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

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

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

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

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

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

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

A host OS system command
car.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
car.pcapRecorder.verbose bool true

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

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

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

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

Maximum number of bytes to record per packet
car.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).
car.pcapRecorder.dumpBadFrames bool true

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

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

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

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

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

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

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

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

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

Whether to display IP addresses on links
car.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
car.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
car.cb.forwardServiceRegistration bool true
car.cb.forwardProtocolRegistration bool true
car.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
car.cb.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
car.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
car.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
car.bl.forwardServiceRegistration bool true
car.bl.forwardProtocolRegistration bool true
car.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
car.bl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
car.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
car.li.interfaceTableModule string

Module path to the ~InterfaceTable module
car.li.forwardServiceRegistration bool true
car.li.forwardProtocolRegistration bool true
car.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
car.li.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
car.eth.bitrate double
car.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
car.nl.interfaceTableModule string

Module path to the ~InterfaceTable module
car.nl.forwardServiceRegistration bool true
car.nl.forwardProtocolRegistration bool true
car.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
car.nl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
car.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
car.tn.interfaceTableModule string

Module path to the ~InterfaceTable module
car.tn.forwardServiceRegistration bool true
car.tn.forwardProtocolRegistration bool true
car.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
car.tn.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
car.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
car.at.interfaceTableModule string

Module path to the ~InterfaceTable module
car.at.forwardServiceRegistration bool true
car.at.forwardProtocolRegistration bool true
car.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
car.at.serviceMapping object {}

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

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

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

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

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

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

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

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

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

A host OS system command
pedestrian.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
pedestrian.pcapRecorder.verbose bool true

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

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

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

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

Maximum number of bytes to record per packet
pedestrian.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).
pedestrian.pcapRecorder.dumpBadFrames bool true

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

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

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

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

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

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

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

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

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

Whether to display IP addresses on links
pedestrian.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
pedestrian.cb.interfaceTableModule string

Module path to the ~InterfaceTable module
pedestrian.cb.forwardServiceRegistration bool true
pedestrian.cb.forwardProtocolRegistration bool true
pedestrian.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
pedestrian.cb.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
pedestrian.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
pedestrian.bl.interfaceTableModule string

Module path to the ~InterfaceTable module
pedestrian.bl.forwardServiceRegistration bool true
pedestrian.bl.forwardProtocolRegistration bool true
pedestrian.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
pedestrian.bl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
pedestrian.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
pedestrian.li.interfaceTableModule string

Module path to the ~InterfaceTable module
pedestrian.li.forwardServiceRegistration bool true
pedestrian.li.forwardProtocolRegistration bool true
pedestrian.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
pedestrian.li.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
pedestrian.eth.bitrate double
pedestrian.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
pedestrian.nl.interfaceTableModule string

Module path to the ~InterfaceTable module
pedestrian.nl.forwardServiceRegistration bool true
pedestrian.nl.forwardProtocolRegistration bool true
pedestrian.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
pedestrian.nl.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
pedestrian.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
pedestrian.tn.interfaceTableModule string

Module path to the ~InterfaceTable module
pedestrian.tn.forwardServiceRegistration bool true
pedestrian.tn.forwardProtocolRegistration bool true
pedestrian.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
pedestrian.tn.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
pedestrian.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
pedestrian.at.interfaceTableModule string

Module path to the ~InterfaceTable module
pedestrian.at.forwardServiceRegistration bool true
pedestrian.at.forwardProtocolRegistration bool true
pedestrian.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
pedestrian.at.serviceMapping object {}

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
pedestrian.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 NetworkNodeVisualizerShowcase
{
    @display("bgb=300,300");
    submodules:
        visualizer: IntegratedVisualizer {
            @display("p=50,50");
        }
        car: AdhocHost {
            @display("p=168,117;i=misc/car2");
        }
        pedestrian: AdhocHost {
            @display("p=113,156;i=misc/person");
        }
}
File: showcases/visualizer/osg/networknode/NetworkNodeVisualizerShowcase.ned

This documentation is released under the Creative Commons license