InstrumentShowcase

Package: inet.showcases.visualizer.canvas.instrumentfigures

InstrumentShowcase

network

(no description)

Ipv4NetworkConfigurator Ieee80211ScalarRadioMedium IntegratedVisualizer AdhocHost AdhocHost

Usage diagram

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

Properties

Name Value Description
isNetwork
display bgb=900,500

Statistics

Name Title Source Record Unit Interpolation Mode
numRcvdPk count(client.app[0].packetReceived) figure
per1 packetErrorRate(client.wlan[0].radio.packetSentToUpper) figure
per2 packetErrorRate(client.wlan[0].radio.packetSentToUpper) figure
bitrate2 server.wlan[0].mac.dcf.rateControl.datarateChanged/1000000 figure
bitrate1 server.wlan[0].mac.dcf.rateControl.datarateChanged/1000000 figure
progress 100 * sum(packetBytes(client.app[0].packetReceived)) / 1048576 figure
throughput liveThroughput(client.app[0].packetReceived)/1000000 figure
ctn server.wlan[0].mac.dcf.channelAccess.contention.stateChanged figure

Unassigned submodule parameters

Name Type Default value Description
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 (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.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
client.status.initialStatus string "UP"

TODO @signal, @statistic
client.pcapRecorder.verbose bool true

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

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

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

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

space-separated list of sibling module names to listen on
client.pcapRecorder.sendingSignalNames string "packetSentToLower"

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

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
client.pcapRecorder.displayStringTextFormat string "rec: %n pks"
client.interfaceTable.displayAddresses bool false

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

determines the text that is written on top of the submodule
client.cb.forwardServiceRegistration bool true
client.cb.forwardProtocolRegistration bool true
client.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
client.bl.forwardServiceRegistration bool true
client.bl.forwardProtocolRegistration bool true
client.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
client.li.forwardServiceRegistration bool true
client.li.forwardProtocolRegistration bool true
client.eth.bitrate double
client.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
client.nl.forwardServiceRegistration bool true
client.nl.forwardProtocolRegistration bool true
client.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
client.tn.forwardServiceRegistration bool true
client.tn.forwardProtocolRegistration bool true
client.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
client.at.forwardServiceRegistration bool true
client.at.forwardProtocolRegistration bool true
server.status.initialStatus string "UP"

TODO @signal, @statistic
server.pcapRecorder.verbose bool true

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

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

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

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

space-separated list of sibling module names to listen on
server.pcapRecorder.sendingSignalNames string "packetSentToLower"

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

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

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

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

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

flush the pcapFile after each write to ensure that all packets are captured in case of a crash
server.pcapRecorder.displayStringTextFormat string "rec: %n pks"
server.interfaceTable.displayAddresses bool false

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

determines the text that is written on top of the submodule
server.cb.forwardServiceRegistration bool true
server.cb.forwardProtocolRegistration bool true
server.bl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
server.bl.forwardServiceRegistration bool true
server.bl.forwardProtocolRegistration bool true
server.li.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
server.li.forwardServiceRegistration bool true
server.li.forwardProtocolRegistration bool true
server.eth.bitrate double
server.nl.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
server.nl.forwardServiceRegistration bool true
server.nl.forwardProtocolRegistration bool true
server.tn.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
server.tn.forwardServiceRegistration bool true
server.tn.forwardProtocolRegistration bool true
server.at.displayStringTextFormat string "processed %p pk (%l)"

determines the text that is written on top of the submodule
server.at.forwardServiceRegistration bool true
server.at.forwardProtocolRegistration bool true

Source code

network InstrumentShowcase
{
    @display("bgb=900,500");

    @statistic[throughput](source=liveThroughput(client.app[0].packetReceived)/1000000; record=figure; targetFigure=throughputGauge; checkSignals=false);
    @figure[throughputGauge](type=gauge; pos=190,30; size=100,100; minValue=0; maxValue=25; tickSize=5; label="App level throughput [Mbps]");

    @statistic[bitrate1](source=server.wlan[0].mac.dcf.rateControl.datarateChanged/1000000; record=figure; targetFigure=bitrateLinearGauge);
    @figure[bitrateLinearGauge](type=linearGauge; pos=320,65; size=250,30; minValue=0; maxValue=54; tickSize=6; label="WiFi bit rate [Mbps]");

    @statistic[progress](source=100 * sum(packetBytes(client.app[0].packetReceived)) / 1048576; record=figure; targetFigure=progressMeter; checkSignals=false);
    @figure[progressMeter](type=progressMeter; pos=200,180; size=420,20; text="%.4g%%"; label="Download progress");

    @statistic[numRcvdPk](source=count(client.app[0].packetReceived); record=figure; targetFigure=numRcvdPkCounter; checkSignals=false);
    @figure[numRcvdPkCounter](type=counter; pos=760,260; label="Packets received"; decimalPlaces=4);

    @statistic[per1](source=packetErrorRate(client.wlan[0].radio.packetSentToUpper); record=figure; targetFigure=perThermometer);
    @figure[perThermometer](type=thermometer; pos=600,30; size=30,100; minValue=0; maxValue=1; tickSize=0.2; label="Packet error rate");

    @statistic[ctn](source=server.wlan[0].mac.dcf.channelAccess.contention.stateChanged; record=figure; targetFigure=ctnIndexedImage); // note: indexedImage takes the value modulo the number of images
    @figure[ctnIndexedImage](type=indexedImage; pos=800,340; size=32,32; images=showcases/idle,showcases/listen,showcases/clock; label="Contention state"; labelOffset=0,25; interpolation=best);

    @statistic[per2](source=packetErrorRate(client.wlan[0].radio.packetSentToUpper); record=figure; targetFigure=perPlot);
    @figure[perPlot](type=plot; pos=700,20; size=150,60; timeWindow=3; maxY=1; yTickSize=1; label="Packet error rate");

    @statistic[bitrate2](source=server.wlan[0].mac.dcf.rateControl.datarateChanged/1000000; record=figure; targetFigure=bitratePlot);
    @figure[bitratePlot](type=plot; pos=700,140; size=150,60; timeWindow=3; maxY=55; yTickSize=54; label="WiFi bit rate [Mbps]");

    submodules:
        configurator: Ipv4NetworkConfigurator {
            @display("p=62,41");
        }
        radioMedium: Ieee80211ScalarRadioMedium {
            @display("p=61,110");
        }
        visualizer: IntegratedVisualizer {
            @display("p=62,170");
        }
        client: AdhocHost {
            @display("p=300,350");
        }
        server: AdhocHost {
            @display("p=250,350");
        }
}
File: showcases/visualizer/canvas/instrumentfigures/InstrumentShowcase.ned

This documentation is released under the Creative Commons license