Throughput

Package: inet.examples.wireless.throughput

Throughput

network

(no description)

IIntegratedVisualizer Ieee80211ScalarRadioMedium ThroughputClient WirelessAPWithSink

Usage diagram

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

Parameters

Name Type Default value Description
numCli int

Properties

Name Value Description
isNetwork

Unassigned submodule parameters

Name Type Default value Description
radioMedium.neighborCache.refillPeriod double
cliHost.cli.interfaceTableModule string
cliHost.cli.destAddress string ""

destination MAC address, or module path name of destination station; empty means off
cliHost.cli.startTime double this.sendInterval

time of sending the first request
cliHost.cli.stopTime double -1s

time of finishing sending, negative values mean forever
cliHost.cli.localSAP int 0xf0

local service access point
cliHost.cli.remoteSAP int 0xf1

remote service access point
cliHost.cli.sendInterval double uniform(0s,1s)

interval between sending requests
cliHost.cli.reqLength int 100B

length of request packets
cliHost.cli.respLength int 1KiB

length of response packets
cliHost.cli.stopOperationExtraTime double -1s

extra time after lifecycle stop operation finished
cliHost.cli.stopOperationTimeout double 2s

timeout value for lifecycle stop operation
cliHost.wlan.pcapRecorder.verbose bool true

whether to log packets on the module output
cliHost.wlan.pcapRecorder.pcapFile string ""

the PCAP file to be written
cliHost.wlan.pcapRecorder.fileFormat string "pcapng"
cliHost.wlan.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
cliHost.wlan.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
cliHost.wlan.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
cliHost.wlan.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
cliHost.wlan.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
cliHost.wlan.pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
cliHost.wlan.pcapRecorder.helpers string ""

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
cliHost.wlan.pcapRecorder.displayStringTextFormat string "rec: %n pks"
cliHost.wlan.mgmt.macModule string

The path to the MAC module
cliHost.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
cliHost.mobility.subjectModule string "^"

module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module
cliHost.mobility.coordinateSystemModule string ""

module path of the geographic coordinate system module
cliHost.mobility.displayStringTextFormat string "p: %p\nv: %v"

format string for the mobility module's display string text
cliHost.mobility.updateDisplayString bool true

enables continuous update of the subject module's position via modifying its display string
cliHost.mobility.constraintAreaMinX double -inf m

min x position of the constraint area, unconstrained by default (negative infinity)
cliHost.mobility.constraintAreaMinY double -inf m

min y position of the constraint area, unconstrained by default (negative infinity)
cliHost.mobility.constraintAreaMinZ double -inf m

min z position of the constraint area, unconstrained by default (negative infinity)
cliHost.mobility.constraintAreaMaxX double inf m

max x position of the constraint area, unconstrained by default (positive infinity)
cliHost.mobility.constraintAreaMaxY double inf m

max y position of the constraint area, unconstrained by default (positive infinity)
cliHost.mobility.constraintAreaMaxZ double inf m

max z position of the constraint area, unconstrained by default (positive infinity)
cliHost.mobility.initialX double uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
cliHost.mobility.initialY double uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
cliHost.mobility.initialZ double nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
cliHost.mobility.initialLatitude double nan deg
cliHost.mobility.initialLongitude double nan deg
cliHost.mobility.initialAltitude double 0m
cliHost.mobility.initialHeading double 0deg
cliHost.mobility.initialElevation double 0deg
cliHost.mobility.initialBank double 0deg
cliHost.mobility.initFromDisplayString bool true

enables one time initialization from the subject module's display string
cliHost.mobility.updateFromDisplayString bool true

enables continuous update from the subject module's display string for dragging and rotating it
ap.interfaceTable.displayAddresses bool false

whether to display IP addresses on links
ap.sink.displayStringTextFormat string "received %p pk (%l)"

determines the text that is written on top of the submodule
ap.sink.clockModule string ""

relative path of a module that implements IClock(1,2); optional
ap.sink.consumptionInterval double 0s

elapsed time between subsequent packets allowed to be pushed by the connected packet producer, 0 means any number of packets can be pushed at the same simulation time
ap.sink.scheduleForAbsoluteTime bool true

when a clock is used relative means that setting the clock will not affect the simulation time of the event
ap.wlan.pcapRecorder.verbose bool true

whether to log packets on the module output
ap.wlan.pcapRecorder.pcapFile string ""

the PCAP file to be written
ap.wlan.pcapRecorder.fileFormat string "pcapng"
ap.wlan.pcapRecorder.snaplen int 65535

maximum number of bytes to record per packet
ap.wlan.pcapRecorder.dumpBadFrames bool true

enable dump of frames with hasBitError
ap.wlan.pcapRecorder.sendingSignalNames string "packetSentToLower"

space-separated list of outbound packet signals to subscribe to
ap.wlan.pcapRecorder.receivingSignalNames string "packetReceivedFromLower"

space-separated list of inbound packet signals to subscribe to
ap.wlan.pcapRecorder.dumpProtocols string "ethernetmac ppp ieee80211mac"

space-separated list of protocol names as defined in the Protocol class
ap.wlan.pcapRecorder.packetFilter object "*"

which packets are considered, matches all packets by default
ap.wlan.pcapRecorder.helpers string ""

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
ap.wlan.pcapRecorder.displayStringTextFormat string "rec: %n pks"
ap.wlan.mgmt.macModule string

The path to the MAC module
ap.mobility.subjectModule string "^"

module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module
ap.mobility.coordinateSystemModule string ""

module path of the geographic coordinate system module
ap.mobility.displayStringTextFormat string "p: %p\nv: %v"

format string for the mobility module's display string text
ap.mobility.updateDisplayString bool true

enables continuous update of the subject module's position via modifying its display string
ap.mobility.constraintAreaMinX double -inf m

min x position of the constraint area, unconstrained by default (negative infinity)
ap.mobility.constraintAreaMinY double -inf m

min y position of the constraint area, unconstrained by default (negative infinity)
ap.mobility.constraintAreaMinZ double -inf m

min z position of the constraint area, unconstrained by default (negative infinity)
ap.mobility.constraintAreaMaxX double inf m

max x position of the constraint area, unconstrained by default (positive infinity)
ap.mobility.constraintAreaMaxY double inf m

max y position of the constraint area, unconstrained by default (positive infinity)
ap.mobility.constraintAreaMaxZ double inf m

max z position of the constraint area, unconstrained by default (positive infinity)
ap.mobility.initialX double uniform(this.constraintAreaMinX, this.constraintAreaMaxX)
ap.mobility.initialY double uniform(this.constraintAreaMinY, this.constraintAreaMaxY)
ap.mobility.initialZ double nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))
ap.mobility.initialLatitude double nan deg
ap.mobility.initialLongitude double nan deg
ap.mobility.initialAltitude double 0m
ap.mobility.initialHeading double 0deg
ap.mobility.initialElevation double 0deg
ap.mobility.initialBank double 0deg
ap.mobility.initFromDisplayString bool true

enables one time initialization from the subject module's display string
ap.mobility.updateFromDisplayString bool true

enables continuous update from the subject module's display string for dragging and rotating it

Source code

network Throughput
{
    parameters:
        int numCli;
    submodules:
        visualizer: <default(firstAvailableOrEmpty("IntegratedCanvasVisualizer"))> like IIntegratedVisualizer if typename != "" {
            parameters:
                @display("p=100,200;is=s");
        }
        radioMedium: Ieee80211ScalarRadioMedium {
            parameters:
                @display("p=100,100;is=s");
        }
        cliHost[numCli]: ThroughputClient {
            parameters:
                @display("r=,,#707070");
        }
        ap: WirelessAPWithSink {
            parameters:
                @display("p=200,200;r=,,#707070");
        }
}
File: examples/wireless/throughput/Throughput.ned

This documentation is released under the Creative Commons license