AntennaDirectionalSelectivityExample

Package: inet.examples.wireless.antenna

AntennaDirectionalSelectivityExample

network

(no description)

visualizer : like IIntegratedVisualizer IIntegratedVisualizer: Interface allows configuring different ~IIntegratedVisualizer submodules from INI files. Source: visualizer: <default(firstAvailableOrEmpty("IntegratedCanvasVisualizer"))> like IIntegratedVisualizer if typename != "" { parameters: @display("p=100,300;is=s"); } configurator : Ipv4NetworkConfigurator Assigns IPv4 addresses and sets up static routing for an IPv4 network. Source: configurator: Ipv4NetworkConfigurator { parameters: @display("p=100,100;is=s"); } radioMedium : Ieee80211ScalarRadioMedium This radio medium model uses scalar transmission power in the analog representation. Source: radioMedium: Ieee80211ScalarRadioMedium { parameters: @display("p=100,200;is=s"); } hostA : AdhocHost A mobile wireless node that participates in ad hoc networks without centralized infrastructure. Source: hostA: AdhocHost { parameters: @display("p=250,200"); } hostB : AdhocHost A mobile wireless node that participates in ad hoc networks without centralized infrastructure. Source: hostB: AdhocHost { parameters: @display("p=400,200"); }

Usage diagram

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

Properties

Name Value Description
isNetwork
display bgb=1000,1000

Statistics

Name Title Source Record Unit Interpolation Mode Description
receptionPower receptionMinSignalPower(radioMedium.signalArrivalStarted) vector

Unassigned submodule parameters

Name Type Default value Description
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)
radioMedium.neighborCache.refillPeriod double
hostA.status.displayStringTextFormat string ""

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default
hostB.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 AntennaDirectionalSelectivityExample
{
    parameters:
        @display("bgb=1000,1000");
        @statistic[receptionPower](source="receptionMinSignalPower(radioMedium.signalArrivalStarted)"; record=vector);
    submodules:
        visualizer: <default(firstAvailableOrEmpty("IntegratedCanvasVisualizer"))> like IIntegratedVisualizer if typename != "" {
            parameters:
                @display("p=100,300;is=s");
        }
        configurator: Ipv4NetworkConfigurator {
            parameters:
                @display("p=100,100;is=s");
        }
        radioMedium: Ieee80211ScalarRadioMedium {
            parameters:
                @display("p=100,200;is=s");
        }
        hostA: AdhocHost {
            parameters:
                @display("p=250,200");
        }
        hostB: AdhocHost {
            parameters:
                @display("p=400,200");
        }
}
File: examples/wireless/antenna/Network.ned

This documentation is released under the Creative Commons license