From 3d0b39420f71de8d25aa55fea85c7838e5c23bbb Mon Sep 17 00:00:00 2001 From: Andras Varga Date: Mon, 13 May 2024 18:15:09 +0200 Subject: [PATCH] src: NED files: Make parameter comments to start with capital letter It looks much better in the generated documentation, and avoids inconsistency amond comments when some comments contain full sentences. Using regex case-sensitive find/replace: "(; +// [a-z])" --> "\U$1" --- .../clock/SimpleClockSynchronizer.ned | 2 +- src/inet/applications/dhcp/DhcpClient.ned | 12 +- src/inet/applications/dhcp/DhcpServer.ned | 18 +- .../applications/ethernet/EtherAppClient.ned | 22 +-- .../applications/ethernet/EtherAppServer.ned | 4 +- .../applications/ethernet/EtherTrafGen.ned | 22 +-- .../applications/ethernet/EthernetApp.ned | 2 +- .../ethernet/EthernetSocketIo.ned | 16 +- .../applications/external/ExternalApp.ned | 2 +- src/inet/applications/generic/IpvxTrafGen.ned | 14 +- .../applications/generic/IpvxTrafSink.ned | 2 +- .../ieee8022/Ieee8022LlcSocketIo.ned | 4 +- src/inet/applications/ipapp/IpSocketIo.ned | 4 +- .../netperfmeter/NetPerfMeter.ned | 10 +- src/inet/applications/pingapp/PingApp.ned | 28 +-- .../applications/rtpapp/RtpApplication.ned | 24 +-- src/inet/applications/sctpapp/SctpClient.ned | 22 +-- src/inet/applications/sctpapp/SctpNatPeer.ned | 22 +-- .../applications/sctpapp/SctpNatServer.ned | 8 +- src/inet/applications/sctpapp/SctpPeer.ned | 20 +- src/inet/applications/sctpapp/SctpServer.ned | 12 +- .../applications/tcpapp/TcpBasicClientApp.ned | 40 ++-- .../applications/tcpapp/TcpClientSocketIo.ned | 6 +- src/inet/applications/tcpapp/TcpEchoApp.ned | 8 +- .../tcpapp/TcpGenericServerApp.ned | 14 +- src/inet/applications/tcpapp/TcpServerApp.ned | 2 +- .../applications/tcpapp/TcpServerHostApp.ned | 10 +- .../applications/tcpapp/TcpServerListener.ned | 8 +- .../applications/tcpapp/TcpServerSocketIo.ned | 4 +- .../applications/tcpapp/TcpSessionApp.ned | 18 +- src/inet/applications/tcpapp/TcpSinkApp.ned | 6 +- src/inet/applications/tcpapp/TelnetApp.ned | 42 ++--- .../applications/tcpapp/TelnetClientApp.ned | 8 +- src/inet/applications/tunapp/TunnelApp.ned | 4 +- src/inet/applications/udpapp/UdpBasicApp.ned | 32 ++-- .../applications/udpapp/UdpBasicBurst.ned | 38 ++-- src/inet/applications/udpapp/UdpEchoApp.ned | 6 +- src/inet/applications/udpapp/UdpSink.ned | 16 +- src/inet/applications/udpapp/UdpSocketIo.ned | 20 +- .../udpapp/UdpVideoStreamClient.ned | 10 +- .../udpapp/UdpVideoStreamServer.ned | 18 +- .../applications/voip/SimpleVoipReceiver.ned | 20 +- .../applications/voip/SimpleVoipSender.ned | 8 +- .../voipstream/VoipStreamReceiver.ned | 4 +- .../voipstream/VoipStreamSender.ned | 12 +- src/inet/clock/base/ClockBase.ned | 4 +- .../clock/base/DriftingOscillatorBase.ned | 4 +- src/inet/clock/base/OscillatorBase.ned | 2 +- src/inet/clock/model/MultiClock.ned | 4 +- src/inet/clock/model/OscillatorBasedClock.ned | 6 +- .../oscillator/ConstantDriftOscillator.ned | 2 +- .../oscillator/RandomDriftOscillator.ned | 10 +- src/inet/common/ExternalEnvironment.ned | 10 +- src/inet/common/ExternalProcess.ned | 10 +- src/inet/common/MessageDispatcher.ned | 8 +- src/inet/common/ResidenceTimeMeasurer.ned | 6 +- .../common/GeographicCoordinateSystem.ned | 18 +- src/inet/common/lifecycle/NodeStatus.ned | 2 +- .../common/misc/ThruputMeteringChannel.ned | 2 +- .../common/packet/recorder/PcapRecorder.ned | 24 +-- .../linklayer/ethernet/ExtEthernetSocket.ned | 4 +- .../ethernet/ExtEthernetTapDevice.ned | 2 +- .../ethernet/ExtUpperEthernetInterface.ned | 2 +- .../ieee80211/ExtUpperIeee80211Interface.ned | 2 +- .../common/PhysicalEnvironment.ned | 14 +- .../objectcache/BvhObjectCache.ned | 2 +- .../objectcache/GridObjectCache.ned | 6 +- src/inet/linklayer/acking/AckingMac.ned | 2 +- .../common/FailureProtectionConfigurator.ned | 2 +- .../common/L2NodeConfigurator.ned | 2 +- .../common/StreamRedundancyConfigurator.ned | 6 +- .../base/GateScheduleConfiguratorBase.ned | 4 +- src/inet/linklayer/contract/IEthernetMac.ned | 10 +- src/inet/linklayer/csmaca/CsmaCaMac.ned | 14 +- .../ethernet/basic/EthernetCsmaMac.ned | 26 +-- .../ethernet/basic/EthernetEncapsulation.ned | 6 +- .../ethernet/basic/EthernetInterface.ned | 4 +- .../linklayer/ethernet/basic/EthernetMac.ned | 22 +-- .../ethernet/common/BridgingLayer.ned | 2 +- .../common/DirectionReverserLayer.ned | 2 +- .../ethernet/common/RelayInterfaceLearner.ned | 4 +- .../common/RelayInterfaceSelector.ned | 4 +- .../modular/EthernetPauseCommandProcessor.ned | 2 +- .../ieee80211/mac/channelaccess/Edca.ned | 2 +- .../ieee80211/mac/contention/Contention.ned | 4 +- .../mac/rateselection/QosRateSelection.ned | 8 +- .../mac/rateselection/RateSelection.ned | 8 +- .../ieee80211/mgmt/IIeee80211Mgmt.ned | 4 +- .../ieee80211/mgmt/Ieee80211AgentSta.ned | 18 +- .../ieee80211/mgmt/Ieee80211MgmtAdhoc.ned | 4 +- .../ieee80211/mgmt/Ieee80211MgmtAp.ned | 10 +- .../mgmt/Ieee80211MgmtApSimplified.ned | 8 +- .../ieee80211/mgmt/Ieee80211MgmtSta.ned | 6 +- .../mgmt/Ieee80211MgmtStaSimplified.ned | 4 +- src/inet/linklayer/ieee8021as/Gptp.ned | 24 +-- src/inet/linklayer/ieee8021as/GptpMaster.ned | 2 +- src/inet/linklayer/ieee8021as/GptpSlave.ned | 2 +- .../linklayer/ieee8021as/MultiDomainGptp.ned | 6 +- .../ieee8021q/DualIeee8021qFilter.ned | 6 +- .../ieee8021q/Ieee8021qCreditBasedGate.ned | 4 +- .../linklayer/ieee8021q/Ieee8021qFilter.ned | 8 +- .../ieee8021q/Ieee8021qTimeAwareShaper.ned | 4 +- .../linklayer/ieee8021q/PcpClassifier.ned | 4 +- .../ieee8021q/PcpTrafficClassClassifier.ned | 2 +- .../ieee8021q/SimpleIeee8021qFilter.ned | 4 +- src/inet/linklayer/ppp/Ppp.ned | 6 +- src/inet/linklayer/shortcut/ShortcutMac.ned | 8 +- src/inet/linklayer/tun/Tun.ned | 4 +- src/inet/linklayer/vlan/VlanIndFilter.ned | 2 +- src/inet/linklayer/vlan/VlanReqFilter.ned | 2 +- src/inet/linklayer/vlan/VlanReqMapper.ned | 2 +- src/inet/mobility/base/MobilityBase.ned | 22 +-- src/inet/mobility/base/MovingMobilityBase.ned | 2 +- src/inet/mobility/single/AnsimMobility.ned | 2 +- .../mobility/single/BonnMotionMobility.ned | 6 +- src/inet/mobility/single/CircleMobility.ned | 12 +- src/inet/mobility/single/FacingMobility.ned | 4 +- .../mobility/single/GaussMarkovMobility.ned | 4 +- src/inet/mobility/single/LinearMobility.ned | 4 +- src/inet/mobility/single/MassMobility.ned | 14 +- .../mobility/single/Ns2MotionMobility.ned | 4 +- .../single/RandomWaypointMobility.ned | 6 +- .../mobility/single/RectangleMobility.ned | 4 +- .../single/SuperpositioningMobility.ned | 4 +- src/inet/mobility/single/TractorMobility.ned | 2 +- src/inet/mobility/single/TurtleMobility.ned | 2 +- src/inet/mobility/single/VehicleMobility.ned | 8 +- .../mobility/static/StationaryMobility.ned | 4 +- src/inet/networklayer/arp/ipv4/Arp.ned | 12 +- src/inet/networklayer/arp/ipv4/GlobalArp.ned | 2 +- .../networklayer/common/InterfaceTable.ned | 2 +- .../ipv4/HostAutoConfigurator.ned | 8 +- .../ipv4/Ipv4FlatNetworkConfigurator.ned | 4 +- .../ipv4/Ipv4NetworkConfigurator.ned | 28 +-- .../ipv4/Ipv4NodeConfigurator.ned | 4 +- .../nexthop/NextHopNetworkConfigurator.ned | 6 +- src/inet/networklayer/diffserv/AFxyQueue.ned | 20 +- .../diffserv/BehaviorAggregateClassifier.ned | 2 +- .../networklayer/diffserv/DiffservQueue.ned | 4 +- src/inet/networklayer/diffserv/DscpMarker.ned | 2 +- .../diffserv/SingleRateThreeColorMeter.ned | 8 +- .../diffserv/TokenBucketMeter.ned | 6 +- .../diffserv/TwoRateThreeColorMeter.ned | 12 +- src/inet/networklayer/flooding/Flooding.ned | 4 +- .../icmpv6/Ipv6NeighbourDiscovery.ned | 2 +- src/inet/networklayer/ipv4/Icmp.ned | 4 +- src/inet/networklayer/ipv4/Igmpv2.ned | 4 +- src/inet/networklayer/ipv4/Igmpv3.ned | 4 +- src/inet/networklayer/ipv4/Ipv4.ned | 10 +- .../networklayer/ipv4/Ipv4RoutingTable.ned | 10 +- src/inet/networklayer/ipv4/ipsec/IPsec.ned | 34 ++-- src/inet/networklayer/ldp/Ldp.ned | 4 +- src/inet/networklayer/mpls/LibTable.ned | 2 +- .../nexthop/NextHopRoutingTable.ned | 6 +- .../probabilistic/ProbabilisticBroadcast.ned | 2 +- src/inet/networklayer/rsvpte/RsvpTe.ned | 6 +- src/inet/networklayer/wiseroute/WiseRoute.ned | 2 +- src/inet/node/base/LinkLayerNodeBase.ned | 4 +- src/inet/node/base/NodeBase.ned | 6 +- src/inet/node/ethernet/EthernetHost.ned | 2 +- src/inet/node/ethernet/EthernetSwitch.ned | 2 +- src/inet/node/inet/StandardHost.ned | 4 +- src/inet/node/tsn/TsnClock.ned | 12 +- src/inet/node/tsn/TsnDevice.ned | 48 ++--- src/inet/node/tsn/TsnSwitch.ned | 46 ++--- src/inet/node/wireless/AccessPoint.ned | 2 +- .../apsk/bitlevel/ApskLayeredTransmitter.ned | 8 +- .../DimensionalMediumAnalogModel.ned | 2 +- .../DimensionalReceiverAnalogModel.ned | 2 +- .../DimensionalTransmitterAnalogModel.ned | 16 +- .../scalar/ScalarMediumAnalogModel.ned | 2 +- .../scalar/ScalarReceiverAnalogModel.ned | 2 +- .../scalar/ScalarTransmitterAnalogModel.ned | 6 +- .../unitdisk/UnitDiskReceiverAnalogModel.ned | 2 +- .../UnitDiskTransmitterAnalogModel.ned | 6 +- .../antenna/AxiallySymmetricAntenna.ned | 4 +- .../common/antenna/ConstantGainAntenna.ned | 2 +- .../wireless/common/antenna/CosineAntenna.ned | 2 +- .../wireless/common/antenna/DipoleAntenna.ned | 4 +- .../common/antenna/InterpolatingAntenna.ned | 6 +- .../common/antenna/ParabolicAntenna.ned | 4 +- .../DimensionalBackgroundNoise.ned | 12 +- .../IsotropicDimensionalBackgroundNoise.ned | 6 +- .../IsotropicScalarBackgroundNoise.ned | 2 +- .../common/base/packetlevel/AntennaBase.ned | 6 +- .../DimensionalTransmitterBase.ned | 10 +- .../base/packetlevel/ErrorModelBase.ned | 2 +- .../base/packetlevel/NarrowbandRadioBase.ned | 8 +- .../packetlevel/NarrowbandReceiverBase.ned | 10 +- .../packetlevel/NarrowbandTransmitterBase.ned | 12 +- .../base/packetlevel/PropagationBase.ned | 2 +- .../common/base/packetlevel/ReceiverBase.ned | 2 +- .../base/packetlevel/SnirReceiverBase.ned | 2 +- .../packetlevel/TracingObstacleLossBase.ned | 2 +- .../base/packetlevel/TransmitterBase.ned | 2 +- .../common/contract/packetlevel/IRadio.ned | 20 +- .../packetlevel/StochasticErrorModel.ned | 6 +- .../common/medium/MediumLimitCache.ned | 12 +- .../wireless/common/medium/RadioMedium.ned | 14 +- .../neighborcache/GridNeighborCache.ned | 6 +- .../obstacleloss/DielectricObstacleLoss.ned | 4 +- .../pathloss/TwoRayGroundReflection.ned | 2 +- .../propagation/ConstantSpeedPropagation.ned | 6 +- .../propagation/ConstantTimePropagation.ned | 2 +- .../common/radio/packetlevel/Radio.ned | 16 +- .../wireless/generic/GenericReceiver.ned | 2 +- .../wireless/generic/GenericTransmitter.ned | 6 +- .../ieee80211/packetlevel/Ieee80211Radio.ned | 10 +- .../Ieee80211StateBasedCcEnergyConsumer.ned | 6 +- .../Ieee80211StateBasedEpEnergyConsumer.ned | 6 +- .../wireless/noise/NoiseSource.ned | 2 +- .../wireless/noise/NoiseTransmitter.ned | 2 +- .../wireless/shortcut/ShortcutRadio.ned | 10 +- .../consumer/AlternatingEpEnergyConsumer.ned | 8 +- .../AlternatingEpEnergyGenerator.ned | 8 +- .../management/SimpleEpEnergyManagement.ned | 4 +- src/inet/power/storage/CcBatteryPack.ned | 10 +- src/inet/power/storage/SimpleCcBattery.ned | 8 +- .../power/storage/SimpleEpEnergyStorage.ned | 6 +- .../common/InterpacketGapInserter.ned | 4 +- .../protocolelement/common/PacketEmitter.ned | 2 +- .../protocolelement/common/PacketStreamer.ned | 2 +- .../fragmentation/PreemptableStreamer.ned | 2 +- .../redundancy/StreamClassifier.ned | 6 +- .../redundancy/StreamDecoder.ned | 4 +- .../redundancy/StreamEncoder.ned | 2 +- .../redundancy/StreamFilter.ned | 2 +- .../redundancy/StreamIdentifier.ned | 2 +- .../redundancy/StreamMerger.ned | 4 +- .../redundancy/StreamSplitter.ned | 2 +- .../shaper/EligibilityTimeFilter.ned | 4 +- .../shaper/EligibilityTimeGate.ned | 2 +- .../shaper/EligibilityTimeMeter.ned | 10 +- .../shaper/EligibilityTimeQueue.ned | 2 +- .../shaper/GroupEligibilityTimeMeter.ned | 6 +- .../base/PacketTransmitterBase.ned | 2 +- src/inet/queueing/base/PacketBufferBase.ned | 2 +- src/inet/queueing/base/PacketDelayerBase.ned | 2 +- src/inet/queueing/base/PacketFilterBase.ned | 2 +- src/inet/queueing/base/PacketLabelerBase.ned | 2 +- .../queueing/base/PacketProcessorBase.ned | 2 +- src/inet/queueing/base/PacketQueueBase.ned | 2 +- src/inet/queueing/base/PacketSourceBase.ned | 4 +- src/inet/queueing/base/PacketTaggerBase.ned | 18 +- src/inet/queueing/base/TokenGeneratorBase.ned | 4 +- src/inet/queueing/buffer/PacketBuffer.ned | 6 +- .../classifier/ContentBasedClassifier.ned | 4 +- .../DualRateThreeColorClassifier.ned | 10 +- .../queueing/classifier/LabelClassifier.ned | 4 +- .../queueing/classifier/MarkovClassifier.ned | 8 +- .../classifier/MultiTokenBucketClassifier.ned | 6 +- .../queueing/classifier/PacketClassifier.ned | 2 +- .../SingleRateThreeColorClassifier.ned | 8 +- .../SingleRateTwoColorClassifier.ned | 6 +- .../classifier/TokenBucketClassifier.ned | 10 +- .../common/OrdinalBasedDuplicator.ned | 2 +- src/inet/queueing/common/PacketDelayer.ned | 4 +- src/inet/queueing/common/PacketDuplicator.ned | 2 +- src/inet/queueing/common/PacketHistory.ned | 2 +- .../queueing/common/QueueingPacketDelayer.ned | 2 +- .../queueing/filter/ContentBasedFilter.ned | 2 +- src/inet/queueing/filter/LabelFilter.ned | 2 +- .../queueing/filter/OrdinalBasedDropper.ned | 2 +- src/inet/queueing/filter/PacketFilter.ned | 2 +- src/inet/queueing/filter/RedDropper.ned | 14 +- .../queueing/flow/FlowMeasurementRecorder.ned | 10 +- .../queueing/flow/FlowMeasurementStarter.ned | 10 +- src/inet/queueing/gate/CreditBasedGate.ned | 16 +- src/inet/queueing/gate/GateControlList.ned | 8 +- src/inet/queueing/gate/PacketGate.ned | 2 +- src/inet/queueing/gate/PeriodicGate.ned | 12 +- .../queueing/marker/ContentBasedLabeler.ned | 2 +- .../queueing/marker/ContentBasedTagger.ned | 2 +- src/inet/queueing/marker/PacketLabeler.ned | 4 +- src/inet/queueing/marker/PacketTagger.ned | 2 +- .../meter/DualRateThreeColorMeter.ned | 12 +- .../queueing/meter/ExponentialRateMeter.ned | 2 +- .../queueing/meter/MultiTokenBucketMeter.ned | 10 +- .../meter/SingleRateThreeColorMeter.ned | 10 +- .../meter/SingleRateTwoColorMeter.ned | 8 +- .../queueing/meter/SlidingWindowRateMeter.ned | 2 +- src/inet/queueing/meter/TokenBucketMeter.ned | 18 +- .../queue/CompoundPacketQueueBase.ned | 6 +- .../queueing/queue/GatingPriorityQueue.ned | 2 +- src/inet/queueing/queue/GatingQueue.ned | 2 +- src/inet/queueing/queue/PacketQueue.ned | 12 +- .../scheduler/ContentBasedScheduler.ned | 4 +- .../queueing/scheduler/LabelScheduler.ned | 4 +- .../queueing/scheduler/MarkovScheduler.ned | 8 +- .../queueing/scheduler/PacketScheduler.ned | 2 +- src/inet/queueing/server/InstantServer.ned | 2 +- src/inet/queueing/server/PacketServer.ned | 8 +- src/inet/queueing/server/PreemptingServer.ned | 2 +- src/inet/queueing/server/TokenBasedServer.ned | 10 +- src/inet/queueing/sink/ActivePacketSink.ned | 8 +- src/inet/queueing/sink/PassivePacketSink.ned | 8 +- .../queueing/sink/PcapFilePacketConsumer.ned | 12 +- .../queueing/source/ActivePacketSource.ned | 8 +- .../queueing/source/PassivePacketSource.ned | 8 +- .../source/PcapFilePacketProducer.ned | 4 +- .../PacketBasedTokenGenerator.ned | 4 +- .../QueueBasedTokenGenerator.ned | 4 +- .../SignalBasedTokenGenerator.ned | 2 +- .../TimeBasedTokenGenerator.ned | 6 +- src/inet/routing/aodv/Aodv.ned | 52 +++--- src/inet/routing/bgpv4/Bgp.ned | 8 +- src/inet/routing/dsdv/Dsdv.ned | 6 +- src/inet/routing/dymo/Dymo.ned | 2 +- src/inet/routing/gpsr/Gpsr.ned | 2 +- src/inet/routing/ospfv2/Ospfv2.ned | 20 +- src/inet/routing/pim/modes/PimSm.ned | 2 +- src/inet/routing/rip/Rip.ned | 16 +- .../transportlayer/rtp/RtpPayloadReceiver.ned | 4 +- src/inet/transportlayer/sctp/Sctp.ned | 10 +- src/inet/transportlayer/tcp/Tcp.ned | 14 +- src/inet/transportlayer/tcp/TcpConnection.ned | 112 +++++------ .../transportlayer/tcp_common/TcpSpoof.ned | 14 +- .../tcp_lwip/TcpLwipConnection.ned | 24 +-- src/inet/transportlayer/udp/Udp.ned | 4 +- .../visualizer/base/ChannelVisualizerBase.ned | 32 ++-- .../base/EnergyStorageVisualizerBase.ned | 8 +- .../base/GateScheduleVisualizerBase.ned | 12 +- .../base/Ieee80211VisualizerBase.ned | 24 +-- .../visualizer/base/InfoVisualizerBase.ned | 24 +-- .../base/InterfaceTableVisualizerBase.ned | 26 +-- .../base/LinkBreakVisualizerBase.ned | 14 +- .../visualizer/base/LinkVisualizerBase.ned | 38 ++-- .../visualizer/base/MediumVisualizerBase.ned | 174 +++++++++--------- .../base/MobilityVisualizerBase.ned | 66 +++---- .../base/NetworkConnectionVisualizerBase.ned | 8 +- .../base/NetworkNodeVisualizerBase.ned | 2 +- .../base/PacketDropVisualizerBase.ned | 28 +-- .../visualizer/base/PathVisualizerBase.ned | 34 ++-- .../PhysicalEnvironmentVisualizerBase.ned | 2 +- .../visualizer/base/QueueVisualizerBase.ned | 8 +- .../visualizer/base/RadioVisualizerBase.ned | 30 +-- .../base/RoutingTableVisualizerBase.ned | 36 ++-- .../visualizer/base/SceneVisualizerBase.ned | 20 +- .../base/StatisticVisualizerBase.ned | 32 ++-- .../TracingObstacleLossVisualizerBase.ned | 10 +- .../TransportConnectionVisualizerBase.ned | 24 +-- .../visualizer/base/TreeVisualizerBase.ned | 18 +- src/inet/visualizer/base/VisualizerBase.ned | 6 +- .../common/GateScheduleCanvasVisualizer.ned | 2 +- .../canvas/common/InfoCanvasVisualizer.ned | 2 +- .../common/PacketDropCanvasVisualizer.ned | 6 +- .../canvas/common/QueueCanvasVisualizer.ned | 2 +- .../common/StatisticCanvasVisualizer.ned | 6 +- ...rotectionConfigurationCanvasVisualizer.ned | 2 +- ...edundancyConfigurationCanvasVisualizer.ned | 2 +- .../PhysicalEnvironmentCanvasVisualizer.ned | 2 +- .../flow/PacketFlowCanvasVisualizer.ned | 2 +- .../linklayer/DataLinkCanvasVisualizer.ned | 2 +- .../linklayer/Ieee80211CanvasVisualizer.ned | 2 +- .../InterfaceTableCanvasVisualizer.ned | 4 +- .../linklayer/LinkBreakCanvasVisualizer.ned | 2 +- .../mobility/MobilityCanvasVisualizer.ned | 2 +- .../NetworkRouteCanvasVisualizer.ned | 2 +- .../RoutingTableCanvasVisualizer.ned | 2 +- .../physicallayer/ChannelCanvasVisualizer.ned | 2 +- .../physicallayer/MediumCanvasVisualizer.ned | 28 +-- .../PhysicalLinkCanvasVisualizer.ned | 2 +- .../physicallayer/RadioCanvasVisualizer.ned | 2 +- .../TracingObstacleLossCanvasVisualizer.ned | 2 +- .../power/EnergyStorageCanvasVisualizer.ned | 2 +- .../NetworkConnectionCanvasVisualizer.ned | 4 +- .../scene/NetworkNodeCanvasVisualizer.ned | 2 +- .../OpenStreetMapSceneCanvasVisualizer.ned | 6 +- .../canvas/scene/SceneCanvasVisualizer.ned | 10 +- .../TransportConnectionCanvasVisualizer.ned | 2 +- .../TransportRouteCanvasVisualizer.ned | 2 +- .../osg/base/SceneOsgVisualizerBase.ned | 24 +-- .../PhysicalEnvironmentOsgVisualizer.ned | 2 +- .../osg/physicallayer/MediumOsgVisualizer.ned | 26 +-- .../osg/scene/NetworkNodeOsgVisualizer.ned | 2 +- .../osg/scene/SceneOsgEarthVisualizer.ned | 4 +- .../osg/scene/SceneOsgVisualizer.ned | 2 +- 377 files changed, 1697 insertions(+), 1697 deletions(-) diff --git a/src/inet/applications/clock/SimpleClockSynchronizer.ned b/src/inet/applications/clock/SimpleClockSynchronizer.ned index 7ff6cef4ad1..8b7d2697c9b 100644 --- a/src/inet/applications/clock/SimpleClockSynchronizer.ned +++ b/src/inet/applications/clock/SimpleClockSynchronizer.ned @@ -20,7 +20,7 @@ simple SimpleClockSynchronizer like IApp parameters: string masterClockModule; string slaveClockModule; - volatile double synchronizationInterval @unit(s); // clock synchronization period + volatile double synchronizationInterval @unit(s); // Clock synchronization period volatile double synchronizationClockTimeError @unit(s) = default(0s); // 0 means slave clock time equals master clock time after synchronization volatile double synchronizationOscillatorCompensationError @unit(ppm) = default(0ppm); // 0 means slave clock speed equals master clock speed after synchronization @display("i=block/app"); diff --git a/src/inet/applications/dhcp/DhcpClient.ned b/src/inet/applications/dhcp/DhcpClient.ned index 35cff31f354..13d34c162c1 100644 --- a/src/inet/applications/dhcp/DhcpClient.ned +++ b/src/inet/applications/dhcp/DhcpClient.ned @@ -20,14 +20,14 @@ import inet.applications.contract.IApp; simple DhcpClient like IApp { parameters: - string interfaceTableModule; // path to the InterfaceTable module - string routingTableModule; // path to the Ipv4RoutingTable module - string interface = default(""); // which NIC should be configured (i.e. wlan0, eth1 etc.) - double startTime @unit(s) = default(0s); // starting time of DHCP initialization + string interfaceTableModule; // Path to the InterfaceTable module + string routingTableModule; // Path to the Ipv4RoutingTable module + string interface = default(""); // Which NIC should be configured (i.e. wlan0, eth1 etc.) + double startTime @unit(s) = default(0s); // Starting time of DHCP initialization @display("i=block/app2"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @selfMessageKinds(inet::DhcpTimerType); gates: input socketIn @labels(UdpControlInfo/up); diff --git a/src/inet/applications/dhcp/DhcpServer.ned b/src/inet/applications/dhcp/DhcpServer.ned index e988976789a..b7acee80fbc 100644 --- a/src/inet/applications/dhcp/DhcpServer.ned +++ b/src/inet/applications/dhcp/DhcpServer.ned @@ -20,17 +20,17 @@ import inet.applications.contract.IApp; simple DhcpServer like IApp { parameters: - string interfaceTableModule; // the path to the InterfaceTable module - string interface = default(""); // interface to listen on; can be left empty if there is only one non-loopback interface - int numReservedAddresses; // number of addresses to skip at the start of the network's address range - int maxNumClients; // maximum number of clients (IPs) allowed to be leased - string gateway = default(""); // gateway to assign, if empty use the interface address - int leaseTime @unit(s); // lease time in seconds - double startTime @unit(s) = default(0s); // application start time + string interfaceTableModule; // The path to the InterfaceTable module + string interface = default(""); // Interface to listen on; can be left empty if there is only one non-loopback interface + int numReservedAddresses; // Number of addresses to skip at the start of the network's address range + int maxNumClients; // Maximum number of clients (IPs) allowed to be leased + string gateway = default(""); // Gateway to assign, if empty use the interface address + int leaseTime @unit(s); // Lease time in seconds + double startTime @unit(s) = default(0s); // Application start time @display("i=block/app2"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation gates: input socketIn @labels(UdpControlInfo/up); output socketOut @labels(UdpControlInfo/down); diff --git a/src/inet/applications/ethernet/EtherAppClient.ned b/src/inet/applications/ethernet/EtherAppClient.ned index adc12e212f9..2ea21004df8 100644 --- a/src/inet/applications/ethernet/EtherAppClient.ned +++ b/src/inet/applications/ethernet/EtherAppClient.ned @@ -16,18 +16,18 @@ simple EtherAppClient { parameters: string interfaceTableModule; - string destAddress = default(""); // destination MAC address, or module path name of destination station; empty means off - string interface = default(""); // outgoing interface name; empty accepted only when the destAddress is empty - double startTime @unit(s) = default(this.sendInterval); // time of sending the first request - double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever - int localSAP = default(0xf0); // local service access point - int remoteSAP = default(0xf1); // remote service access point - volatile double sendInterval @unit(s) = default(uniform(0s,1s)); // interval between sending requests - volatile int reqLength @unit(B) = default(100B); // length of request packets - volatile int respLength @unit(B) = default(1KiB); // length of response packets + string destAddress = default(""); // Destination MAC address, or module path name of destination station; empty means off + string interface = default(""); // Outgoing interface name; empty accepted only when the destAddress is empty + double startTime @unit(s) = default(this.sendInterval); // Time of sending the first request + double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever + int localSAP = default(0xf0); // Local service access point + int remoteSAP = default(0xf1); // Remote service access point + volatile double sendInterval @unit(s) = default(uniform(0s,1s)); // Interval between sending requests + volatile int reqLength @unit(B) = default(100B); // Length of request packets + volatile int respLength @unit(B) = default(1KiB); // Length of response packets @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @display("i=block/app"); @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); diff --git a/src/inet/applications/ethernet/EtherAppServer.ned b/src/inet/applications/ethernet/EtherAppServer.ned index 86c4eb5df24..13869feae5e 100644 --- a/src/inet/applications/ethernet/EtherAppServer.ned +++ b/src/inet/applications/ethernet/EtherAppServer.ned @@ -17,8 +17,8 @@ simple EtherAppServer parameters: int localSAP = default(0xf1); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @display("i=block/app"); @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); diff --git a/src/inet/applications/ethernet/EtherTrafGen.ned b/src/inet/applications/ethernet/EtherTrafGen.ned index 1ff97fb56f5..a357c0a0dea 100644 --- a/src/inet/applications/ethernet/EtherTrafGen.ned +++ b/src/inet/applications/ethernet/EtherTrafGen.ned @@ -15,19 +15,19 @@ package inet.applications.ethernet; simple EtherTrafGen { parameters: - string destAddress = default(""); // destination MAC address, or module path name of destination station; empty means off - string interface; // outgoing interface + string destAddress = default(""); // Destination MAC address, or module path name of destination station; empty means off + string interface; // Outgoing interface string interfaceTableModule; - int ssap = default(-1); // llc ssap to set on outgoing packets - int dsap = default(-1); // llc dsap to set on outgoing packets - double startTime @unit(s) = default(this.sendInterval); // time of sending the first packet - double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever - volatile double sendInterval @unit(s); // interval between sending bursts - volatile int numPacketsPerBurst = default(1); // number of packets to send per burst (packets within a burst are sent at the same simulation time) - volatile int packetLength @unit(B); // length of packets to send + int ssap = default(-1); // Llc ssap to set on outgoing packets + int dsap = default(-1); // Llc dsap to set on outgoing packets + double startTime @unit(s) = default(this.sendInterval); // Time of sending the first packet + double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever + volatile double sendInterval @unit(s); // Interval between sending bursts + volatile int numPacketsPerBurst = default(1); // Number of packets to send per burst (packets within a burst are sent at the same simulation time) + volatile int packetLength @unit(B); // Length of packets to send @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @display("i=block/app"); @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); diff --git a/src/inet/applications/ethernet/EthernetApp.ned b/src/inet/applications/ethernet/EthernetApp.ned index 46ed37553c6..2b36ad1e6cf 100644 --- a/src/inet/applications/ethernet/EthernetApp.ned +++ b/src/inet/applications/ethernet/EthernetApp.ned @@ -19,7 +19,7 @@ import inet.queueing.contract.IPassivePacketSink; module EthernetApp like IApp { parameters: - string interfaceTableModule; // relative module path of the interface table + string interfaceTableModule; // Relative module path of the interface table *.interfaceTableModule = default(absPath(this.interfaceTableModule)); @application; @display("i=block/app"); diff --git a/src/inet/applications/ethernet/EthernetSocketIo.ned b/src/inet/applications/ethernet/EthernetSocketIo.ned index 946b993edac..88fd9b1f4c0 100644 --- a/src/inet/applications/ethernet/EthernetSocketIo.ned +++ b/src/inet/applications/ethernet/EthernetSocketIo.ned @@ -13,14 +13,14 @@ package inet.applications.ethernet; simple EthernetSocketIo { parameters: - string interfaceTableModule; // relative module path of the interface table - string interface = default(""); // network interface name - string protocol = default(""); // bind the socket to this protocol if specified - string localAddress = default(""); // local Ethernet MAC address - string remoteAddress = default(""); // remove Ethernet MAC address - bool steal = default(false); // steal packets - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + string interfaceTableModule; // Relative module path of the interface table + string interface = default(""); // Network interface name + string protocol = default(""); // Bind the socket to this protocol if specified + string localAddress = default(""); // Local Ethernet MAC address + string remoteAddress = default(""); // Remove Ethernet MAC address + bool steal = default(false); // Steal packets + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @lifecycleSupport(); @display("i=block/socket"); @signal[packetSent](type=inet::Packet); diff --git a/src/inet/applications/external/ExternalApp.ned b/src/inet/applications/external/ExternalApp.ned index 3365c95bd9d..8a1559ee901 100644 --- a/src/inet/applications/external/ExternalApp.ned +++ b/src/inet/applications/external/ExternalApp.ned @@ -18,7 +18,7 @@ import inet.common.ExternalProcess; module ExternalApp like IApp { parameters: - string namespace = default(""); // name of the host OS network namespace (optional) + string namespace = default(""); // Name of the host OS network namespace (optional) *.namespace = default(this.namespace); @display("i=block/app"); gates: diff --git a/src/inet/applications/generic/IpvxTrafGen.ned b/src/inet/applications/generic/IpvxTrafGen.ned index 14d5f851fd9..21ff767436a 100644 --- a/src/inet/applications/generic/IpvxTrafGen.ned +++ b/src/inet/applications/generic/IpvxTrafGen.ned @@ -22,13 +22,13 @@ package inet.applications.generic; simple IpvxTrafGen like IIpvxTrafficGenerator { parameters: - double startTime @unit(s) = default(1s); // time of sending the first packet - double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever - volatile double sendInterval @unit(s) = default(10ms); // may be a random value, e.g. exponential(1) - int numPackets = default(-1); // max number of packets to generate, -1 means forever - int protocol; // value for IPv4, IPv6 protocol field, accepts only between 143 and 254 - volatile int packetLength @unit(B); // packet length in bytes - string destAddresses = default(""); // list of destination addresses, separated by spaces + double startTime @unit(s) = default(1s); // Time of sending the first packet + double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever + volatile double sendInterval @unit(s) = default(10ms); // May be a random value, e.g. exponential(1) + int numPackets = default(-1); // Max number of packets to generate, -1 means forever + int protocol; // Value for IPv4, IPv6 protocol field, accepts only between 143 and 254 + volatile int packetLength @unit(B); // Packet length in bytes + string destAddresses = default(""); // List of destination addresses, separated by spaces @lifecycleSupport; @display("i=block/source"); @signal[packetSent](type=inet::Packet); diff --git a/src/inet/applications/generic/IpvxTrafSink.ned b/src/inet/applications/generic/IpvxTrafSink.ned index bf61ae7dccf..d44824307e9 100644 --- a/src/inet/applications/generic/IpvxTrafSink.ned +++ b/src/inet/applications/generic/IpvxTrafSink.ned @@ -14,7 +14,7 @@ package inet.applications.generic; simple IpvxTrafSink like IIpvxTrafficGenerator { parameters: - int protocol; // value for IPv4, IPv6 protocol field, accepts only between 143 and 254 + int protocol; // Value for IPv4, IPv6 protocol field, accepts only between 143 and 254 @lifecycleSupport; @display("i=block/sink"); @signal[packetReceived](type=inet::Packet); diff --git a/src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned b/src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned index c738fff1766..aee462cfaaf 100644 --- a/src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned +++ b/src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned @@ -19,8 +19,8 @@ simple Ieee8022LlcSocketIo string remoteAddress = default(""); int localSap = default(-1); int remoteSap = default(-1); - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @lifecycleSupport(); @display("i=block/socket"); @signal[packetSent](type=inet::Packet); diff --git a/src/inet/applications/ipapp/IpSocketIo.ned b/src/inet/applications/ipapp/IpSocketIo.ned index 7476b631c6d..d4860e58d13 100644 --- a/src/inet/applications/ipapp/IpSocketIo.ned +++ b/src/inet/applications/ipapp/IpSocketIo.ned @@ -17,8 +17,8 @@ simple IpSocketIo string localAddress = default(""); string destAddress = default(""); string protocol = default(""); - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @lifecycleSupport(); @display("i=block/socket"); @signal[packetSent](type=inet::Packet); diff --git a/src/inet/applications/netperfmeter/NetPerfMeter.ned b/src/inet/applications/netperfmeter/NetPerfMeter.ned index 67a53e80660..de79bcb8b43 100644 --- a/src/inet/applications/netperfmeter/NetPerfMeter.ned +++ b/src/inet/applications/netperfmeter/NetPerfMeter.ned @@ -41,10 +41,10 @@ simple NetPerfMeter like IApp { parameters: bool activeMode = default(true); // Server (false) or client (true) - string localAddress = default(""); // may be left empty ("") - int localPort = default(9000); // port number to listen on - string remoteAddress = default(""); // server address (may be symbolic) - int remotePort = default(9000); // port number to connect to + string localAddress = default(""); // May be left empty ("") + int localPort = default(9000); // Port number to listen on + string remoteAddress = default(""); // Server address (may be symbolic) + int remotePort = default(9000); // Port number to connect to double connectTime @unit(s) = default(0s); // Absolute time to establish connection double startTime @unit(s) = default(1s); // Transmission start, relative to "connectTime" @@ -59,7 +59,7 @@ simple NetPerfMeter like IApp int outboundStreams = default(1); // Number of outbound streams (SCTP only) int maxInboundStreams = default(16); // Maximum number of inbound streams (SCTP only) string protocol = default("SCTP"); // Transport protocol to use - string primaryPath = default(""); // primary path (may be symbolic; SCTP only) + string primaryPath = default(""); // Primary path (may be symbolic; SCTP only) volatile double frameRate @unit(Hz) = default(1 Hz); // Outgoing frame rate volatile int frameSize @unit(B) = default(1452 B); // Outgoing frame size diff --git a/src/inet/applications/pingapp/PingApp.ned b/src/inet/applications/pingapp/PingApp.ned index b86317f3ae5..590f6f973f2 100644 --- a/src/inet/applications/pingapp/PingApp.ned +++ b/src/inet/applications/pingapp/PingApp.ned @@ -47,23 +47,23 @@ import inet.applications.contract.IApp; simple PingApp like IApp { parameters: - string destAddr = default(""); // destination address(es), separated by spaces, "*" means all IPv4/IPv6 interfaces in entire simulation - string srcAddr = default(""); // source address (useful with multi-homing) - int packetSize @unit(B) = default(56B); // of ping payload, in bytes - volatile double sendInterval @unit(s) = default(1s); // time to wait between pings (can be random) + string destAddr = default(""); // Destination address(es), separated by spaces, "*" means all IPv4/IPv6 interfaces in entire simulation + string srcAddr = default(""); // Source address (useful with multi-homing) + int packetSize @unit(B) = default(56B); // Of ping payload, in bytes + volatile double sendInterval @unit(s) = default(1s); // Time to wait between pings (can be random) int hopLimit = default(-1); // TTL or hopLimit for IP packets - int count = default(-1); // number of pings requests sent to a single destination address, -1 means continuously (only first address will be used from destAddr) - double startTime @unit(s) = default(uniform(0s, this.sleepDuration + this.sendInterval)); // send first ping at startTime - double stopTime @unit(s) = default(-1s); // time to finish sending, negative values mean forever - volatile double sleepDuration @unit(s) = default(0s); // time spent in sleep between switching destinations - bool continuous = default(false); // whether to continuously ping the destinations in a round-robin fashion - bool printPing = default(false); // log to stdout + int count = default(-1); // Number of pings requests sent to a single destination address, -1 means continuously (only first address will be used from destAddr) + double startTime @unit(s) = default(uniform(0s, this.sleepDuration + this.sendInterval)); // Send first ping at startTime + double stopTime @unit(s) = default(-1s); // Time to finish sending, negative values mean forever + volatile double sleepDuration @unit(s) = default(0s); // Time spent in sleep between switching destinations + bool continuous = default(false); // Whether to continuously ping the destinations in a round-robin fashion + bool printPing = default(false); // Log to stdout string crcMode @enum("declared", "computed") = default("declared"); - string networkProtocol = default(""); // uses specified network protocol for communication; uses the address-specified default network protocol when the parameter is empty + string networkProtocol = default(""); // Uses specified network protocol for communication; uses the address-specified default network protocol when the parameter is empty @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[rtt](type=simtime_t); @signal[numLost](type=long); @signal[numOutOfOrderArrivals](type=long); @@ -74,7 +74,7 @@ simple PingApp like IApp @statistic[numOutOfOrderArrivals](title="ping out-of-order arrivals"; record=last,vector; interpolationmode=none); @statistic[pingTxSeq](title="ping tx seq"; record=count,vector; interpolationmode=none); @statistic[pingRxSeq](title="ping rx seq"; record=count,vector; interpolationmode=none); - @selfMessageKinds(inet::PingSelfKinds); // kind used in self messages + @selfMessageKinds(inet::PingSelfKinds); // Kind used in self messages gates: input socketIn @labels(ITransportPacket/up); output socketOut @labels(ITransportPacket/down); diff --git a/src/inet/applications/rtpapp/RtpApplication.ned b/src/inet/applications/rtpapp/RtpApplication.ned index 2f1f3972ce6..06a9afff31d 100644 --- a/src/inet/applications/rtpapp/RtpApplication.ned +++ b/src/inet/applications/rtpapp/RtpApplication.ned @@ -16,18 +16,18 @@ simple RtpApplication { parameters: @display("i=block/app"); - string commonName; // the common name (CNAME) of this host - string profileName; // which rtp profile is to be used (usually RtpAvProfile) - double bandwidth; // bandwidth in bytes per second for this session - string destinationAddress; // destination address (the L3AddressResolver class is used to resolve the address) - int portNumber; // used port - string fileName; // fileName of file to be transmitted, "" means this system acts only as a receiver - int payloadType; // payload type of file to transmit - double sessionEnterDelay @unit(s); // delay before starts a new session - double transmissionStartDelay @unit(s); // delay before start transmission (related to "sender module created") - double transmissionStopDelay @unit(s); // delay before stops transmission (related to "start transmission") - double sessionLeaveDelay @unit(s); // delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "") - @selfMessageKinds(inet::RtpAppSelfMsgKinds); // kind used in self messages + string commonName; // The common name (CNAME) of this host + string profileName; // Which rtp profile is to be used (usually RtpAvProfile) + double bandwidth; // Bandwidth in bytes per second for this session + string destinationAddress; // Destination address (the L3AddressResolver class is used to resolve the address) + int portNumber; // Used port + string fileName; // FileName of file to be transmitted, "" means this system acts only as a receiver + int payloadType; // Payload type of file to transmit + double sessionEnterDelay @unit(s); // Delay before starts a new session + double transmissionStartDelay @unit(s); // Delay before start transmission (related to "sender module created") + double transmissionStopDelay @unit(s); // Delay before stops transmission (related to "start transmission") + double sessionLeaveDelay @unit(s); // Delay before leave session (related to "file transmission finished/stopped" or "session entered" when fileName is "") + @selfMessageKinds(inet::RtpAppSelfMsgKinds); // Kind used in self messages gates: output rtpOut @labels(RtpInterfacePacket/down); diff --git a/src/inet/applications/sctpapp/SctpClient.ned b/src/inet/applications/sctpapp/SctpClient.ned index bc93de41a22..6237d6ba34c 100644 --- a/src/inet/applications/sctpapp/SctpClient.ned +++ b/src/inet/applications/sctpapp/SctpClient.ned @@ -17,20 +17,20 @@ import inet.applications.contract.IApp; simple SctpClient like IApp { parameters: - string localAddress = default(""); // comma separated list of addresses - int localPort = default(0); // port number to listen on - string connectAddress; // server address (may be symbolic) - int connectPort; // port number to connect to - double startTime @unit(s) = default(1s); // time first session begins - volatile int numRequestsPerSession = default(1); // number of requests sent per session + string localAddress = default(""); // Comma separated list of addresses + int localPort = default(0); // Port number to listen on + string connectAddress; // Server address (may be symbolic) + int connectPort; // Port number to connect to + double startTime @unit(s) = default(1s); // Time first session begins + volatile int numRequestsPerSession = default(1); // Number of requests sent per session int numPacketsToReceive = default(0); - int requestLength = default(1452); // length of a request (bytes) - double thinkTime @unit(s) = default(0s); // time gap between requests + int requestLength = default(1452); // Length of a request (bytes) + double thinkTime @unit(s) = default(0s); // Time gap between requests double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort - double reconnectInterval @unit(s) = default(0s); // if connection breaks, waits this much before trying to reconnect + double reconnectInterval @unit(s) = default(0s); // If connection breaks, waits this much before trying to reconnect int inboundStreams = default(17); int outboundStreams = default(1); - bool echo = default(false); // echoes received packages when true + bool echo = default(false); // Echoes received packages when true bool ordered = default(true); int queueSize = default(0); int prMethod = default(0); //0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST @@ -39,7 +39,7 @@ simple SctpClient like IApp double streamRequestTime @unit(s) = default(0s); int streamResetType = default(5); //NO_RESET=5, RESET_OUTGOING=6, RESET_INCOMING=7, RESET_BOTH=8, SSN_TSN=9 int streamToReset = default(0); - double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever + double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever double primaryTime @unit(s) = default(0s); string newPrimary = default(""); string streamRequestLengths = default(""); diff --git a/src/inet/applications/sctpapp/SctpNatPeer.ned b/src/inet/applications/sctpapp/SctpNatPeer.ned index 8f27aa15654..b8586ad1ac5 100644 --- a/src/inet/applications/sctpapp/SctpNatPeer.ned +++ b/src/inet/applications/sctpapp/SctpNatPeer.ned @@ -12,20 +12,20 @@ import inet.applications.contract.IApp; simple SctpNatPeer like IApp { parameters: - string localAddress = default(""); // comma separated list of addresses - int localPort = default(0); // port number to listen on - string connectAddress; // server address (may be symbolic) - int connectPort; // port number to connect to - double startTime @unit(s) = default(1s); // time first session begins - int numRequestsPerSession = default(1); // number of requests sent per session + string localAddress = default(""); // Comma separated list of addresses + int localPort = default(0); // Port number to listen on + string connectAddress; // Server address (may be symbolic) + int connectPort; // Port number to connect to + double startTime @unit(s) = default(1s); // Time first session begins + int numRequestsPerSession = default(1); // Number of requests sent per session int numPacketsToReceive = default(0); - int requestLength = default(1452); // length of a request (bytes) - double thinkTime @unit(s) = default(0s); // time gap between requests + int requestLength = default(1452); // Length of a request (bytes) + double thinkTime @unit(s) = default(0s); // Time gap between requests double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort - //# double reconnectInterval @unit(s) = default(0); // if connection breaks, waits this much before trying to reconnect + //# double reconnectInterval @unit(s) = default(0); // If connection breaks, waits this much before trying to reconnect int outboundStreams = default(1); int inboundStreams = default(1); - bool echo = default(false); // echoes received packages when true + bool echo = default(false); // Echoes received packages when true bool ordered = default(true); int queueSize = default(0); int prMethod = default(0); //0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST @@ -37,7 +37,7 @@ simple SctpNatPeer like IApp //double stopTime @unit(s) = default(0s); double echoDelay @unit(s) = default(0s); double delayFirstRead @unit(s) = default(0s); - int numPacketsToSendPerClient = default(0); // number of requests sent per session + int numPacketsToSendPerClient = default(0); // Number of requests sent per session int numPacketsToReceivePerClient = default(1); int ownName = default(0); int peerName = default(0); diff --git a/src/inet/applications/sctpapp/SctpNatServer.ned b/src/inet/applications/sctpapp/SctpNatServer.ned index 49fb6028f66..ba336ea4318 100644 --- a/src/inet/applications/sctpapp/SctpNatServer.ned +++ b/src/inet/applications/sctpapp/SctpNatServer.ned @@ -12,11 +12,11 @@ import inet.applications.contract.IApp; simple SctpNatServer like IApp { parameters: - string localAddress = default(""); // may be left empty ("") - int localPort = default(0); // port number to listen on - int numPacketsToSendPerClient = default(0); // number of requests sent per session + string localAddress = default(""); // May be left empty ("") + int localPort = default(0); // Port number to listen on + int numPacketsToSendPerClient = default(0); // Number of requests sent per session int numPacketsToReceivePerClient = default(1); - int requestLength = default(1452); // length of a request (bytes) + int requestLength = default(1452); // Length of a request (bytes) double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort int outboundStreams = default(1); int inboundStreams = default(1); diff --git a/src/inet/applications/sctpapp/SctpPeer.ned b/src/inet/applications/sctpapp/SctpPeer.ned index ba2faa123e7..f25ebf43a4c 100644 --- a/src/inet/applications/sctpapp/SctpPeer.ned +++ b/src/inet/applications/sctpapp/SctpPeer.ned @@ -12,15 +12,15 @@ import inet.applications.contract.IApp; simple SctpPeer like IApp { parameters: - string localAddress = default(""); // comma separated list of addresses - int localPort = default(0); // port number to listen on - bool echo = default(false); // echoes received packages when true + string localAddress = default(""); // Comma separated list of addresses + int localPort = default(0); // Port number to listen on + bool echo = default(false); // Echoes received packages when true double echoDelay @unit(s) = default(0s); double delayFirstRead @unit(s) = default(0s); - int numPacketsToSendPerClient = default(0); // number of requests sent per session + int numPacketsToSendPerClient = default(0); // Number of requests sent per session int numPacketsToReceivePerClient = default(1); - int requestLength = default(1452); // length of a request (bytes) - double thinkTime @unit(s) = default(0s); // time gap between requests + int requestLength = default(1452); // Length of a request (bytes) + double thinkTime @unit(s) = default(0s); // Time gap between requests double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort bool ordered = default(true); int outboundStreams = default(1); @@ -29,10 +29,10 @@ simple SctpPeer like IApp int prMethod = default(0); //0=NONE, 1=PR_TTL, 2=PR_RTX, 3=PR_PRIO, 4=PR_STRRST double prValue = default(0); //for PR-SCTP bool streamReset = default(false); - string connectAddress; // server address (may be symbolic) - int connectPort; // port number to connect to - double startTime @unit(s) = default(1s); // time first session begins - int numRequestsPerSession = default(1); // number of requests sent per session + string connectAddress; // Server address (may be symbolic) + int connectPort; // Port number to connect to + double startTime @unit(s) = default(1s); // Time first session begins + int numRequestsPerSession = default(1); // Number of requests sent per session int numPacketsToReceive = default(0); string streamPriorities = default(""); diff --git a/src/inet/applications/sctpapp/SctpServer.ned b/src/inet/applications/sctpapp/SctpServer.ned index 54834317967..31263104670 100644 --- a/src/inet/applications/sctpapp/SctpServer.ned +++ b/src/inet/applications/sctpapp/SctpServer.ned @@ -17,17 +17,17 @@ import inet.applications.contract.IApp; simple SctpServer like IApp { parameters: - string localAddress = default(""); // comma separated list of addresses - int localPort = default(0); // port number to listen on - bool echo = default(false); // echoes received packages when true + string localAddress = default(""); // Comma separated list of addresses + int localPort = default(0); // Port number to listen on + bool echo = default(false); // Echoes received packages when true volatile double echoDelay @unit(s) = default(0s); double delayFirstRead @unit(s) = default(0s); volatile double readingInterval @unit(s) = default(0s); int messagesToPush = default(0); - int numPacketsToSendPerClient = default(0); // number of requests sent per session + int numPacketsToSendPerClient = default(0); // Number of requests sent per session int numPacketsToReceivePerClient = default(1); - int requestLength = default(1452); // length of a request (bytes) - volatile double thinkTime @unit(s) = default(0s); // time gap between requests + int requestLength = default(1452); // Length of a request (bytes) + volatile double thinkTime @unit(s) = default(0s); // Time gap between requests double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort bool finishEndsSimulation = default(false); bool ordered = default(true); diff --git a/src/inet/applications/tcpapp/TcpBasicClientApp.ned b/src/inet/applications/tcpapp/TcpBasicClientApp.ned index e3c9e660dd8..4376869e1e6 100644 --- a/src/inet/applications/tcpapp/TcpBasicClientApp.ned +++ b/src/inet/applications/tcpapp/TcpBasicClientApp.ned @@ -40,28 +40,28 @@ import inet.applications.contract.IApp; simple TcpBasicClientApp like IApp { parameters: - string localAddress = default(""); // may be left empty ("") - int localPort = default(-1); // port number to listen on - string connectAddress = default(""); // server address (may be symbolic) - int connectPort = default(1000); // port number to connect to - bool autoRead = default(true); // whether to use "autoread" or "explicit-read" mode for TCP connection - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay - double startTime @unit(s) = default(1s); // time first session begins - double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever - volatile int numRequestsPerSession = default(1); // number of requests sent per session - volatile int requestLength @unit(B) = default(200B); // length of a request - volatile int replyLength @unit(B) = default(1MiB); // length of a reply - volatile double thinkTime @unit(s); // time gap between requests - volatile double idleInterval @unit(s); // time gap between sessions - volatile double reconnectInterval @unit(s) = default(30s); // if connection breaks, waits this much before trying to reconnect - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - int dscp = default(-1); // if not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + string localAddress = default(""); // May be left empty ("") + int localPort = default(-1); // Port number to listen on + string connectAddress = default(""); // Server address (may be symbolic) + int connectPort = default(1000); // Port number to connect to + bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + double startTime @unit(s) = default(1s); // Time first session begins + double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever + volatile int numRequestsPerSession = default(1); // Number of requests sent per session + volatile int requestLength @unit(B) = default(200B); // Length of a request + volatile int replyLength @unit(B) = default(1MiB); // Length of a reply + volatile double thinkTime @unit(s); // Time gap between requests + volatile double idleInterval @unit(s); // Time gap between sessions + volatile double reconnectInterval @unit(s) = default(30s); // If connection breaks, waits this much before trying to reconnect + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + int dscp = default(-1); // If not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); @signal[connect](type=long); // 1 for open, -1 for close diff --git a/src/inet/applications/tcpapp/TcpClientSocketIo.ned b/src/inet/applications/tcpapp/TcpClientSocketIo.ned index aa47919f7a3..59e1043daa3 100644 --- a/src/inet/applications/tcpapp/TcpClientSocketIo.ned +++ b/src/inet/applications/tcpapp/TcpClientSocketIo.ned @@ -29,9 +29,9 @@ simple TcpClientSocketIo int localPort = default(-1); string connectAddress; int connectPort; - bool autoRead = default(true); // whether to use "autoread" or "explicit-read" mode for TCP connection - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay @display("i=block/socket"); gates: input trafficIn; diff --git a/src/inet/applications/tcpapp/TcpEchoApp.ned b/src/inet/applications/tcpapp/TcpEchoApp.ned index 9906f7330c8..8d675de9c2a 100644 --- a/src/inet/applications/tcpapp/TcpEchoApp.ned +++ b/src/inet/applications/tcpapp/TcpEchoApp.ned @@ -27,12 +27,12 @@ simple TcpEchoApp extends TcpServerHostApp { parameters: @class(TcpEchoApp); - bool autoRead = default(true); // whether to use "autoread" or "explicit-read" mode for TCP connection - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay double echoFactor = default(1); double echoDelay @unit(s) = default(0s); - serverThreadModuleType = default("inet.applications.tcpapp.TcpEchoAppThread"); // module type of "thread" module to launch on incoming connections + serverThreadModuleType = default("inet.applications.tcpapp.TcpEchoAppThread"); // Module type of "thread" module to launch on incoming connections @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); diff --git a/src/inet/applications/tcpapp/TcpGenericServerApp.ned b/src/inet/applications/tcpapp/TcpGenericServerApp.ned index 62fa5155578..b0e901904cc 100644 --- a/src/inet/applications/tcpapp/TcpGenericServerApp.ned +++ b/src/inet/applications/tcpapp/TcpGenericServerApp.ned @@ -33,16 +33,16 @@ import inet.applications.contract.IApp; simple TcpGenericServerApp like IApp { parameters: - string localAddress = default(""); // local address; may be left empty ("") - int localPort = default(1000); // localPort number to listen on - bool autoRead = default(true); // whether to use "autoread" or "explicit-read" mode for TCP connection - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + string localAddress = default(""); // Local address; may be left empty ("") + int localPort = default(1000); // LocalPort number to listen on + bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay double replyDelay @unit(s) = default(0s); @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); diff --git a/src/inet/applications/tcpapp/TcpServerApp.ned b/src/inet/applications/tcpapp/TcpServerApp.ned index 4d7f9fc46fd..61de72544cb 100644 --- a/src/inet/applications/tcpapp/TcpServerApp.ned +++ b/src/inet/applications/tcpapp/TcpServerApp.ned @@ -21,7 +21,7 @@ import inet.common.MessageDispatcher; module TcpServerApp like IApp { parameters: - string interfaceTableModule; // relative module path of the interface table + string interfaceTableModule; // Relative module path of the interface table *.interfaceTableModule = default(this.interfaceTableModule); @display("i=block/app"); gates: diff --git a/src/inet/applications/tcpapp/TcpServerHostApp.ned b/src/inet/applications/tcpapp/TcpServerHostApp.ned index 5829bd03809..5cb210202dd 100644 --- a/src/inet/applications/tcpapp/TcpServerHostApp.ned +++ b/src/inet/applications/tcpapp/TcpServerHostApp.ned @@ -26,13 +26,13 @@ import inet.applications.contract.IApp; simple TcpServerHostApp like IApp { parameters: - string localAddress = default(""); // may be left empty ("") - int localPort = default(1000); // port number to listen on - string serverThreadModuleType; // module type of "thread" module to launch on incoming connections + string localAddress = default(""); // May be left empty ("") + int localPort = default(1000); // Port number to listen on + string serverThreadModuleType; // Module type of "thread" module to launch on incoming connections @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation gates: input socketIn @labels(TcpCommand/up); output socketOut @labels(TcpCommand/down); diff --git a/src/inet/applications/tcpapp/TcpServerListener.ned b/src/inet/applications/tcpapp/TcpServerListener.ned index daa70099874..7b885ca4c93 100644 --- a/src/inet/applications/tcpapp/TcpServerListener.ned +++ b/src/inet/applications/tcpapp/TcpServerListener.ned @@ -27,10 +27,10 @@ import inet.applications.contract.IApp; simple TcpServerListener { parameters: - string localAddress = default(""); // may be left empty ("") - int localPort = default(1000); // port number to listen on - string serverConnectionModuleType = default("inet.applications.tcpapp.TcpServerConnection"); // module type of "connection" module to launch on incoming connections - bool autoRead = default(true); // defines the autoRead setting for connection handling modules + string localAddress = default(""); // May be left empty ("") + int localPort = default(1000); // Port number to listen on + string serverConnectionModuleType = default("inet.applications.tcpapp.TcpServerConnection"); // Module type of "connection" module to launch on incoming connections + bool autoRead = default(true); // Defines the autoRead setting for connection handling modules @display("i=block/server"); gates: input socketIn; diff --git a/src/inet/applications/tcpapp/TcpServerSocketIo.ned b/src/inet/applications/tcpapp/TcpServerSocketIo.ned index 3fe6b4025f3..37a66709efa 100644 --- a/src/inet/applications/tcpapp/TcpServerSocketIo.ned +++ b/src/inet/applications/tcpapp/TcpServerSocketIo.ned @@ -25,8 +25,8 @@ simple TcpServerSocketIo { parameters: @display("i=block/socket"); - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay gates: input trafficIn; output trafficOut; diff --git a/src/inet/applications/tcpapp/TcpSessionApp.ned b/src/inet/applications/tcpapp/TcpSessionApp.ned index f01bcc901c4..5c897e06d89 100644 --- a/src/inet/applications/tcpapp/TcpSessionApp.ned +++ b/src/inet/applications/tcpapp/TcpSessionApp.ned @@ -79,26 +79,26 @@ simple TcpSessionApp like IApp { parameters: string localAddress = default(""); - int localPort = default(-1); // local port + int localPort = default(-1); // Local port bool active = default(true); string connectAddress; int connectPort = default(1000); string dataTransferMode @enum("bytecount","object","bytestream") = default("bytecount"); - bool autoRead = default(true); // whether to use "autoread" or "explicit-read" mode for TCP connection - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay double tOpen @unit(s) = default(1s); double tSend @unit(s) = default(1s); int sendBytes @unit(B) = default(1MiB); string sendScript = default(""); double tClose @unit(s) = default(2s); - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - int dscp = default(-1); // if not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + int dscp = default(-1); // If not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[connect](type=long); @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); diff --git a/src/inet/applications/tcpapp/TcpSinkApp.ned b/src/inet/applications/tcpapp/TcpSinkApp.ned index 237903cd540..83458c927ee 100644 --- a/src/inet/applications/tcpapp/TcpSinkApp.ned +++ b/src/inet/applications/tcpapp/TcpSinkApp.ned @@ -22,9 +22,9 @@ module TcpSinkApp extends TcpServerHostApp { parameters: serverThreadModuleType = default("inet.applications.tcpapp.TcpSinkAppThread"); - bool autoRead = default(true); // whether to use "autoread" or "explicit-read" mode for TCP connection - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay @class(TcpSinkApp); @display("i=block/sink"); @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none; checkSignals=false); diff --git a/src/inet/applications/tcpapp/TelnetApp.ned b/src/inet/applications/tcpapp/TelnetApp.ned index 30e0c23df7e..34e52feedba 100644 --- a/src/inet/applications/tcpapp/TelnetApp.ned +++ b/src/inet/applications/tcpapp/TelnetApp.ned @@ -27,29 +27,29 @@ import inet.applications.contract.IApp; simple TelnetApp like IApp { parameters: - string localAddress = default(""); // local address or empty ("") - int localPort; // local port number - string connectAddress; // server address (may be symbolic) - int connectPort = default(1000); // port number to connect to - bool autoRead = default(true); // whether to use "autoread" or "explicit-read" mode for TCP connection - volatile int readSize @unit(B) = default(-1B); // used only with autoRead==false - volatile double readDelay @unit(s) = default(-1s); // used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay - double startTime @unit(s) = default(1s); // time first session begins - double stopTime @unit(s) = default(-1s); // time of finishing sending, negative values mean forever - volatile int numCommands = default(int(exponential(10))); // user types this many commands in a session - volatile int commandLength @unit(B) = default(10B); // commands are this many characters (plus Enter) - volatile double keyPressDelay @unit(s) = default(exponential(0.1s)); // delay between keypresses - volatile int commandOutputLength @unit(B) = default(intWithUnit(exponential(1000B))); // commands produce this much output - volatile double thinkTime @unit(s) = default(exponential(10s)); // user waits this much before starting to type new command - volatile double idleInterval @unit(s) = default(exponential(300s)); // time gap between sessions - volatile double reconnectInterval @unit(s) = default(30s); // if connection breaks, user waits this much before trying to reconnect - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - int dscp = default(-1); // if not -1, set the ToS (IPv4) or Traffic Class (IPv6) field of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + string localAddress = default(""); // Local address or empty ("") + int localPort; // Local port number + string connectAddress; // Server address (may be symbolic) + int connectPort = default(1000); // Port number to connect to + bool autoRead = default(true); // Whether to use "autoread" or "explicit-read" mode for TCP connection + volatile int readSize @unit(B) = default(-1B); // Used only with autoRead==false + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after previous READ was satisfied; -1 means immediately, 0 means zero delay + double startTime @unit(s) = default(1s); // Time first session begins + double stopTime @unit(s) = default(-1s); // Time of finishing sending, negative values mean forever + volatile int numCommands = default(int(exponential(10))); // User types this many commands in a session + volatile int commandLength @unit(B) = default(10B); // Commands are this many characters (plus Enter) + volatile double keyPressDelay @unit(s) = default(exponential(0.1s)); // Delay between keypresses + volatile int commandOutputLength @unit(B) = default(intWithUnit(exponential(1000B))); // Commands produce this much output + volatile double thinkTime @unit(s) = default(exponential(10s)); // User waits this much before starting to type new command + volatile double idleInterval @unit(s) = default(exponential(300s)); // Time gap between sessions + volatile double reconnectInterval @unit(s) = default(30s); // If connection breaks, user waits this much before trying to reconnect + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + int dscp = default(-1); // If not -1, set the ToS (IPv4) or Traffic Class (IPv6) field of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value @display("i=block/telnet"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); @signal[connect](type=long); // 1 for open, -1 for close diff --git a/src/inet/applications/tcpapp/TelnetClientApp.ned b/src/inet/applications/tcpapp/TelnetClientApp.ned index 492cf374d89..493e15b5ed2 100644 --- a/src/inet/applications/tcpapp/TelnetClientApp.ned +++ b/src/inet/applications/tcpapp/TelnetClientApp.ned @@ -29,14 +29,14 @@ module TelnetClientApp like IApp characterProducer: like IActivePacketSource { parameters: packetLength = 1B; - packetData = intuniform(97, 122); // lower case ASCII characters - productionInterval = uniform(0.1s, 0.2s); // typing speed between 5 and 10 characters per second + packetData = intuniform(97, 122); // Lower case ASCII characters + productionInterval = uniform(0.1s, 0.2s); // Typing speed between 5 and 10 characters per second @display("p=100,100"); } enterProducer: like IActivePacketSource { parameters: packetLength = 1B; - packetData = 13; // enter character + packetData = 13; // Enter character productionInterval = 0.1s; @display("p=300,100"); } @@ -46,7 +46,7 @@ module TelnetClientApp like IApp } scheduler: like IPacketScheduler { parameters: - transitionProbabilities = "0 1 0 0 0 1 1 0 0"; // character -> enter -> wait -> character + transitionProbabilities = "0 1 0 0 0 1 1 0 0"; // Character -> enter -> wait -> character waitIntervals = "uniform(0,3) 0 uniform(10,30)"; @display("p=300,200"); } diff --git a/src/inet/applications/tunapp/TunnelApp.ned b/src/inet/applications/tunapp/TunnelApp.ned index c21904129f8..46dcde6610a 100644 --- a/src/inet/applications/tunapp/TunnelApp.ned +++ b/src/inet/applications/tunapp/TunnelApp.ned @@ -18,8 +18,8 @@ simple TunnelApp like IApp int destinationPort = default(-1); int localPort = default(-1); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @display("i=block/app"); gates: input socketIn; diff --git a/src/inet/applications/udpapp/UdpBasicApp.ned b/src/inet/applications/udpapp/UdpBasicApp.ned index 8a5c63d1044..277685fe7c1 100644 --- a/src/inet/applications/udpapp/UdpBasicApp.ned +++ b/src/inet/applications/udpapp/UdpBasicApp.ned @@ -30,27 +30,27 @@ simple UdpBasicApp like IApp { parameters: string interfaceTableModule; // The path to the InterfaceTable module - string clockModule = default(""); // relative path of a module that implements IClock; optional - int localPort = default(-1); // local port (-1: use ephemeral port) - string destAddresses = default(""); // list of IP addresses, separated by spaces ("": don't send) + string clockModule = default(""); // Relative path of a module that implements IClock; optional + int localPort = default(-1); // Local port (-1: use ephemeral port) + string destAddresses = default(""); // List of IP addresses, separated by spaces ("": don't send) string localAddress = default(""); string packetName = default("UdpBasicAppData"); int destPort; - volatile int messageLength @unit(B); // length of messages to generate, in bytes - double startTime @unit(s) = default(this.sendInterval); // application start time (start of the first packet) - double stopTime @unit(s) = default(-1s); // time of finishing sending, -1s means forever - volatile double sendInterval @unit(s); // should usually be a random value, e.g. exponential(1) - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - bool dontFragment = default(false); // if true, asks IP to not fragment the message during routing - int dscp = default(-1); // if not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value - string multicastInterface = default(""); // if not empty, set the multicast output interface option on the socket (interface name expected) - bool receiveBroadcast = default(false); // if true, makes the socket receive broadcast packets - bool joinLocalMulticastGroups = default(false); // if true, makes the socket receive packets from all multicast groups set on local interfaces + volatile int messageLength @unit(B); // Length of messages to generate, in bytes + double startTime @unit(s) = default(this.sendInterval); // Application start time (start of the first packet) + double stopTime @unit(s) = default(-1s); // Time of finishing sending, -1s means forever + volatile double sendInterval @unit(s); // Should usually be a random value, e.g. exponential(1) + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + bool dontFragment = default(false); // If true, asks IP to not fragment the message during routing + int dscp = default(-1); // If not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + string multicastInterface = default(""); // If not empty, set the multicast output interface option on the socket (interface name expected) + bool receiveBroadcast = default(false); // If true, makes the socket receive broadcast packets + bool joinLocalMulticastGroups = default(false); // If true, makes the socket receive packets from all multicast groups set on local interfaces @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); diff --git a/src/inet/applications/udpapp/UdpBasicBurst.ned b/src/inet/applications/udpapp/UdpBasicBurst.ned index d1f64f37ffb..03c839df32e 100644 --- a/src/inet/applications/udpapp/UdpBasicBurst.ned +++ b/src/inet/applications/udpapp/UdpBasicBurst.ned @@ -92,28 +92,28 @@ simple UdpBasicBurst like IApp { parameters: string interfaceTableModule; // The path to the InterfaceTable module - string destAddresses; // space-separated list of destination IP addresses, can be empty; + string destAddresses; // Space-separated list of destination IP addresses, can be empty; // see module description for possibilities - bool excludeLocalDestAddresses = default(true); // excluding local addresses from destAddresses - string chooseDestAddrMode @enum("once","perBurst","perSend"); // when to change the destination address - int destAddrRNG = default(0); // random generator ID for selecting a destination address - int localPort = default(-1); // local UDP port number (-1: use ephemeral port) - int destPort; // remote UDP port number - double startTime @unit(s) = default(1s); // application start time (start of the first burst) - double stopTime @unit(s) = default(-1s); // application stop time (no packets are sent after this time); a negative or -1 means no limit - volatile int messageLength @unit(B); // length of messages to generate, in bytes - volatile double burstDuration @unit(s); // burst duration time (zero not allowed) - volatile double sleepDuration @unit(s); // time between bursts (zero allowed) - volatile double sendInterval @unit(s); // time between messages during bursts; usually a random value, e.g. 0.1s+uniform(-0.001s,0.001s); zero not allowed - double delayLimit @unit(s) = default(0s); // maximum accepted delay for a packet; packets with a bigger delay are discarded (dropped), zero value means no limit - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - bool dontFragment = default(false); // if true, asks IP to not fragment the message during routing - int dscp = default(-1); // if not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + bool excludeLocalDestAddresses = default(true); // Excluding local addresses from destAddresses + string chooseDestAddrMode @enum("once","perBurst","perSend"); // When to change the destination address + int destAddrRNG = default(0); // Random generator ID for selecting a destination address + int localPort = default(-1); // Local UDP port number (-1: use ephemeral port) + int destPort; // Remote UDP port number + double startTime @unit(s) = default(1s); // Application start time (start of the first burst) + double stopTime @unit(s) = default(-1s); // Application stop time (no packets are sent after this time); a negative or -1 means no limit + volatile int messageLength @unit(B); // Length of messages to generate, in bytes + volatile double burstDuration @unit(s); // Burst duration time (zero not allowed) + volatile double sleepDuration @unit(s); // Time between bursts (zero allowed) + volatile double sendInterval @unit(s); // Time between messages during bursts; usually a random value, e.g. 0.1s+uniform(-0.001s,0.001s); zero not allowed + double delayLimit @unit(s) = default(0s); // Maximum accepted delay for a packet; packets with a bigger delay are discarded (dropped), zero value means no limit + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + bool dontFragment = default(false); // If true, asks IP to not fragment the message during routing + int dscp = default(-1); // If not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @signal[packetReceived](type=inet::Packet); @signal[packetDropped](type=inet::Packet); diff --git a/src/inet/applications/udpapp/UdpEchoApp.ned b/src/inet/applications/udpapp/UdpEchoApp.ned index bc9003f0a03..ead0bb4ab51 100644 --- a/src/inet/applications/udpapp/UdpEchoApp.ned +++ b/src/inet/applications/udpapp/UdpEchoApp.ned @@ -18,11 +18,11 @@ simple UdpEchoApp like IApp { parameters: string interfaceTableModule; // The path to the InterfaceTable module - int localPort; // local port to listen on + int localPort; // Local port to listen on @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @statistic[echoedPk](title="packets echoed"; source=packetSent; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); gates: diff --git a/src/inet/applications/udpapp/UdpSink.ned b/src/inet/applications/udpapp/UdpSink.ned index 2be17b40fbd..18e1bd5b7b4 100644 --- a/src/inet/applications/udpapp/UdpSink.ned +++ b/src/inet/applications/udpapp/UdpSink.ned @@ -16,17 +16,17 @@ simple UdpSink like IApp { parameters: string interfaceTableModule; // The path to the InterfaceTable module - double startTime @unit(s) = default(0s); // application start time - double stopTime @unit(s) = default(-1s); // time of finishing receiving - int localPort; // local port - bool receiveBroadcast = default(false); // if true, makes the socket receive broadcast packets - string multicastGroup = default(""); // if non-empty, makes the socket receive multicast packets sent to that group - string multicastSources = default(""); // if non-empty, than the socket receives multicast packets from those sources only + double startTime @unit(s) = default(0s); // Application start time + double stopTime @unit(s) = default(-1s); // Time of finishing receiving + int localPort; // Local port + bool receiveBroadcast = default(false); // If true, makes the socket receive broadcast packets + string multicastGroup = default(""); // If non-empty, makes the socket receive multicast packets sent to that group + string multicastSources = default(""); // If non-empty, than the socket receives multicast packets from those sources only @display("i=block/sink"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetReceived](type=inet::Packet); @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @statistic[throughput](title="throughput"; unit=bps; source="throughput(packetReceived)"; record=vector); diff --git a/src/inet/applications/udpapp/UdpSocketIo.ned b/src/inet/applications/udpapp/UdpSocketIo.ned index c053a5ed317..ef7a24c3169 100644 --- a/src/inet/applications/udpapp/UdpSocketIo.ned +++ b/src/inet/applications/udpapp/UdpSocketIo.ned @@ -18,16 +18,16 @@ simple UdpSocketIo int localPort = default(-1); string destAddress = default(""); int destPort; - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - bool dontFragment = default(false); // if true, asks IP to not fragment the message during routing - int dscp = default(-1); // if not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value - string multicastInterface = default(""); // if not empty, set the multicast output interface option on the socket (interface name expected) - object multicastAddresses = default([]); // list of multicast addresses that the application socket joins - bool receiveBroadcast = default(false); // if true, makes the socket receive broadcast packets - bool joinLocalMulticastGroups = default(false); // if true, makes the socket receive packets from all multicast groups set on local interfaces - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + bool dontFragment = default(false); // If true, asks IP to not fragment the message during routing + int dscp = default(-1); // If not -1, set the DSCP (IPv4/IPv6) field of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + string multicastInterface = default(""); // If not empty, set the multicast output interface option on the socket (interface name expected) + object multicastAddresses = default([]); // List of multicast addresses that the application socket joins + bool receiveBroadcast = default(false); // If true, makes the socket receive broadcast packets + bool joinLocalMulticastGroups = default(false); // If true, makes the socket receive packets from all multicast groups set on local interfaces + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @lifecycleSupport(); @display("i=block/socket"); @signal[packetSent](type=inet::Packet); diff --git a/src/inet/applications/udpapp/UdpVideoStreamClient.ned b/src/inet/applications/udpapp/UdpVideoStreamClient.ned index e4098ceafe2..bcfd5c2c641 100644 --- a/src/inet/applications/udpapp/UdpVideoStreamClient.ned +++ b/src/inet/applications/udpapp/UdpVideoStreamClient.ned @@ -20,14 +20,14 @@ import inet.applications.contract.IApp; simple UdpVideoStreamClient like IApp { parameters: - int localPort = default(-1); // local port (-1: use ephemeral port) - string serverAddress; // server address - int serverPort; // server port + int localPort = default(-1); // Local port (-1: use ephemeral port) + string serverAddress; // Server address + int serverPort; // Server port double startTime @unit(s) = default(1s); @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetReceived](type=inet::Packet); @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @statistic[throughput](title="throughput"; unit=bps; source="throughput(packetReceived)"; record=vector); diff --git a/src/inet/applications/udpapp/UdpVideoStreamServer.ned b/src/inet/applications/udpapp/UdpVideoStreamServer.ned index bffd4e6502e..ccb4eba463b 100644 --- a/src/inet/applications/udpapp/UdpVideoStreamServer.ned +++ b/src/inet/applications/udpapp/UdpVideoStreamServer.ned @@ -28,17 +28,17 @@ import inet.applications.contract.IApp; simple UdpVideoStreamServer like IApp { parameters: - int localPort; // port to listen on - volatile double sendInterval @unit(s); // interval between sending video stream packets - volatile int packetLen @unit(B); // length of a video packet in bytes - volatile int videoSize @unit(B); // length of full a video stream in bytes - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - int dscp = default(-1); // if not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + int localPort; // Port to listen on + volatile double sendInterval @unit(s); // Interval between sending video stream packets + volatile int packetLen @unit(B); // Length of a video packet in bytes + volatile int videoSize @unit(B); // Length of full a video stream in bytes + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + int dscp = default(-1); // If not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value @display("i=block/app"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[packetSent](type=inet::Packet); @signal[reqStreamBytes](type=long); @statistic[reqStreamBytes](title="requested stream bytes"; record=count,sum,vector; interpolationmode=none); diff --git a/src/inet/applications/voip/SimpleVoipReceiver.ned b/src/inet/applications/voip/SimpleVoipReceiver.ned index 00a7dace05d..1569730e97f 100644 --- a/src/inet/applications/voip/SimpleVoipReceiver.ned +++ b/src/inet/applications/voip/SimpleVoipReceiver.ned @@ -33,17 +33,17 @@ simple SimpleVoipReceiver like IApp int emodelA = default(5); // Advantage factor double emodelRo = default(93.2); // Basic signal-to-noise ratio - double playoutDelay @unit(s) = default(0s); // initial delay for beginning playout after receiving the first packet - bool adaptivePlayoutDelay = default(false); // if true, adjust playoutDelay after each talkspurt - int bufferSpace = default(20); // buffer size in packets - double mosSpareTime @unit(s) = default(1s); // spare time before calculating MOS (after calculated playout time of last packet) + double playoutDelay @unit(s) = default(0s); // Initial delay for beginning playout after receiving the first packet + bool adaptivePlayoutDelay = default(false); // If true, adjust playoutDelay after each talkspurt + int bufferSpace = default(20); // Buffer size in packets + double mosSpareTime @unit(s) = default(1s); // Spare time before calculating MOS (after calculated playout time of last packet) - @signal[voipPacketDelay](type="simtime_t"); // when receive a frame - @signal[voipPacketLossRate](type="double"); // at end of talkspurt - @signal[voipPlayoutDelay](type="simtime_t"); // at end of talkspurt - @signal[voipPlayoutLossRate](type="double"); // at end of talkspurt - @signal[voipMosRate](type="double"); // at end of talkspurt - @signal[voipTaildropLossRate](type="double"); // at end of talkspurt + @signal[voipPacketDelay](type="simtime_t"); // When receive a frame + @signal[voipPacketLossRate](type="double"); // At end of talkspurt + @signal[voipPlayoutDelay](type="simtime_t"); // At end of talkspurt + @signal[voipPlayoutLossRate](type="double"); // At end of talkspurt + @signal[voipMosRate](type="double"); // At end of talkspurt + @signal[voipTaildropLossRate](type="double"); // At end of talkspurt @statistic[endToEndDelay](title="VoIP Packet End-to-End Delay"; unit="s"; source="voipPacketDelay"; record=stats,vector); @statistic[packetLossRate](title="VoIP Packet Loss"; unit="ratio"; source="voipPacketLossRate"; record=stats,vector); @statistic[playoutDelay](title="VoIP Playout Delay"; unit="s"; source="voipPlayoutDelay"; record=stats,vector); diff --git a/src/inet/applications/voip/SimpleVoipSender.ned b/src/inet/applications/voip/SimpleVoipSender.ned index acaea3d177c..be426d1f67a 100644 --- a/src/inet/applications/voip/SimpleVoipSender.ned +++ b/src/inet/applications/voip/SimpleVoipSender.ned @@ -39,12 +39,12 @@ simple SimpleVoipSender like IApp int localPort = default(-1); int destPort; string destAddress; - int talkPacketSize @unit(B) = default(40B); // size of talk packets in bytes + int talkPacketSize @unit(B) = default(40B); // Size of talk packets in bytes volatile double talkspurtDuration @unit(s) = default(weibull(1.423s, 0.824s)); volatile double silenceDuration @unit(s) = default(weibull(0.899s, 1.089s)); - double packetizationInterval @unit(s) = default(20ms); // interval between sending voice packets - double startTime @unit(s) = default(0s); // time of start sending - double stopTime @unit(s) = default(-1s); // time of end of sending, -1 means forever + double packetizationInterval @unit(s) = default(20ms); // Interval between sending voice packets + double startTime @unit(s) = default(0s); // Time of start sending + double stopTime @unit(s) = default(-1s); // Time of end of sending, -1 means forever @display("i=block/source"); gates: diff --git a/src/inet/applications/voipstream/VoipStreamReceiver.ned b/src/inet/applications/voipstream/VoipStreamReceiver.ned index 4813e567851..8e5359021ad 100644 --- a/src/inet/applications/voipstream/VoipStreamReceiver.ned +++ b/src/inet/applications/voipstream/VoipStreamReceiver.ned @@ -27,13 +27,13 @@ simple VoipStreamReceiver like IApp int localPort; double playoutDelay @unit(s) = default(20ms); string resultFile; - @signal[packetReceived](type=inet::Packet); // expected type=VoipStreamPacket + @signal[packetReceived](type=inet::Packet); // Expected type=VoipStreamPacket @signal[packetDropped](type=inet::Packet); @signal[lostSamples](type=long); @signal[lostPackets](type=long); @signal[packetHasVoice](type=long); // 1=yes, 0=no @signal[connState](type=long); // 1=open, -1=close - @signal[delay](type=simtime_t); // total time lag of voice transmission + @signal[delay](type=simtime_t); // Total time lag of voice transmission @statistic[packetReceived](title="packets received"; source=packetReceived; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @statistic[dropPk](title="packets dropped"; source=packetDropped; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @statistic[lostSamples](title="lost samples"; interpolationmode=none; record=vector,stats); diff --git a/src/inet/applications/voipstream/VoipStreamSender.ned b/src/inet/applications/voipstream/VoipStreamSender.ned index 06b9c00e9d1..44e279ec79f 100644 --- a/src/inet/applications/voipstream/VoipStreamSender.ned +++ b/src/inet/applications/voipstream/VoipStreamSender.ned @@ -31,15 +31,15 @@ simple VoipStreamSender like IApp int voipHeaderSize @unit(B); int voipSilenceThreshold; int sampleRate @unit(Hz) = default(8000Hz); - string codec = default("g726"); // used by ffmpeg::avcodec_find_encoder_by_name() + string codec = default("g726"); // Used by ffmpeg::avcodec_find_encoder_by_name() int compressedBitRate @unit(bps) = default(40kbps); double packetTimeLength @unit(s) = default(20ms); - string soundFile; // file name of input audio file + string soundFile; // File name of input audio file int repeatCount = default(1); - string traceFileName = default(""); // file name to save output stream (wav), OFF when empty - int timeToLive = default(-1); // if not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value - int dscp = default(-1); // if not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + string traceFileName = default(""); // File name to save output stream (wav), OFF when empty + int timeToLive = default(-1); // If not -1, set the TTL (IPv4) or Hop Limit (IPv6) field of sent packets to this value + int dscp = default(-1); // If not -1, set the DSCP field (on IPv4/IPv6) of sent packets to this value + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value @signal[packetSent](type=inet::Packet); // TODO first chunk is VoipStreamPacket @statistic[packetSent](title="packets sent"; source=packetSent; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @display("i=block/departure"); diff --git a/src/inet/clock/base/ClockBase.ned b/src/inet/clock/base/ClockBase.ned index a0641e29fd4..a90c6f62ab4 100644 --- a/src/inet/clock/base/ClockBase.ned +++ b/src/inet/clock/base/ClockBase.ned @@ -13,9 +13,9 @@ package inet.clock.base; module ClockBase { parameters: - string displayStringTextFormat = default("%t"); // determines the text that is written on top of the submodule + string displayStringTextFormat = default("%t"); // Determines the text that is written on top of the submodule string referenceClock = default(""); // full path of reference clock - double emitClockTimeInterval @unit(s) = default(0s); // non-zero value means the clock time will be emitted periodically + double emitClockTimeInterval @unit(s) = default(0s); // Non-zero value means the clock time will be emitted periodically @class(ClockBase); @display("i=block/timer"); @signal[timeChanged](type=simtime_t); diff --git a/src/inet/clock/base/DriftingOscillatorBase.ned b/src/inet/clock/base/DriftingOscillatorBase.ned index 1ed9df07f68..862c80f6107 100644 --- a/src/inet/clock/base/DriftingOscillatorBase.ned +++ b/src/inet/clock/base/DriftingOscillatorBase.ned @@ -14,9 +14,9 @@ package inet.clock.base; simple DriftingOscillatorBase extends OscillatorBase { parameters: - displayStringTextFormat = default("%c (%n + %d)"); // determines the text that is written on top of the submodule + displayStringTextFormat = default("%c (%n + %d)"); // Determines the text that is written on top of the submodule double nominalTickLength @unit(s) = default(0s); // 0 means simulation time precision - double tickOffset @unit(s) = default(0s); // shifts ticks to the past, must be in the range of [0, current tick length) + double tickOffset @unit(s) = default(0s); // Shifts ticks to the past, must be in the range of [0, current tick length) @signal[preOscillatorStateChanged]; @signal[postOscillatorStateChanged]; @class(DriftingOscillatorBase); diff --git a/src/inet/clock/base/OscillatorBase.ned b/src/inet/clock/base/OscillatorBase.ned index 511605c97fa..6877f4e07c2 100644 --- a/src/inet/clock/base/OscillatorBase.ned +++ b/src/inet/clock/base/OscillatorBase.ned @@ -13,7 +13,7 @@ package inet.clock.base; simple OscillatorBase { parameters: - string displayStringTextFormat = default("%n"); // determines the text that is written on top of the submodule + string displayStringTextFormat = default("%n"); // Determines the text that is written on top of the submodule @class(OscillatorBase); @display("i=block/tunnel"); @signal[driftRateChanged](type=double); diff --git a/src/inet/clock/model/MultiClock.ned b/src/inet/clock/model/MultiClock.ned index 56c5f31be3d..9b63ff4bf35 100644 --- a/src/inet/clock/model/MultiClock.ned +++ b/src/inet/clock/model/MultiClock.ned @@ -20,8 +20,8 @@ import inet.clock.contract.IClock; module MultiClock like IClock { parameters: - int numClocks; // number of subclocks - int activeClockIndex @mutable = default(0); // the currently active subclock + int numClocks; // Number of subclocks + int activeClockIndex @mutable = default(0); // The currently active subclock @display("i=block/timer"); @class(MultiClock); @signal[timeChanged](type=simtime_t); diff --git a/src/inet/clock/model/OscillatorBasedClock.ned b/src/inet/clock/model/OscillatorBasedClock.ned index 7b3e57c3700..d048ba3779b 100644 --- a/src/inet/clock/model/OscillatorBasedClock.ned +++ b/src/inet/clock/model/OscillatorBasedClock.ned @@ -32,9 +32,9 @@ import inet.clock.contract.IOscillator; module OscillatorBasedClock extends ClockBase like IClock { parameters: - displayStringTextFormat = default("%t (%c)"); // determines the text that is written on top of the submodule - double initialClockTime @unit(s) = default(0s); // clock time at the simulation time when the module is initialized - string roundingMode @enum("down","up","closer","none") = default("up"); // when scheduling to a clock time or with a clock delay this clock uses rounding with respect to the nominal tick length + displayStringTextFormat = default("%t (%c)"); // Determines the text that is written on top of the submodule + double initialClockTime @unit(s) = default(0s); // Clock time at the simulation time when the module is initialized + string roundingMode @enum("down","up","closer","none") = default("up"); // When scheduling to a clock time or with a clock delay this clock uses rounding with respect to the nominal tick length @class(OscillatorBasedClock); submodules: oscillator: like IOscillator { diff --git a/src/inet/clock/oscillator/ConstantDriftOscillator.ned b/src/inet/clock/oscillator/ConstantDriftOscillator.ned index 060a2ad6048..4420163418b 100644 --- a/src/inet/clock/oscillator/ConstantDriftOscillator.ned +++ b/src/inet/clock/oscillator/ConstantDriftOscillator.ned @@ -22,7 +22,7 @@ import inet.clock.contract.IOscillator; simple ConstantDriftOscillator extends DriftingOscillatorBase like IOscillator { parameters: - double driftRate @unit(ppm) = default(0ppm); // expressed as a ratio in parts per million + double driftRate @unit(ppm) = default(0ppm); // Expressed as a ratio in parts per million @class(ConstantDriftOscillator); } diff --git a/src/inet/clock/oscillator/RandomDriftOscillator.ned b/src/inet/clock/oscillator/RandomDriftOscillator.ned index 995792563e7..3e73b9cfae8 100644 --- a/src/inet/clock/oscillator/RandomDriftOscillator.ned +++ b/src/inet/clock/oscillator/RandomDriftOscillator.ned @@ -17,11 +17,11 @@ import inet.clock.contract.IOscillator; simple RandomDriftOscillator extends DriftingOscillatorBase like IOscillator { parameters: - double initialDriftRate @unit(ppm) = default(0ppm); // expressed as a ratio in parts per million - volatile double changeInterval @unit(s); // drift change happens at the end of every interval - volatile double driftRateChange @unit(ppm) = default(0ppm); // integrated over time (random walk), no change by default - double driftRateChangeLowerLimit @unit(ppm) = default(-inf ppm); // lower limit for random walk, no limit by default - double driftRateChangeUpperLimit @unit(ppm) = default(inf ppm); // upper limit for random walk, no limit by default + double initialDriftRate @unit(ppm) = default(0ppm); // Expressed as a ratio in parts per million + volatile double changeInterval @unit(s); // Drift change happens at the end of every interval + volatile double driftRateChange @unit(ppm) = default(0ppm); // Integrated over time (random walk), no change by default + double driftRateChangeLowerLimit @unit(ppm) = default(-inf ppm); // Lower limit for random walk, no limit by default + double driftRateChangeUpperLimit @unit(ppm) = default(inf ppm); // Upper limit for random walk, no limit by default @class(RandomDriftOscillator); } diff --git a/src/inet/common/ExternalEnvironment.ned b/src/inet/common/ExternalEnvironment.ned index 7cae2075481..8243a675cce 100644 --- a/src/inet/common/ExternalEnvironment.ned +++ b/src/inet/common/ExternalEnvironment.ned @@ -21,11 +21,11 @@ package inet.common; simple ExternalEnvironment { parameters: - int initStage = default(0); // initialization stage for the setup command - bool globalNamespace = default(false); // create new network namespaces under /var/run/netns/ (Linux only) - string namespace = default(""); // name of the host OS network namespace (optional) (Linux only) - string setupCommand = default(""); // a host OS system command - string teardownCommand = default(""); // a host OS system command + int initStage = default(0); // Initialization stage for the setup command + bool globalNamespace = default(false); // Create new network namespaces under /var/run/netns/ (Linux only) + string namespace = default(""); // Name of the host OS network namespace (optional) (Linux only) + string setupCommand = default(""); // A host OS system command + string teardownCommand = default(""); // A host OS system command @display("i=block/app"); } diff --git a/src/inet/common/ExternalProcess.ned b/src/inet/common/ExternalProcess.ned index 552489d6559..b5077bd49ef 100644 --- a/src/inet/common/ExternalProcess.ned +++ b/src/inet/common/ExternalProcess.ned @@ -17,13 +17,13 @@ package inet.common; simple ExternalProcess { parameters: - string namespace = default(""); // name of the OS network namespace (optional) - string command; // executable with arguments (e.g. "ping google.com"); not a shell command as it will be passed to execvp - string onExit @enum("terminateSimulation","relaunch","ignore") = default("ignore"); // determines what happens when the process exits + string namespace = default(""); // Name of the OS network namespace (optional) + string command; // Executable with arguments (e.g. "ping google.com"); not a shell command as it will be passed to execvp + string onExit @enum("terminateSimulation","relaunch","ignore") = default("ignore"); // Determines what happens when the process exits double startTime @unit(s) = default(0s); double relaunchDelay @unit(s) = default(0s); - bool printStdout = default(false); // print STDOUT to the simulation's STDOUT - bool printStderr = default(true); // print STDERR to the simulation's STDERR + bool printStdout = default(false); // Print STDOUT to the simulation's STDOUT + bool printStderr = default(true); // Print STDERR to the simulation's STDERR @display("i=block/app"); } diff --git a/src/inet/common/MessageDispatcher.ned b/src/inet/common/MessageDispatcher.ned index 7b88fa29409..cc26102d302 100644 --- a/src/inet/common/MessageDispatcher.ned +++ b/src/inet/common/MessageDispatcher.ned @@ -40,12 +40,12 @@ import inet.queueing.base.PacketProcessorBase; simple MessageDispatcher extends PacketProcessorBase { parameters: - string interfaceTableModule; // module path to the ~InterfaceTable module + string interfaceTableModule; // Module path to the ~InterfaceTable module bool forwardServiceRegistration = default(true); bool forwardProtocolRegistration = default(true); - object interfaceMapping = default({}); // maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default - object serviceMapping = default({}); // maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default - object protocolMapping = default({}); // maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default + object interfaceMapping = default({}); // Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default + object serviceMapping = default({}); // Maps protocols to connected submodule names (e.g. {"ethernetmac": "bridging"}), overrides automatically learned dispatching; * overrides all learned services, ? overrides default + object protocolMapping = default({}); // Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default @class(MessageDispatcher); @display("i=-;b=100,5,,,,1;"); gates: diff --git a/src/inet/common/ResidenceTimeMeasurer.ned b/src/inet/common/ResidenceTimeMeasurer.ned index 15096af3809..e3951c29a45 100644 --- a/src/inet/common/ResidenceTimeMeasurer.ned +++ b/src/inet/common/ResidenceTimeMeasurer.ned @@ -18,9 +18,9 @@ package inet.common; simple ResidenceTimeMeasurer like IMeasurer { parameters: - string subscriptionModule = default("^"); // relative module path where subscription happens - string measurementStartSignal = default("receptionEnded"); // subscribed signal for measurement start - string measurementEndSignal = default("transmissionStarted"); // subscribed signal for measurement end + string subscriptionModule = default("^"); // Relative module path where subscription happens + string measurementStartSignal = default("receptionEnded"); // Subscribed signal for measurement start + string measurementEndSignal = default("transmissionStarted"); // Subscribed signal for measurement end @display("i=block/timer"); @signal[packetStayed](type=inet::Packet); // the statistics value is the maximum residence time for any bit in the outgoing packet diff --git a/src/inet/common/geometry/common/GeographicCoordinateSystem.ned b/src/inet/common/geometry/common/GeographicCoordinateSystem.ned index a9f962484f3..927ede299b0 100644 --- a/src/inet/common/geometry/common/GeographicCoordinateSystem.ned +++ b/src/inet/common/geometry/common/GeographicCoordinateSystem.ned @@ -26,9 +26,9 @@ simple SimpleGeographicCoordinateSystem like IGeographicCoordinateSystem { parameters: @display("i=block/table2"); - double sceneLatitude @unit(deg); // latitude coordinate of the scene origin - double sceneLongitude @unit(deg); // longitude coordinate of the scene origin - double sceneAltitude @unit(m) = default(0m); // altitude coordinate of the scene origin + double sceneLatitude @unit(deg); // Latitude coordinate of the scene origin + double sceneLongitude @unit(deg); // Longitude coordinate of the scene origin + double sceneAltitude @unit(m) = default(0m); // Altitude coordinate of the scene origin } // @@ -39,11 +39,11 @@ simple OsgGeographicCoordinateSystem like IGeographicCoordinateSystem { parameters: @display("i=block/table2"); - double sceneLatitude @unit(deg); // latitude coordinate of the scene origin - double sceneLongitude @unit(deg); // longitude coordinate of the scene origin - double sceneAltitude @unit(m) = default(0m); // altitude coordinate of the scene origin - double sceneHeading @unit(deg) = default(90deg); // geographic heading of the scene (0deg means X axis points north, 90deg means X axis points east) - double sceneElevation @unit(deg) = default(0deg); // geographic elevation of the scene (0deg means X axis is horizontal, positive rotates X axis towards the sky) - double sceneBank @unit(deg) = default(0deg); // bank of the scene + double sceneLatitude @unit(deg); // Latitude coordinate of the scene origin + double sceneLongitude @unit(deg); // Longitude coordinate of the scene origin + double sceneAltitude @unit(m) = default(0m); // Altitude coordinate of the scene origin + double sceneHeading @unit(deg) = default(90deg); // Geographic heading of the scene (0deg means X axis points north, 90deg means X axis points east) + double sceneElevation @unit(deg) = default(0deg); // Geographic elevation of the scene (0deg means X axis is horizontal, positive rotates X axis towards the sky) + double sceneBank @unit(deg) = default(0deg); // Bank of the scene } diff --git a/src/inet/common/lifecycle/NodeStatus.ned b/src/inet/common/lifecycle/NodeStatus.ned index 306e9a33ee1..4f01a6a6c04 100644 --- a/src/inet/common/lifecycle/NodeStatus.ned +++ b/src/inet/common/lifecycle/NodeStatus.ned @@ -16,7 +16,7 @@ simple NodeStatus { parameters: //TODO @signal, @statistic - string initialStatus = default("UP"); // initial status of the network node + string initialStatus = default("UP"); // Initial status of the network node @display("i=block/cogwheel;is=s"); @signal[nodeStatusChanged](type=inet::NodeStatus); } diff --git a/src/inet/common/misc/ThruputMeteringChannel.ned b/src/inet/common/misc/ThruputMeteringChannel.ned index cc7f181eb35..ae696d5e2da 100644 --- a/src/inet/common/misc/ThruputMeteringChannel.ned +++ b/src/inet/common/misc/ThruputMeteringChannel.ned @@ -33,6 +33,6 @@ channel ThruputMeteringChannel extends ned.DatarateChannel { @class(ThruputMeteringChannel); bool displayAsTooltip = default(false); - string thruputDisplayFormat = default(""); // the format string for display on the link. Leave empty to disable display + string thruputDisplayFormat = default(""); // The format string for display on the link. Leave empty to disable display } diff --git a/src/inet/common/packet/recorder/PcapRecorder.ned b/src/inet/common/packet/recorder/PcapRecorder.ned index aacebe2b410..49df48b951d 100644 --- a/src/inet/common/packet/recorder/PcapRecorder.ned +++ b/src/inet/common/packet/recorder/PcapRecorder.ned @@ -32,20 +32,20 @@ package inet.common.packet.recorder; simple PcapRecorder { parameters: - bool verbose = default(true); // whether to log packets on the module output - string pcapFile = default(""); // the PCAP file to be written + bool verbose = default(true); // Whether to log packets on the module output + string pcapFile = default(""); // The PCAP file to be written string fileFormat @enum("pcap", "pcapng") = default("pcapng"); - int snaplen = default(65535); // maximum number of bytes to record per packet - int timePrecision = default(6); // Time precison in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format). - bool dumpBadFrames = default(true); // enable dump of frames with hasBitError - string moduleNamePatterns = default("wlan[*] eth[*] ppp[*]"); // space-separated list of sibling module names to listen on - string sendingSignalNames = default("packetSentToLower"); // space-separated list of outbound packet signals to subscribe to - string receivingSignalNames = default("packetReceivedFromLower"); // space-separated list of inbound packet signals to subscribe to - string dumpProtocols = default("ethernetmac ppp ieee80211mac"); // space-separated list of protocol names as defined in the Protocol class - object packetFilter = default("*"); // which packets are considered, matches all packets by default - string helpers = default(""); // usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype + int snaplen = default(65535); // Maximum number of bytes to record per packet + int timePrecision = default(6); // Time precison in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format). + bool dumpBadFrames = default(true); // Enable dump of frames with hasBitError + string moduleNamePatterns = default("wlan[*] eth[*] ppp[*]"); // Space-separated list of sibling module names to listen on + string sendingSignalNames = default("packetSentToLower"); // Space-separated list of outbound packet signals to subscribe to + string receivingSignalNames = default("packetReceivedFromLower"); // Space-separated list of inbound packet signals to subscribe to + string dumpProtocols = default("ethernetmac ppp ieee80211mac"); // Space-separated list of protocol names as defined in the Protocol class + object packetFilter = default("*"); // Which packets are considered, matches all packets by default + string helpers = default(""); // Usable PcapRecorder::IHelper helpers for accept packettype and store/convert packet as specified linktype // currently available: "inet::AckingMacToEthernetPcapRecorderHelper" - bool alwaysFlush = default(false); // flush the pcapFile after each write to ensure that all packets are captured in case of a crash + bool alwaysFlush = default(false); // Flush the pcapFile after each write to ensure that all packets are captured in case of a crash string displayStringTextFormat = default("rec: %n pks"); @display("i=block/blackboard"); @signal[packetRecorded](type=Packet); diff --git a/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned b/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned index 9baa664852a..0666f147a51 100644 --- a/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned +++ b/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned @@ -31,9 +31,9 @@ package inet.emulation.linklayer.ethernet; simple ExtEthernetSocket { parameters: - string device; // name of existing real ethernet device + string device; // Name of existing real ethernet device string namespace = default(""); - string packetNameFormat = default("Ext-%p-%t-%n"); // name of received packets + string packetNameFormat = default("Ext-%p-%t-%n"); // Name of received packets @display("i=block/rxtx"); @signal[packetSentToUpper](type=Packet); @signal[packetReceivedFromUpper](type=Packet); diff --git a/src/inet/emulation/linklayer/ethernet/ExtEthernetTapDevice.ned b/src/inet/emulation/linklayer/ethernet/ExtEthernetTapDevice.ned index 5f936b7928f..f3b236de7ba 100644 --- a/src/inet/emulation/linklayer/ethernet/ExtEthernetTapDevice.ned +++ b/src/inet/emulation/linklayer/ethernet/ExtEthernetTapDevice.ned @@ -16,7 +16,7 @@ package inet.emulation.linklayer.ethernet; simple ExtEthernetTapDevice { parameters: - string device; // name of existing real tap interface + string device; // Name of existing real tap interface string namespace = default(""); string packetNameFormat = default("Ext-%p-%t-%n"); @display("i=block/rxtx"); diff --git a/src/inet/emulation/linklayer/ethernet/ExtUpperEthernetInterface.ned b/src/inet/emulation/linklayer/ethernet/ExtUpperEthernetInterface.ned index c3e964f8f48..a3a035a1988 100644 --- a/src/inet/emulation/linklayer/ethernet/ExtUpperEthernetInterface.ned +++ b/src/inet/emulation/linklayer/ethernet/ExtUpperEthernetInterface.ned @@ -21,7 +21,7 @@ import inet.queueing.contract.IPacketQueue; module ExtUpperEthernetInterface extends ExtInterface like IEthernetInterface { parameters: - bool csmacdSupport = default(false); // by default CSMA/CD is turned off, so only point-to-point duplex links are supported. + bool csmacdSupport = default(false); // By default CSMA/CD is turned off, so only point-to-point duplex links are supported. double bitrate @unit(bps) = default(nan bps); *.bitrate = default(bitrate); @display("bgb=450,400"); diff --git a/src/inet/emulation/linklayer/ieee80211/ExtUpperIeee80211Interface.ned b/src/inet/emulation/linklayer/ieee80211/ExtUpperIeee80211Interface.ned index 418e4ea2c86..0f51459522e 100644 --- a/src/inet/emulation/linklayer/ieee80211/ExtUpperIeee80211Interface.ned +++ b/src/inet/emulation/linklayer/ieee80211/ExtUpperIeee80211Interface.ned @@ -39,7 +39,7 @@ module ExtUpperIeee80211Interface extends ExtInterface like IWirelessInterface *.interfaceTableModule = default(absPath(this.interfaceTableModule)); *.energySourceModule = default(absPath(this.energySourceModule)); gates: - input radioIn @labels(IWirelessSignal); // to receive signals + input radioIn @labels(IWirelessSignal); // To receive signals submodules: mib: Ieee80211Mib { parameters: diff --git a/src/inet/environment/common/PhysicalEnvironment.ned b/src/inet/environment/common/PhysicalEnvironment.ned index 5a6dfd8880d..9e9ef2cff60 100644 --- a/src/inet/environment/common/PhysicalEnvironment.ned +++ b/src/inet/environment/common/PhysicalEnvironment.ned @@ -153,14 +153,14 @@ import inet.environment.contract.IPhysicalEnvironment; module PhysicalEnvironment like IPhysicalEnvironment { parameters: - string coordinateSystemModule = default(""); // module path of the geographic coordinate system module + string coordinateSystemModule = default(""); // Module path of the geographic coordinate system module double temperature @unit(K) = default(293K); - double spaceMinX @unit(m) = default(nan m); // lower bound of x coordinates in space, NaN means determined by physical objects, NaN by default - double spaceMinY @unit(m) = default(nan m); // lower bound of y coordinates in space, NaN means determined by physical objects, NaN by default - double spaceMinZ @unit(m) = default(nan m); // lower bound of z coordinates in space, NaN means determined by physical objects, NaN by default - double spaceMaxX @unit(m) = default(nan m); // upper bound of x coordinates in space, NaN means determined by physical objects, NaN by default - double spaceMaxY @unit(m) = default(nan m); // upper bound of y coordinates in space, NaN means determined by physical objects, NaN by default - double spaceMaxZ @unit(m) = default(nan m); // upper bound of z coordinates in space, NaN means determined by physical objects, NaN by default + double spaceMinX @unit(m) = default(nan m); // Lower bound of x coordinates in space, NaN means determined by physical objects, NaN by default + double spaceMinY @unit(m) = default(nan m); // Lower bound of y coordinates in space, NaN means determined by physical objects, NaN by default + double spaceMinZ @unit(m) = default(nan m); // Lower bound of z coordinates in space, NaN means determined by physical objects, NaN by default + double spaceMaxX @unit(m) = default(nan m); // Upper bound of x coordinates in space, NaN means determined by physical objects, NaN by default + double spaceMaxY @unit(m) = default(nan m); // Upper bound of y coordinates in space, NaN means determined by physical objects, NaN by default + double spaceMaxZ @unit(m) = default(nan m); // Upper bound of z coordinates in space, NaN means determined by physical objects, NaN by default xml config = default(xml("")); @display("i=misc/town"); @class(PhysicalEnvironment); diff --git a/src/inet/environment/objectcache/BvhObjectCache.ned b/src/inet/environment/objectcache/BvhObjectCache.ned index e67b2e88ce6..277a4e1cdda 100644 --- a/src/inet/environment/objectcache/BvhObjectCache.ned +++ b/src/inet/environment/objectcache/BvhObjectCache.ned @@ -17,7 +17,7 @@ module BvhObjectCache like IObjectCache { parameters: string physicalEnvironmentModule = default("^"); - int leafCapacity = default(1); // the upper bound for the number of physical objects per leaf + int leafCapacity = default(1); // The upper bound for the number of physical objects per leaf string axisOrder = default("XYZ"); // "X", "XY", "ZYZ", "ZZXZZYXYX", etc are all allowed combinations @display("i=block/table2"); @class(BvhObjectCache); diff --git a/src/inet/environment/objectcache/GridObjectCache.ned b/src/inet/environment/objectcache/GridObjectCache.ned index 3d244f84b2b..a856b62b328 100644 --- a/src/inet/environment/objectcache/GridObjectCache.ned +++ b/src/inet/environment/objectcache/GridObjectCache.ned @@ -22,9 +22,9 @@ module GridObjectCache like IObjectCache double cellSizeX @unit(m) = default(nan m); // NaN means use cell count double cellSizeY @unit(m) = default(nan m); // NaN means use cell count double cellSizeZ @unit(m) = default(nan m); // NaN means use cell count - int cellCountX = default(10); // divide space to so many cells - int cellCountY = default(10); // divide space to so many cells - int cellCountZ = default(10); // divide space to so many cells + int cellCountX = default(10); // Divide space to so many cells + int cellCountY = default(10); // Divide space to so many cells + int cellCountZ = default(10); // Divide space to so many cells @display("i=block/table2"); @class(GridObjectCache); } diff --git a/src/inet/linklayer/acking/AckingMac.ned b/src/inet/linklayer/acking/AckingMac.ned index cbf5d2ec86e..b9ab1a4c544 100644 --- a/src/inet/linklayer/acking/AckingMac.ned +++ b/src/inet/linklayer/acking/AckingMac.ned @@ -32,7 +32,7 @@ module AckingMac extends MacProtocolBase like ILinkLayer, IMacProtocol int mtu @unit(B) = default(4470B); int headerLength @unit(B) = default(16B); // AckingMacHeader length bool promiscuous = default(false); - bool fullDuplex = default(true); // allows transmitting and receiving simultaneously (transceiver radio mode) + bool fullDuplex = default(true); // Allows transmitting and receiving simultaneously (transceiver radio mode) bool useAck = default(true); double ackTimeout @unit(s) = default(100ms); diff --git a/src/inet/linklayer/configurator/common/FailureProtectionConfigurator.ned b/src/inet/linklayer/configurator/common/FailureProtectionConfigurator.ned index 6e352339410..c7442707dbd 100644 --- a/src/inet/linklayer/configurator/common/FailureProtectionConfigurator.ned +++ b/src/inet/linklayer/configurator/common/FailureProtectionConfigurator.ned @@ -26,7 +26,7 @@ simple FailureProtectionConfigurator like INetworkConfigurator parameters: string streamRedundancyConfiguratorModule = default("streamRedundancyConfigurator"); string gateScheduleConfiguratorModule = default("gateScheduleConfigurator"); - object configuration = default([]); // a vector of objects (e.g. [{...}, {...}]) where each object has the following fields: name, type, application, source, destination, PCP, gate index, packetFilter, packetLength, packetInterval, maxLatency, linkFailureProtection, nodeFailureProtection, maxRedundancy + object configuration = default([]); // A vector of objects (e.g. [{...}, {...}]) where each object has the following fields: name, type, application, source, destination, PCP, gate index, packetFilter, packetLength, packetInterval, maxLatency, linkFailureProtection, nodeFailureProtection, maxRedundancy // here is an example: [{name: "s1", application: "app[0]", source: "source", destination: "destination", pcp: 0, gateIndex: 0, packetFilter: "*", packetLength: 200B, packetInterval: 500us, maxLatency: 100us, linkFailureProtection: [{any: 1, of: "*"}], maxRedundancy: 2}] @display("i=block/cogwheel"); } diff --git a/src/inet/linklayer/configurator/common/L2NodeConfigurator.ned b/src/inet/linklayer/configurator/common/L2NodeConfigurator.ned index bd44df4f4fe..b6029fa3cc9 100644 --- a/src/inet/linklayer/configurator/common/L2NodeConfigurator.ned +++ b/src/inet/linklayer/configurator/common/L2NodeConfigurator.ned @@ -30,6 +30,6 @@ simple L2NodeConfigurator like IL2NodeConfigurator parameters: @display("i=block/cogwheel"); string interfaceTableModule; - string l2ConfiguratorModule = default("l2NetworkConfigurator"); // the absolute path to the ~L2NetworkConfigurator; use "" if there is no configurator + string l2ConfiguratorModule = default("l2NetworkConfigurator"); // The absolute path to the ~L2NetworkConfigurator; use "" if there is no configurator } diff --git a/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned b/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned index 183f4eda6f9..3d765a78656 100644 --- a/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned +++ b/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned @@ -19,9 +19,9 @@ import inet.networklayer.configurator.contract.INetworkConfigurator; simple StreamRedundancyConfigurator like INetworkConfigurator { parameters: - int minVlanId = default(0); // lowest available VLAN ID - int maxVlanId = default(4095); // highest available VLAN ID - object configuration @mutable = default([]); // a vector of objects (e.g. [{...}, {...}]) where each object has the following fields: name, source, destination, packetFilter, paths + int minVlanId = default(0); // Lowest available VLAN ID + int maxVlanId = default(4095); // Highest available VLAN ID + object configuration @mutable = default([]); // A vector of objects (e.g. [{...}, {...}]) where each object has the following fields: name, source, destination, packetFilter, paths // here is an example: [{name: "S1", packetFilter: "*", source: "source", destination: "destination", trees: [[["s1", "s2a", "s3a"]], [["s1", "s2b", "s3b"]], [["s1", "s2a", "s2b", "s3b"]], [["s1", "s2b", "s2a", "s3a"]]]}] @display("i=block/cogwheel"); } diff --git a/src/inet/linklayer/configurator/gatescheduling/base/GateScheduleConfiguratorBase.ned b/src/inet/linklayer/configurator/gatescheduling/base/GateScheduleConfiguratorBase.ned index 858a3ec2f2b..a3f174caf89 100644 --- a/src/inet/linklayer/configurator/gatescheduling/base/GateScheduleConfiguratorBase.ned +++ b/src/inet/linklayer/configurator/gatescheduling/base/GateScheduleConfiguratorBase.ned @@ -34,8 +34,8 @@ package inet.linklayer.configurator.gatescheduling.base; simple GateScheduleConfiguratorBase { parameters: - double gateCycleDuration @unit(s); // the globally used gate scheduling period in each PeriodicGate modules - object configuration @mutable = default([]); // array of objects, see ~GateScheduleConfiguratorBase module documentation for more details + double gateCycleDuration @unit(s); // The globally used gate scheduling period in each PeriodicGate modules + object configuration @mutable = default([]); // Array of objects, see ~GateScheduleConfiguratorBase module documentation for more details // example: [{name: "s1", type: "unicast", application: "app[0]", pcp: 0, gateIndex: 0, source: "wheel*", destination: "hud", packetLength: 100B, packetInterval: 5ms, maxLatency: 100us, maxJitter: 10us, pathFragments: [["a", "b", "c"]]}] @display("i=block/cogwheel"); } diff --git a/src/inet/linklayer/contract/IEthernetMac.ned b/src/inet/linklayer/contract/IEthernetMac.ned index 1b7f854ae2b..5dea44c5509 100644 --- a/src/inet/linklayer/contract/IEthernetMac.ned +++ b/src/inet/linklayer/contract/IEthernetMac.ned @@ -37,14 +37,14 @@ package inet.linklayer.contract; moduleinterface IEtherMac { parameters: - bool promiscuous; // if true, all packets are received, otherwise only the + bool promiscuous; // If true, all packets are received, otherwise only the // ones with matching destination MAC address - bool duplexMode; // selects full-duplex (true) or half-duplex (false) operation + bool duplexMode; // Selects full-duplex (true) or half-duplex (false) operation int mtu @unit(B); @display("i=block/rxtx"); gates: - input upperLayerIn @labels(EtherFrame); // to ~EthernetEncapsulation or ~IMacRelayUnit - output upperLayerOut @labels(EtherFrame); // to ~EthernetEncapsulation or ~IMacRelayUnit - inout phys @labels(EthernetSignal); // to the network + input upperLayerIn @labels(EtherFrame); // To ~EthernetEncapsulation or ~IMacRelayUnit + output upperLayerOut @labels(EtherFrame); // To ~EthernetEncapsulation or ~IMacRelayUnit + inout phys @labels(EthernetSignal); // To the network } diff --git a/src/inet/linklayer/csmaca/CsmaCaMac.ned b/src/inet/linklayer/csmaca/CsmaCaMac.ned index c2ef7994fc4..93b435a6cbc 100644 --- a/src/inet/linklayer/csmaca/CsmaCaMac.ned +++ b/src/inet/linklayer/csmaca/CsmaCaMac.ned @@ -56,17 +56,17 @@ module CsmaCaMac extends MacProtocolBase like IMacProtocol string fcsMode @enum("declared","computed") = default("declared"); bool useAck = default(true); double bitrate @unit(bps); - int headerLength @unit(B) = default(17B); // maximum 255 byte, minimum 17B for serializing, see CsmaCaMacDataHeader - int ackLength @unit(B) = default(14B); // maximum 255 byte, minimum 14B for serializing, see CsmaCaMacAckHeader + int headerLength @unit(B) = default(17B); // Maximum 255 byte, minimum 17B for serializing, see CsmaCaMacDataHeader + int ackLength @unit(B) = default(14B); // Maximum 255 byte, minimum 14B for serializing, see CsmaCaMacAckHeader double sifsTime @unit(s) = default(10us); double slotTime @unit(s) = default(20us); double difsTime @unit(s) = default(sifsTime + 2 * slotTime); - double ackTimeout @unit(s) = default(dropUnit(ackLength * 8) / dropUnit(bitrate) * 1s + sifsTime + slotTime); // measured from the end of data transmission; includes sifs, preamble, physical header, mac ack duration, 2x propagation time, by default assumes slot time > preamble + physical header + 2x propagation time + double ackTimeout @unit(s) = default(dropUnit(ackLength * 8) / dropUnit(bitrate) * 1s + sifsTime + slotTime); // Measured from the end of data transmission; includes sifs, preamble, physical header, mac ack duration, 2x propagation time, by default assumes slot time > preamble + physical header + 2x propagation time int mtu = default(1500); - int cwMin = default(31); // minimum contention window - int cwMax = default(1023); // maximum contention window - int cwMulticast = default(cwMin); // multicast contention window - int retryLimit = default(7); // maximum number of retries + int cwMin = default(31); // Minimum contention window + int cwMax = default(1023); // Maximum contention window + int cwMulticast = default(cwMin); // Multicast contention window + int retryLimit = default(7); // Maximum number of retries @class(CsmaCaMac); @signal[linkBroken](type=inet::Packet); @statistic[linkBroken](title="link break"; source=linkBroken; record=count; interpolationmode=none); diff --git a/src/inet/linklayer/ethernet/basic/EthernetCsmaMac.ned b/src/inet/linklayer/ethernet/basic/EthernetCsmaMac.ned index 6448d797443..1ef92cf8369 100644 --- a/src/inet/linklayer/ethernet/basic/EthernetCsmaMac.ned +++ b/src/inet/linklayer/ethernet/basic/EthernetCsmaMac.ned @@ -101,17 +101,17 @@ module EthernetCsmaMac like IEtherMac parameters: string interfaceTableModule; // The path to the InterfaceTable module string displayStringTextFormat = default("rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"); - bool sendRawBytes = default(false); // when true packets are serialized into a sequence of bytes before sending out - bool promiscuous = default(false); // if true, all packets are received, otherwise only the + bool sendRawBytes = default(false); // When true packets are serialized into a sequence of bytes before sending out + bool promiscuous = default(false); // If true, all packets are received, otherwise only the // ones with matching destination MAC address - bool duplexMode; // selects full-duplex (true) or half-duplex (false) operation - bool frameBursting = default(true); // enable/disable frame bursting mode in Gigabit Ethernet - bool allowNonstandardBitrate = default(false); // allows any bitrate and uses first larger bitrate specified parameters + bool duplexMode; // Selects full-duplex (true) or half-duplex (false) operation + bool frameBursting = default(true); // Enable/disable frame bursting mode in Gigabit Ethernet + bool allowNonstandardBitrate = default(false); // Allows any bitrate and uses first larger bitrate specified parameters int mtu @unit(B) = default(1500B); string fcsMode @enum("declared","computed"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @class(EthernetCsmaMac); @display("i=block/rxtx"); @@ -124,9 +124,9 @@ module EthernetCsmaMac like IEtherMac @signal[packetSentToUpper](type=inet::Packet); @signal[packetReceivedFromUpper](type=inet::Packet); @signal[collision](type=long); - @signal[backoffSlotsGenerated](type=long); // slotNumber value emitted - @signal[transmissionStateChanged](type=long); // enum=MacTransmitState - @signal[receptionStateChanged](type=long); // enum=MacReceiveState + @signal[backoffSlotsGenerated](type=long); // SlotNumber value emitted + @signal[transmissionStateChanged](type=long); // Enum=MacTransmitState + @signal[receptionStateChanged](type=long); // Enum=MacReceiveState @signal[transmissionStarted](type=inet::physicallayer::EthernetSignalBase); @signal[transmissionEnded](type=inet::physicallayer::EthernetSignalBase); @signal[receptionStarted](type=inet::physicallayer::EthernetSignalBase); @@ -145,8 +145,8 @@ module EthernetCsmaMac like IEtherMac @statistic[backoffSlotsGenerated](title="backoff"; record=count,vector; interpolationmode=none); gates: - input upperLayerIn @labels(EtherFrame); // to ~EthernetEncapsulation or ~IMacRelayUnit - output upperLayerOut @labels(EtherFrame); // to ~EthernetEncapsulation or ~IMacRelayUnit - inout phys @labels(EthernetSignal); // to the network + input upperLayerIn @labels(EtherFrame); // To ~EthernetEncapsulation or ~IMacRelayUnit + output upperLayerOut @labels(EtherFrame); // To ~EthernetEncapsulation or ~IMacRelayUnit + inout phys @labels(EthernetSignal); // To the network } diff --git a/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned b/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned index a2bcc5e969c..221604f3fcf 100644 --- a/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned +++ b/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned @@ -37,13 +37,13 @@ simple EthernetEncapsulation like IEthernetLayer string interfaceTableModule; // The path to the InterfaceTable module string fcsMode @enum("declared","computed") = default("declared"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @class(EthernetEncapsulation); @display("i=block/layer"); @signal[encapPk](type=cPacket); @signal[decapPk](type=cPacket); - @signal[pauseSent](type=long); // pause units + @signal[pauseSent](type=long); // Pause units @signal[packetDropped](type=inet::Packet); @statistic[encapPk](title="packets encapsulated"; source=encapPk; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); @statistic[decapPk](title="packets decapsulated"; source=decapPk; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); diff --git a/src/inet/linklayer/ethernet/basic/EthernetInterface.ned b/src/inet/linklayer/ethernet/basic/EthernetInterface.ned index 8f28c42bce9..5360ae6b7b6 100644 --- a/src/inet/linklayer/ethernet/basic/EthernetInterface.ned +++ b/src/inet/linklayer/ethernet/basic/EthernetInterface.ned @@ -25,8 +25,8 @@ module EthernetInterface extends NetworkInterface like IEthernetInterface string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or // "auto". "auto" values will be replaced by // a generated MAC address in init stage 0. - bool duplexMode = default(true); // selects full-duplex (true) or half-duplex (false) operation - bool csmacdSupport = default(!duplexMode); // by default CSMA/CD is turned off, so only point-to-point duplex links are supported. + bool duplexMode = default(true); // Selects full-duplex (true) or half-duplex (false) operation + bool csmacdSupport = default(!duplexMode); // By default CSMA/CD is turned off, so only point-to-point duplex links are supported. double bitrate @unit(bps) = default(0 bps); string fcsMode @enum("declared","computed") = default("declared"); *.interfaceTableModule = default(absPath(this.interfaceTableModule)); diff --git a/src/inet/linklayer/ethernet/basic/EthernetMac.ned b/src/inet/linklayer/ethernet/basic/EthernetMac.ned index 8b027844d23..4edca67c370 100644 --- a/src/inet/linklayer/ethernet/basic/EthernetMac.ned +++ b/src/inet/linklayer/ethernet/basic/EthernetMac.ned @@ -108,17 +108,17 @@ module EthernetMac like IEtherMac parameters: string interfaceTableModule; // The path to the InterfaceTable module string displayStringTextFormat = default("rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"); - bool sendRawBytes = default(false); // when true packets are serialized into a sequence of bytes before sending out - bool promiscuous = default(false); // if true, all packets are received, otherwise only the + bool sendRawBytes = default(false); // When true packets are serialized into a sequence of bytes before sending out + bool promiscuous = default(false); // If true, all packets are received, otherwise only the // ones with matching destination MAC address - bool duplexMode; // must be set to "true", as EthernetMac does not support half-duplex operation + bool duplexMode; // Must be set to "true", as EthernetMac does not support half-duplex operation // (parameter is present to reduce the risk of accidental misconfiguration) - bool allowNonstandardBitrate = default(false); // allows any bitrate and uses first larger bitrate specified parameters + bool allowNonstandardBitrate = default(false); // Allows any bitrate and uses first larger bitrate specified parameters int mtu @unit(B) = default(1500B); string fcsMode @enum("declared","computed"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @class(EthernetMac); @display("i=block/rxtx"); @@ -132,8 +132,8 @@ module EthernetMac like IEtherMac @signal[packetReceivedFromLower](type=inet::Packet); @signal[packetSentToUpper](type=inet::Packet); @signal[packetReceivedFromUpper](type=inet::Packet); - @signal[transmissionStateChanged](type=long); // enum=MacTransmitState - @signal[receptionStateChanged](type=long); // enum=MacReceiveState + @signal[transmissionStateChanged](type=long); // Enum=MacTransmitState + @signal[receptionStateChanged](type=long); // Enum=MacReceiveState @signal[transmissionStarted](type=inet::physicallayer::EthernetSignalBase); @signal[transmissionEnded](type=inet::physicallayer::EthernetSignalBase); @signal[receptionEnded](type=inet::physicallayer::Signal); @@ -152,8 +152,8 @@ module EthernetMac like IEtherMac @statistic[packetDropNotAddressedToUs](title="packet drop: not addressed to us"; source=packetDropReasonIsNotAddressedToUs(packetDropped); record=count,sum(packetBytes),vector(packetBytes); interpolationmode=none); gates: - input upperLayerIn @labels(EtherFrame); // to ~EthernetEncapsulation or ~IMacRelayUnit - output upperLayerOut @labels(EtherFrame); // to ~EthernetEncapsulation or ~IMacRelayUnit - inout phys @labels(EthernetSignal); // to the network + input upperLayerIn @labels(EtherFrame); // To ~EthernetEncapsulation or ~IMacRelayUnit + output upperLayerOut @labels(EtherFrame); // To ~EthernetEncapsulation or ~IMacRelayUnit + inout phys @labels(EthernetSignal); // To the network } diff --git a/src/inet/linklayer/ethernet/common/BridgingLayer.ned b/src/inet/linklayer/ethernet/common/BridgingLayer.ned index 4b9fc0f7ff0..03f1c3db242 100644 --- a/src/inet/linklayer/ethernet/common/BridgingLayer.ned +++ b/src/inet/linklayer/ethernet/common/BridgingLayer.ned @@ -18,7 +18,7 @@ module BridgingLayer like IProtocolLayer { parameters: string macTableModule = default(""); - string interfaceTableModule; // relative module path of the interface table + string interfaceTableModule; // Relative module path of the interface table *.macTableModule = default(absPath(this.macTableModule)); *.interfaceTableModule = default(this.interfaceTableModule); @display("i=block/layer"); diff --git a/src/inet/linklayer/ethernet/common/DirectionReverserLayer.ned b/src/inet/linklayer/ethernet/common/DirectionReverserLayer.ned index b7f531a4091..dc4e25a08bb 100644 --- a/src/inet/linklayer/ethernet/common/DirectionReverserLayer.ned +++ b/src/inet/linklayer/ethernet/common/DirectionReverserLayer.ned @@ -21,7 +21,7 @@ import inet.queueing.contract.IPacketFlow; module DirectionReverserLayer like IProtocolLayer { parameters: - string interfaceTableModule; // relative module path of the interface table + string interfaceTableModule; // Relative module path of the interface table *.interfaceTableModule = default(this.interfaceTableModule); @display("i=block/layer"); gates: diff --git a/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned b/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned index 4c4a3d02c9f..b3917f1d05a 100644 --- a/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned +++ b/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned @@ -18,8 +18,8 @@ import inet.queueing.contract.IPacketFlow; simple RelayInterfaceLearner extends PacketFlowBase like IPacketFlow { parameters: - string macTableModule; // relative module path of MAC table - string interfaceTableModule; // relative module path of interface table + string macTableModule; // Relative module path of MAC table + string interfaceTableModule; // Relative module path of interface table @class(RelayInterfaceLearner); @display("i=block/blackboard"); } diff --git a/src/inet/linklayer/ethernet/common/RelayInterfaceSelector.ned b/src/inet/linklayer/ethernet/common/RelayInterfaceSelector.ned index 25f4b078fa2..7ef6ba40833 100644 --- a/src/inet/linklayer/ethernet/common/RelayInterfaceSelector.ned +++ b/src/inet/linklayer/ethernet/common/RelayInterfaceSelector.ned @@ -20,8 +20,8 @@ import inet.queueing.contract.IPacketFlow; simple RelayInterfaceSelector extends PacketPusherBase like IPacketFlow { parameters: - string macTableModule; // relative module path of MAC table - string interfaceTableModule; // relative module path of interface table + string macTableModule; // Relative module path of MAC table + string interfaceTableModule; // Relative module path of interface table @class(RelayInterfaceSelector); @display("i=block/fork"); @signal[packetDropped](type=inet::Packet); diff --git a/src/inet/linklayer/ethernet/modular/EthernetPauseCommandProcessor.ned b/src/inet/linklayer/ethernet/modular/EthernetPauseCommandProcessor.ned index 473c2129ef9..eac9fd91f88 100644 --- a/src/inet/linklayer/ethernet/modular/EthernetPauseCommandProcessor.ned +++ b/src/inet/linklayer/ethernet/modular/EthernetPauseCommandProcessor.ned @@ -12,7 +12,7 @@ simple EthernetPauseCommandProcessor parameters: //@class(EthernetPauseCommandProcessor); @display("i=block/inserter"); - @signal[pauseSent](type=long); // pause units + @signal[pauseSent](type=long); // Pause units @statistic[pauseSent](title="pause sent";record=count,sum,vector); gates: input in @labels(send); diff --git a/src/inet/linklayer/ieee80211/mac/channelaccess/Edca.ned b/src/inet/linklayer/ieee80211/mac/channelaccess/Edca.ned index 014290f0900..d92303399c6 100644 --- a/src/inet/linklayer/ieee80211/mac/channelaccess/Edca.ned +++ b/src/inet/linklayer/ieee80211/mac/channelaccess/Edca.ned @@ -44,7 +44,7 @@ module Edca } mgmtAndNonQoSRecoveryProcedure: NonQosRecoveryProcedure { parameters: - cwCalculatorModule = "^.edcaf[1]"; // best effort + cwCalculatorModule = "^.edcaf[1]"; // Best effort rtsPolicyModule = "^.^.rtsPolicy"; @display("p=400,200"); } diff --git a/src/inet/linklayer/ieee80211/mac/contention/Contention.ned b/src/inet/linklayer/ieee80211/mac/contention/Contention.ned index ff09c1f0691..b9bb37cb525 100644 --- a/src/inet/linklayer/ieee80211/mac/contention/Contention.ned +++ b/src/inet/linklayer/ieee80211/mac/contention/Contention.ned @@ -15,8 +15,8 @@ import inet.linklayer.ieee80211.mac.contract.IContention; simple Contention like IContention { parameters: - bool initialChannelBusy = default(true); // assume that channel was busy before the simulation started - bool backoffOptimization = default(true); // we can pretend the frame has arrived into the queue a little bit earlier, and may be able to start transmitting immediately + bool initialChannelBusy = default(true); // Assume that channel was busy before the simulation started + bool backoffOptimization = default(true); // We can pretend the frame has arrived into the queue a little bit earlier, and may be able to start transmitting immediately @display("i=block/timer"); @signal[backoffPeriodGenerated](type=long); @signal[backoffStarted](type=simtime_t); diff --git a/src/inet/linklayer/ieee80211/mac/rateselection/QosRateSelection.ned b/src/inet/linklayer/ieee80211/mac/rateselection/QosRateSelection.ned index 41635fafb7e..0bb7aae6f81 100644 --- a/src/inet/linklayer/ieee80211/mac/rateselection/QosRateSelection.ned +++ b/src/inet/linklayer/ieee80211/mac/rateselection/QosRateSelection.ned @@ -18,11 +18,11 @@ simple QosRateSelection double responseBlockAckFrameBitrate @unit(bps) = default(-1bps); double responseCtsFrameBitrate @unit(bps) = default(-1bps); - double dataFrameBitrate @unit(bps) = default(-1bps); // fastest - double dataFrameBandwidth @unit(Hz) = default(nan Hz); // unspecified by default - int dataFrameNumSpatialStreams = default(-1); // unspecified by default + double dataFrameBitrate @unit(bps) = default(-1bps); // Fastest + double dataFrameBandwidth @unit(Hz) = default(nan Hz); // Unspecified by default + int dataFrameNumSpatialStreams = default(-1); // Unspecified by default - double mgmtFrameBitrate @unit(bps) = default(-1bps); // fastest + double mgmtFrameBitrate @unit(bps) = default(-1bps); // Fastest double controlFrameBitrate @unit(bps) = default(-1bps); @display("i=block/cogwheel"); } diff --git a/src/inet/linklayer/ieee80211/mac/rateselection/RateSelection.ned b/src/inet/linklayer/ieee80211/mac/rateselection/RateSelection.ned index 967ae953524..224caf66c2f 100644 --- a/src/inet/linklayer/ieee80211/mac/rateselection/RateSelection.ned +++ b/src/inet/linklayer/ieee80211/mac/rateselection/RateSelection.ned @@ -23,11 +23,11 @@ simple RateSelection like IRateSelection double responseAckFrameBitrate @unit(bps) = default(-1bps); double responseCtsFrameBitrate @unit(bps) = default(-1bps); - double dataFrameBitrate @unit(bps) = default(-1bps); // fastest - double dataFrameBandwidth @unit(Hz) = default(nan Hz); // unspecified by default - int dataFrameNumSpatialStreams = default(-1); // unspecified by default + double dataFrameBitrate @unit(bps) = default(-1bps); // Fastest + double dataFrameBandwidth @unit(Hz) = default(nan Hz); // Unspecified by default + int dataFrameNumSpatialStreams = default(-1); // Unspecified by default - double mgmtFrameBitrate @unit(bps) = default(-1bps); // fastest + double mgmtFrameBitrate @unit(bps) = default(-1bps); // Fastest double controlFrameBitrate @unit(bps) = default(-1bps); @display("i=block/cogwheel"); } diff --git a/src/inet/linklayer/ieee80211/mgmt/IIeee80211Mgmt.ned b/src/inet/linklayer/ieee80211/mgmt/IIeee80211Mgmt.ned index 0b4b0c1ac65..97cab465ef4 100644 --- a/src/inet/linklayer/ieee80211/mgmt/IIeee80211Mgmt.ned +++ b/src/inet/linklayer/ieee80211/mgmt/IIeee80211Mgmt.ned @@ -20,7 +20,7 @@ moduleinterface IIeee80211Mgmt gates: input macIn @labels(Ieee80211MacHeader); output macOut @labels(Ieee80211MacHeader); - input agentIn; // optional gates used for the agent in stations - output agentOut; // optional gates used for the agent in stations + input agentIn; // Optional gates used for the agent in stations + output agentOut; // Optional gates used for the agent in stations } diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned index 8b5d4616b98..ee671475830 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned @@ -17,15 +17,15 @@ simple Ieee80211AgentSta like IIeee80211Agent parameters: string interfaceTableModule; // The path to the InterfaceTable module string mibModule; - bool activeScan = default(true); // selects between active and passive scanning - string channelsToScan = default(""); // list of channel numbers to scan (space delimited); empty means all channels - double probeDelay @unit(s) = default(100ms); // delay before sending a probe request during active scanning - double minChannelTime @unit(s) = default(150ms); // min interval to spend on a channel during active scanning - double maxChannelTime @unit(s) = default(300ms); // channel time for passive scanning, and max channel time for active scanning - double authenticationTimeout @unit(s) = default(5s); // timeout for the authentication procedure - double associationTimeout @unit(s) = default(5s); // timeout for the association procedure - double startingTime @unit(s) = default(-1s); // agent starting time. - string defaultSsid = default("SSID"); // default ssid + bool activeScan = default(true); // Selects between active and passive scanning + string channelsToScan = default(""); // List of channel numbers to scan (space delimited); empty means all channels + double probeDelay @unit(s) = default(100ms); // Delay before sending a probe request during active scanning + double minChannelTime @unit(s) = default(150ms); // Min interval to spend on a channel during active scanning + double maxChannelTime @unit(s) = default(300ms); // Channel time for passive scanning, and max channel time for active scanning + double authenticationTimeout @unit(s) = default(5s); // Timeout for the authentication procedure + double associationTimeout @unit(s) = default(5s); // Timeout for the association procedure + double startingTime @unit(s) = default(-1s); // Agent starting time. + string defaultSsid = default("SSID"); // Default ssid @display("i=block/control"); @signal[sentRequest](type=long); // ENUM! ~Ieee80211PrimRequestCode @signal[acceptConfirm](type=long); // ENUM! ~Ieee80211PrimConfirmCode diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAdhoc.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAdhoc.ned index 4c1c98c023f..84055a828ec 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAdhoc.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAdhoc.ned @@ -22,7 +22,7 @@ simple Ieee80211MgmtAdhoc like IIeee80211Mgmt gates: input macIn @labels(Ieee80211MacHeader); output macOut @labels(Ieee80211MacHeader); - input agentIn @loose; // unused dummy to statisfy the IIeee80211Mgmt interface - output agentOut @loose; // unused dummy to statisfy the IIeee80211Mgmt interface + input agentIn @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface } diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned index 29c47ec9ff5..3d58ebe2b0c 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned @@ -23,7 +23,7 @@ simple Ieee80211MgmtAp like IIeee80211Mgmt parameters: string ssid = default("SSID"); double beaconInterval @unit(s) = default(100ms); - int numAuthSteps = default(4); // use 2 for Open System auth, 4 for WEP + int numAuthSteps = default(4); // Use 2 for Open System auth, 4 for WEP string interfaceTableModule; string radioModule = default("^.radio"); // The path to the Radio module //FIXME remove default value string mibModule; @@ -32,9 +32,9 @@ simple Ieee80211MgmtAp like IIeee80211Mgmt @signal[l2ApAssociated](type="inet::ieee80211::Ieee80211MgmtAp::NotificationInfoSta"); @signal[l2ApDisassociated](type="inet::ieee80211::Ieee80211MgmtAp::NotificationInfoSta"); gates: - input macIn @labels(Ieee80211MacHeader); // from ~Ieee80211Mac - output macOut @labels(Ieee80211MacHeader); // to ~Ieee80211Mac - input agentIn @loose; // unused dummy to statisfy the IIeee80211Mgmt interface - output agentOut @loose; // unused dummy to statisfy the IIeee80211Mgmt interface + input macIn @labels(Ieee80211MacHeader); // From ~Ieee80211Mac + output macOut @labels(Ieee80211MacHeader); // To ~Ieee80211Mac + input agentIn @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface } diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned index efeb4e1d08c..7fee9ebcc92 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned @@ -22,9 +22,9 @@ simple Ieee80211MgmtApSimplified like IIeee80211Mgmt string ssid = default("SSID"); @display("i=block/cogwheel"); gates: - input macIn @labels(Ieee80211MacHeader); // from ~Ieee80211Mac - output macOut @labels(Ieee80211MacHeader); // to ~Ieee80211Mac - input agentIn @loose; // unused dummy to statisfy the IIeee80211Mgmt interface - output agentOut @loose; // unused dummy to statisfy the IIeee80211Mgmt interface + input macIn @labels(Ieee80211MacHeader); // From ~Ieee80211Mac + output macOut @labels(Ieee80211MacHeader); // To ~Ieee80211Mac + input agentIn @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface } diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtSta.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtSta.ned index a6eae1ec974..22af91dc733 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtSta.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtSta.ned @@ -26,7 +26,7 @@ simple Ieee80211MgmtSta like IIeee80211Mgmt { parameters: string interfaceTableModule; // The path to the InterfaceTable module - int numChannels = default(1); // number of channels to scan + int numChannels = default(1); // Number of channels to scan string mibModule; string macModule; // The path to the MAC module @display("i=block/cogwheel"); @@ -35,7 +35,7 @@ simple Ieee80211MgmtSta like IIeee80211Mgmt gates: input macIn @labels(Ieee80211MacHeader); output macOut @labels(Ieee80211MacHeader); - input agentIn; // used for attaching an agent algorithm - output agentOut; // used for attaching an agent algorithm + input agentIn; // Used for attaching an agent algorithm + output agentOut; // Used for attaching an agent algorithm } diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned index a474fe05eea..03e9d0fd710 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned @@ -25,7 +25,7 @@ simple Ieee80211MgmtStaSimplified like IIeee80211Mgmt gates: input macIn @labels(Ieee80211MacHeader); output macOut @labels(Ieee80211MacHeader); - input agentIn @loose; // unused dummy to statisfy the IIeee80211Mgmt interface - output agentOut @loose; // unused dummy to statisfy the IIeee80211Mgmt interface + input agentIn @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to statisfy the IIeee80211Mgmt interface } diff --git a/src/inet/linklayer/ieee8021as/Gptp.ned b/src/inet/linklayer/ieee8021as/Gptp.ned index 8349c5e9723..a55e862ed00 100644 --- a/src/inet/linklayer/ieee8021as/Gptp.ned +++ b/src/inet/linklayer/ieee8021as/Gptp.ned @@ -19,26 +19,26 @@ import inet.linklayer.contract.IGptp; simple Gptp like IGptp { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - string interfaceTableModule; // relative path of the interface table module + string clockModule = default(""); // Relative path of a module that implements IClock; optional + string interfaceTableModule; // Relative path of the interface table module string gptpNodeType; // @enum("GptpNodeType"): MASTER_NODE, BRIDGE_NODE, SLAVE_NODE - int domainNumber = default(0); // specifies the time domain number used in gPTP messages - string slavePort = default(""); // port for receiving time (empty for MASTER_NODE) - object masterPorts = default([]); // ports for sending out time (empty for SLAVE_NODE) - double correctionField @unit(s) = default(0s); // time correction for link delay measurements - double syncInterval @unit(s) = default(0.125s); // time interval between SYNC messages - double pdelayInterval @unit(s) = default(1s); // frequency of link delay measurements - double syncInitialOffset @unit(s) = default(syncInterval); // time of first SYNC message - double pdelayInitialOffset @unit(s) = default(0s); // time of first link delay measurement + int domainNumber = default(0); // Specifies the time domain number used in gPTP messages + string slavePort = default(""); // Port for receiving time (empty for MASTER_NODE) + object masterPorts = default([]); // Ports for sending out time (empty for SLAVE_NODE) + double correctionField @unit(s) = default(0s); // Time correction for link delay measurements + double syncInterval @unit(s) = default(0.125s); // Time interval between SYNC messages + double pdelayInterval @unit(s) = default(1s); // Frequency of link delay measurements + double syncInitialOffset @unit(s) = default(syncInterval); // Time of first SYNC message + double pdelayInitialOffset @unit(s) = default(0s); // Time of first link delay measurement // following parameters are used to schedule follow_up and pdelay_resp messages. // These numbers must be enough large to prevent creating queue in MAC layer. // It means it should be large than transmission time of message sent before - double pDelayReqProcessingTime @unit(s) = default(8us); // processing time between arrived PDelayReq and send of PDelayResp + double pDelayReqProcessingTime @unit(s) = default(8us); // Processing time between arrived PDelayReq and send of PDelayResp double followUpInterval @unit(s) = default(7us); @display("i=block/timer"); - @signal[localTime](type=simtime_t); // as clocktime_t + @signal[localTime](type=simtime_t); // As clocktime_t @signal[timeDifference](type=simtime_t); @signal[rateRatio](type=double); @signal[peerDelay](type=simtime_t); diff --git a/src/inet/linklayer/ieee8021as/GptpMaster.ned b/src/inet/linklayer/ieee8021as/GptpMaster.ned index 1b401c43615..bb0f75ca79a 100644 --- a/src/inet/linklayer/ieee8021as/GptpMaster.ned +++ b/src/inet/linklayer/ieee8021as/GptpMaster.ned @@ -14,7 +14,7 @@ module GptpMaster extends GptpEndstation { parameters: @display("i=device/pc2"); - forwarding = default(false); // disable routing by default + forwarding = default(false); // Disable routing by default networkLayer.proxyARP = default(false); gptp.gptpNodeType = "MASTER_NODE"; // @enum("gptpNodeType"): MASTER_NODE, BRIDGE_NODE, SLAVE_NODE connections allowunconnected: diff --git a/src/inet/linklayer/ieee8021as/GptpSlave.ned b/src/inet/linklayer/ieee8021as/GptpSlave.ned index 0fad97aec7e..9e0b0a5e3f9 100644 --- a/src/inet/linklayer/ieee8021as/GptpSlave.ned +++ b/src/inet/linklayer/ieee8021as/GptpSlave.ned @@ -14,7 +14,7 @@ module GptpSlave extends GptpEndstation { parameters: @display("i=device/pc2"); - forwarding = default(false); // disable routing by default + forwarding = default(false); // Disable routing by default networkLayer.proxyARP = default(false); gptp.gptpNodeType = "SLAVE_NODE"; // @enum("gptpNodeType"): MASTER_NODE, BRIDGE_NODE, SLAVE_NODE connections allowunconnected: diff --git a/src/inet/linklayer/ieee8021as/MultiDomainGptp.ned b/src/inet/linklayer/ieee8021as/MultiDomainGptp.ned index e25cb603267..84a9ec917b4 100644 --- a/src/inet/linklayer/ieee8021as/MultiDomainGptp.ned +++ b/src/inet/linklayer/ieee8021as/MultiDomainGptp.ned @@ -22,9 +22,9 @@ import inet.queueing.common.PacketMultiplexer; module MultiDomainGptp like IGptp { parameters: - string clockModule; // relative module path of the multi clock - string interfaceTableModule; // relative module path of the interface table - int numDomains; // number of time synchronization domains + string clockModule; // Relative module path of the multi clock + string interfaceTableModule; // Relative module path of the interface table + int numDomains; // Number of time synchronization domains string gptpNodeType; // @enum("GptpNodeType"): MASTER_NODE, BRIDGE_NODE, SLAVE_NODE @display("i=block/app"); gates: diff --git a/src/inet/linklayer/ieee8021q/DualIeee8021qFilter.ned b/src/inet/linklayer/ieee8021q/DualIeee8021qFilter.ned index ae92ca15f79..254e0fd9e74 100644 --- a/src/inet/linklayer/ieee8021q/DualIeee8021qFilter.ned +++ b/src/inet/linklayer/ieee8021q/DualIeee8021qFilter.ned @@ -24,9 +24,9 @@ import inet.queueing.contract.IPacketMeter; module DualIeee8021qFilter like IPacketFilter { parameters: - int numStreams = default(0); // number of streams - bool hasDefaultPath = default(true); // specifies if the non-filtered direct path should exist - int startY = default(hasDefaultPath ? 200 : 100); // used for submodule layout + int numStreams = default(0); // Number of streams + bool hasDefaultPath = default(true); // Specifies if the non-filtered direct path should exist + int startY = default(hasDefaultPath ? 200 : 100); // Used for submodule layout @display("i=block/filter"); gates: input in; diff --git a/src/inet/linklayer/ieee8021q/Ieee8021qCreditBasedGate.ned b/src/inet/linklayer/ieee8021q/Ieee8021qCreditBasedGate.ned index e96f883e97c..6ef319f5d85 100644 --- a/src/inet/linklayer/ieee8021q/Ieee8021qCreditBasedGate.ned +++ b/src/inet/linklayer/ieee8021q/Ieee8021qCreditBasedGate.ned @@ -16,8 +16,8 @@ import inet.queueing.gate.CreditBasedGate; simple Ieee8021qCreditBasedGate extends CreditBasedGate { parameters: - double idleSlope @unit(bps); // data rate of the accumulated credits when the transmission channel is idle - double sendSlope @unit(bps) = default(idleSlope - bitrate); // data rate of the spent credits when the transmission channel is in use + double idleSlope @unit(bps); // Data rate of the accumulated credits when the transmission channel is idle + double sendSlope @unit(bps) = default(idleSlope - bitrate); // Data rate of the spent credits when the transmission channel is in use double maxInterferenceSize @unit(b) = default(inf b); idleCreditGainRate = default(dropUnit(idleSlope)); transmitCreditSpendRate = default(-dropUnit(sendSlope)); diff --git a/src/inet/linklayer/ieee8021q/Ieee8021qFilter.ned b/src/inet/linklayer/ieee8021q/Ieee8021qFilter.ned index 5ceefbba053..f99c2302056 100644 --- a/src/inet/linklayer/ieee8021q/Ieee8021qFilter.ned +++ b/src/inet/linklayer/ieee8021q/Ieee8021qFilter.ned @@ -28,10 +28,10 @@ import inet.queueing.contract.IPacketMeter; module Ieee8021qFilter like IPacketFilter { parameters: - int numStreams; // number of different streams to filter for - int numGates; // number of gates - int numMeters; // number of traffic meters - object streamFilterTable; // an array of objects where each object contains a stream name, gate index and meter index, for example: [{stream: "s0", gate: 0, meter: 0}, ...] + int numStreams; // Number of different streams to filter for + int numGates; // Number of gates + int numMeters; // Number of traffic meters + object streamFilterTable; // An array of objects where each object contains a stream name, gate index and meter index, for example: [{stream: "s0", gate: 0, meter: 0}, ...] @display("i=block/filter"); gates: input in; diff --git a/src/inet/linklayer/ieee8021q/Ieee8021qTimeAwareShaper.ned b/src/inet/linklayer/ieee8021q/Ieee8021qTimeAwareShaper.ned index 049e1944078..9657b972f41 100644 --- a/src/inet/linklayer/ieee8021q/Ieee8021qTimeAwareShaper.ned +++ b/src/inet/linklayer/ieee8021q/Ieee8021qTimeAwareShaper.ned @@ -21,11 +21,11 @@ import inet.queueing.queue.CompoundPacketQueueBase; module Ieee8021qTimeAwareShaper extends CompoundPacketQueueBase { parameters: - int numTrafficClasses = default(8); // number of traffic categories + int numTrafficClasses = default(8); // Number of traffic categories double bitrate @unit(bps); bool hasGcl = default(false); *.bitrate = default(this.bitrate); - *.extraLength = default(64b); // overhead for Ethernet PHY header + *.extraLength = default(64b); // Overhead for Ethernet PHY header submodules: buffer: like IPacketBuffer if typename != "" { parameters: diff --git a/src/inet/linklayer/ieee8021q/PcpClassifier.ned b/src/inet/linklayer/ieee8021q/PcpClassifier.ned index 656ea32b790..7c53934593a 100644 --- a/src/inet/linklayer/ieee8021q/PcpClassifier.ned +++ b/src/inet/linklayer/ieee8021q/PcpClassifier.ned @@ -19,7 +19,7 @@ simple PcpClassifier extends PacketClassifierBase like IPacketClassifier { parameters: string mode @enum("req", "ind", "both") = default("both"); - object pcpToGateIndex; // specifies the gate index for all PCP values in ascending order - int defaultGateIndex = default(0); // default gate index if no PCP found + object pcpToGateIndex; // Specifies the gate index for all PCP values in ascending order + int defaultGateIndex = default(0); // Default gate index if no PCP found @class(PcpClassifier); } diff --git a/src/inet/linklayer/ieee8021q/PcpTrafficClassClassifier.ned b/src/inet/linklayer/ieee8021q/PcpTrafficClassClassifier.ned index fdafddafc67..05cb813ce9d 100644 --- a/src/inet/linklayer/ieee8021q/PcpTrafficClassClassifier.ned +++ b/src/inet/linklayer/ieee8021q/PcpTrafficClassClassifier.ned @@ -31,6 +31,6 @@ module PcpTrafficClassClassifier extends PacketClassifierBase like IPacketClassi [0, 1, 1, 2, 2, 3, 4, 5], // VO voice [0, 1, 2, 3, 3, 4, 5, 6], // IC internetwork control [0, 1, 2, 3, 4, 5, 6, 7]]); // NC network control - int defaultGateIndex = default(0); // default gate index if no PCP found + int defaultGateIndex = default(0); // Default gate index if no PCP found @class(PcpTrafficClassClassifier); } diff --git a/src/inet/linklayer/ieee8021q/SimpleIeee8021qFilter.ned b/src/inet/linklayer/ieee8021q/SimpleIeee8021qFilter.ned index 744c64dd5d2..d6aa4850f8f 100644 --- a/src/inet/linklayer/ieee8021q/SimpleIeee8021qFilter.ned +++ b/src/inet/linklayer/ieee8021q/SimpleIeee8021qFilter.ned @@ -22,8 +22,8 @@ import inet.queueing.contract.IPacketMeter; module SimpleIeee8021qFilter like IPacketFilter { parameters: - int numStreams = default(0); // number of different streams to filter for - bool hasDefaultPath = default(true); // specifies if the non-filtered direct path should exist + int numStreams = default(0); // Number of different streams to filter for + bool hasDefaultPath = default(true); // Specifies if the non-filtered direct path should exist int startY = default(hasDefaultPath ? 200 : 100); @display("i=block/filter"); gates: diff --git a/src/inet/linklayer/ppp/Ppp.ned b/src/inet/linklayer/ppp/Ppp.ned index 9dbfeb9d2d2..46d64bb560b 100644 --- a/src/inet/linklayer/ppp/Ppp.ned +++ b/src/inet/linklayer/ppp/Ppp.ned @@ -36,11 +36,11 @@ simple Ppp parameters: string interfaceTableModule; // The path to the InterfaceTable module string displayStringTextFormat = default("rate: %b\nsent: %s, rcvd: %r\nqueue: %q, drop: %d"); - bool sendRawBytes = default(false); // when true packets are serialized into a sequence of bytes before sending out + bool sendRawBytes = default(false); // When true packets are serialized into a sequence of bytes before sending out int mtu @unit(B) = default(4470B); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @class(Ppp); @display("i=block/rxtx"); diff --git a/src/inet/linklayer/shortcut/ShortcutMac.ned b/src/inet/linklayer/shortcut/ShortcutMac.ned index 336850c2325..daf02859328 100644 --- a/src/inet/linklayer/shortcut/ShortcutMac.ned +++ b/src/inet/linklayer/shortcut/ShortcutMac.ned @@ -27,10 +27,10 @@ simple ShortcutMac extends MacProtocolBase like ILinkLayer, IMacProtocol // a generated MAC address in init stage 0. double bitrate @unit(bps); int mtu @unit(B) = default(1500B); - volatile int lengthOverhead @unit(b) = default(0b); // extra length added to packets - volatile double durationOverhead @unit(s) = default(0s); // extra transmission duration added to packets - volatile double propagationDelay @unit(s) = default(0s); // propagation time to all destinations - volatile double packetLoss = default(0); // packet loss probability + volatile int lengthOverhead @unit(b) = default(0b); // Extra length added to packets + volatile double durationOverhead @unit(s) = default(0s); // Extra transmission duration added to packets + volatile double propagationDelay @unit(s) = default(0s); // Propagation time to all destinations + volatile double packetLoss = default(0); // Packet loss probability @class(ShortcutMac); @display("i=block/rxtx"); gates: diff --git a/src/inet/linklayer/tun/Tun.ned b/src/inet/linklayer/tun/Tun.ned index cf03a7eede4..1cca0d0d4f1 100644 --- a/src/inet/linklayer/tun/Tun.ned +++ b/src/inet/linklayer/tun/Tun.ned @@ -20,7 +20,7 @@ simple Tun @signal[packetReceivedFromUpper](type=cPacket); gates: - input upperLayerIn @messageKinds(inet::TunCommandCode); // from upper layers - output upperLayerOut @messageKinds(inet::TunSocketIndication); // to upper layers + input upperLayerIn @messageKinds(inet::TunCommandCode); // From upper layers + output upperLayerOut @messageKinds(inet::TunSocketIndication); // To upper layers } diff --git a/src/inet/linklayer/vlan/VlanIndFilter.ned b/src/inet/linklayer/vlan/VlanIndFilter.ned index 70652491f5d..07923f215e5 100644 --- a/src/inet/linklayer/vlan/VlanIndFilter.ned +++ b/src/inet/linklayer/vlan/VlanIndFilter.ned @@ -17,7 +17,7 @@ simple VlanIndFilter extends PacketFilterBase like IPacketFilter { parameters: string interfaceTableModule; - object acceptedVlanIds = default({}); // maps network interface name to a list of accepted VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present + object acceptedVlanIds = default({}); // Maps network interface name to a list of accepted VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present @class(VlanIndFilter); @display("i=block/filter"); } diff --git a/src/inet/linklayer/vlan/VlanReqFilter.ned b/src/inet/linklayer/vlan/VlanReqFilter.ned index 1e273dcb847..d388b6bc14a 100644 --- a/src/inet/linklayer/vlan/VlanReqFilter.ned +++ b/src/inet/linklayer/vlan/VlanReqFilter.ned @@ -17,7 +17,7 @@ simple VlanReqFilter extends PacketFilterBase like IPacketFilter { parameters: string interfaceTableModule; - object acceptedVlanIds = default({}); // maps network interface name to a list of accepted VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present + object acceptedVlanIds = default({}); // Maps network interface name to a list of accepted VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present @class(VlanReqFilter); @display("i=block/filter"); } diff --git a/src/inet/linklayer/vlan/VlanReqMapper.ned b/src/inet/linklayer/vlan/VlanReqMapper.ned index fa80f73491e..11f84b584c3 100644 --- a/src/inet/linklayer/vlan/VlanReqMapper.ned +++ b/src/inet/linklayer/vlan/VlanReqMapper.ned @@ -18,7 +18,7 @@ simple VlanReqMapper extends PacketFlowBase like IPacketFlow parameters: string interfaceTableModule; string protocol = default("ieee8021qctag"); - object mappedVlanIds = default({}); // maps network interface name to another map which maps accepted VLAN ids to replacement VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present + object mappedVlanIds = default({}); // Maps network interface name to another map which maps accepted VLAN ids to replacement VLAN ids, '*' as interface name matches all interfaces, -1 VLAN id matches if no tag is present @class(VlanReqMapper); @display("i=block/switch"); } diff --git a/src/inet/mobility/base/MobilityBase.ned b/src/inet/mobility/base/MobilityBase.ned index f2608f3cae7..330bf0da846 100644 --- a/src/inet/mobility/base/MobilityBase.ned +++ b/src/inet/mobility/base/MobilityBase.ned @@ -25,17 +25,17 @@ import inet.mobility.contract.IMobility; simple MobilityBase like IMobility { parameters: - @signal[mobilityStateChanged](type=inet::MobilityBase); // it's work in inet, but not work in extended module in other namespace + @signal[mobilityStateChanged](type=inet::MobilityBase); // It's work in inet, but not work in extended module in other namespace @display("i=block/cogwheel"); - string subjectModule = default("^"); // module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module - string coordinateSystemModule = default(""); // module path of the geographic coordinate system module - string displayStringTextFormat @mutable = default("p: %p\nv: %v"); // format string for the mobility module's display string text - bool updateDisplayString = default(true); // enables continuous update of the subject module's position via modifying its display string - double constraintAreaMinX @unit(m) = default(-inf m); // min x position of the constraint area, unconstrained by default (negative infinity) - double constraintAreaMinY @unit(m) = default(-inf m); // min y position of the constraint area, unconstrained by default (negative infinity) - double constraintAreaMinZ @unit(m) = default(-inf m); // min z position of the constraint area, unconstrained by default (negative infinity) - double constraintAreaMaxX @unit(m) = default(inf m); // max x position of the constraint area, unconstrained by default (positive infinity) - double constraintAreaMaxY @unit(m) = default(inf m); // max y position of the constraint area, unconstrained by default (positive infinity) - double constraintAreaMaxZ @unit(m) = default(inf m); // max z position of the constraint area, unconstrained by default (positive infinity) + string subjectModule = default("^"); // Module path which determines the subject module, the motion of which this mobility model describes, the default value is the parent module + string coordinateSystemModule = default(""); // Module path of the geographic coordinate system module + string displayStringTextFormat @mutable = default("p: %p\nv: %v"); // Format string for the mobility module's display string text + bool updateDisplayString = default(true); // Enables continuous update of the subject module's position via modifying its display string + double constraintAreaMinX @unit(m) = default(-inf m); // Min x position of the constraint area, unconstrained by default (negative infinity) + double constraintAreaMinY @unit(m) = default(-inf m); // Min y position of the constraint area, unconstrained by default (negative infinity) + double constraintAreaMinZ @unit(m) = default(-inf m); // Min z position of the constraint area, unconstrained by default (negative infinity) + double constraintAreaMaxX @unit(m) = default(inf m); // Max x position of the constraint area, unconstrained by default (positive infinity) + double constraintAreaMaxY @unit(m) = default(inf m); // Max y position of the constraint area, unconstrained by default (positive infinity) + double constraintAreaMaxZ @unit(m) = default(inf m); // Max z position of the constraint area, unconstrained by default (positive infinity) } diff --git a/src/inet/mobility/base/MovingMobilityBase.ned b/src/inet/mobility/base/MovingMobilityBase.ned index 993b039fbe5..ab2b8fd9374 100644 --- a/src/inet/mobility/base/MovingMobilityBase.ned +++ b/src/inet/mobility/base/MovingMobilityBase.ned @@ -13,7 +13,7 @@ package inet.mobility.base; simple MovingMobilityBase extends MobilityBase { parameters: - double updateInterval @unit(s) = default(0.1s); // the simulation time interval used to regularly signal mobility state changes and update the display + double updateInterval @unit(s) = default(0.1s); // The simulation time interval used to regularly signal mobility state changes and update the display bool faceForward = default(true); } diff --git a/src/inet/mobility/single/AnsimMobility.ned b/src/inet/mobility/single/AnsimMobility.ned index 11711396aa6..e2feb420d87 100644 --- a/src/inet/mobility/single/AnsimMobility.ned +++ b/src/inet/mobility/single/AnsimMobility.ned @@ -16,7 +16,7 @@ import inet.mobility.base.MovingMobilityBase; simple AnsimMobility extends MovingMobilityBase { parameters: - xml ansimTrace; // the ANSim trace file in XML + xml ansimTrace; // The ANSim trace file in XML int nodeId; // elements to match; -1 gets substituted to parent module's index @class(AnsimMobility); } diff --git a/src/inet/mobility/single/BonnMotionMobility.ned b/src/inet/mobility/single/BonnMotionMobility.ned index 9feca613eec..6a5de3e5a27 100644 --- a/src/inet/mobility/single/BonnMotionMobility.ned +++ b/src/inet/mobility/single/BonnMotionMobility.ned @@ -28,9 +28,9 @@ import inet.mobility.base.MovingMobilityBase; simple BonnMotionMobility extends MovingMobilityBase { parameters: - bool is3D = default(false); // whether the trace file contains triplets or quadruples - string traceFile; // the BonnMotion trace file - int nodeId; // selects line in trace file; -1 gets substituted to parent module's index + bool is3D = default(false); // Whether the trace file contains triplets or quadruples + string traceFile; // The BonnMotion trace file + int nodeId; // Selects line in trace file; -1 gets substituted to parent module's index @class(BonnMotionMobility); } diff --git a/src/inet/mobility/single/CircleMobility.ned b/src/inet/mobility/single/CircleMobility.ned index 25f931ec783..7e9fa79e609 100644 --- a/src/inet/mobility/single/CircleMobility.ned +++ b/src/inet/mobility/single/CircleMobility.ned @@ -15,12 +15,12 @@ import inet.mobility.base.MovingMobilityBase; simple CircleMobility extends MovingMobilityBase { parameters: - double cx @unit(m); // x coord of the center of the circle - double cy @unit(m); // y coord of the center of the circle - double cz @unit(m) = default(0m); // z coord of the center of the circle - double r @unit(m); // radius of the circle - double speed @unit(mps) = default(0mps); // speed of the host - double startAngle @unit(deg) = default(uniform(0deg, 360deg)); // starting angle + double cx @unit(m); // X coord of the center of the circle + double cy @unit(m); // Y coord of the center of the circle + double cz @unit(m) = default(0m); // Z coord of the center of the circle + double r @unit(m); // Radius of the circle + double speed @unit(mps) = default(0mps); // Speed of the host + double startAngle @unit(deg) = default(uniform(0deg, 360deg)); // Starting angle @class(CircleMobility); } diff --git a/src/inet/mobility/single/FacingMobility.ned b/src/inet/mobility/single/FacingMobility.ned index d561d0b82bb..9abb1cbd1e5 100644 --- a/src/inet/mobility/single/FacingMobility.ned +++ b/src/inet/mobility/single/FacingMobility.ned @@ -19,8 +19,8 @@ simple FacingMobility extends MobilityBase double initialX @unit(m) = default(uniform(this.constraintAreaMinX, this.constraintAreaMaxX)); double initialY @unit(m) = default(uniform(this.constraintAreaMinY, this.constraintAreaMaxY)); double initialZ @unit(m) = default(nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))); - bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string - string sourceMobility = default("."); // the default source mobility is this + bool initFromDisplayString = default(true); // Enables one time initialization from the subject module's display string + string sourceMobility = default("."); // The default source mobility is this string targetMobility @mutable; @class(FacingMobility); } diff --git a/src/inet/mobility/single/GaussMarkovMobility.ned b/src/inet/mobility/single/GaussMarkovMobility.ned index a3ea7aed329..4ae74230fa3 100644 --- a/src/inet/mobility/single/GaussMarkovMobility.ned +++ b/src/inet/mobility/single/GaussMarkovMobility.ned @@ -28,9 +28,9 @@ simple GaussMarkovMobility extends MovingMobilityBase @class(GaussMarkovMobility); double alpha = default(0.5); // [0;1], 0 - brown motion, 1 - linear motion double speed @unit(mps); - double speedStdDev @unit(mps); // speed standard deviation + double speedStdDev @unit(mps); // Speed standard deviation double angle @unit(deg) = default(uniform(0deg, 360deg)); - double angleStdDev @unit(deg); // angle standard deviation + double angleStdDev @unit(deg); // Angle standard deviation double margin @unit(m); } diff --git a/src/inet/mobility/single/LinearMobility.ned b/src/inet/mobility/single/LinearMobility.ned index 99440978b9a..2d0d02778d2 100644 --- a/src/inet/mobility/single/LinearMobility.ned +++ b/src/inet/mobility/single/LinearMobility.ned @@ -24,8 +24,8 @@ simple LinearMobility extends MovingMobilityBase double initialX @unit(m) = default(uniform(this.constraintAreaMinX, this.constraintAreaMaxX)); double initialY @unit(m) = default(uniform(this.constraintAreaMinY, this.constraintAreaMaxY)); double initialZ @unit(m) = default(nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))); - bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string - double speed @unit(mps) = default(0mps); // speed of the host + bool initFromDisplayString = default(true); // Enables one time initialization from the subject module's display string + double speed @unit(mps) = default(0mps); // Speed of the host double initialMovementHeading @unit(deg) = default(uniform(0deg, 360deg)); double initialMovementElevation @unit(deg) = default(0deg); @class(LinearMobility); diff --git a/src/inet/mobility/single/MassMobility.ned b/src/inet/mobility/single/MassMobility.ned index 321726c872f..0ff095541e7 100644 --- a/src/inet/mobility/single/MassMobility.ned +++ b/src/inet/mobility/single/MassMobility.ned @@ -48,13 +48,13 @@ simple MassMobility extends MovingMobilityBase double initialX @unit(m) = default(uniform(constraintAreaMinX, constraintAreaMaxX)); double initialY @unit(m) = default(uniform(constraintAreaMinY, constraintAreaMaxY)); double initialZ @unit(m) = default(nanToZero(uniform(constraintAreaMinZ, constraintAreaMaxZ))); - double initialMovementHeading @unit(deg) = default(uniform(0deg, 360deg)); // initial heading - double initialMovementElevation @unit(deg) = default(0deg); // initial elevation - bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string - volatile double changeInterval @unit(s); // frequency of changing speed and angle (can be random) - volatile double angleDelta @unit(deg); // rotate velocity vector by this much around the rotation axis defined by the rotationAxisAngle parameter (can be random) - volatile double rotationAxisAngle @unit(deg) = default(0deg); // defines a vector in the plane perpendicular to the velocity, where 0 deg means the Z axis when bank is zero (can be random) - volatile double speed @mutable @unit(mps); // speed (can be random, updated every changeInterval) + double initialMovementHeading @unit(deg) = default(uniform(0deg, 360deg)); // Initial heading + double initialMovementElevation @unit(deg) = default(0deg); // Initial elevation + bool initFromDisplayString = default(true); // Enables one time initialization from the subject module's display string + volatile double changeInterval @unit(s); // Frequency of changing speed and angle (can be random) + volatile double angleDelta @unit(deg); // Rotate velocity vector by this much around the rotation axis defined by the rotationAxisAngle parameter (can be random) + volatile double rotationAxisAngle @unit(deg) = default(0deg); // Defines a vector in the plane perpendicular to the velocity, where 0 deg means the Z axis when bank is zero (can be random) + volatile double speed @mutable @unit(mps); // Speed (can be random, updated every changeInterval) @class(MassMobility); } diff --git a/src/inet/mobility/single/Ns2MotionMobility.ned b/src/inet/mobility/single/Ns2MotionMobility.ned index 6db81b208dd..f44014f413f 100644 --- a/src/inet/mobility/single/Ns2MotionMobility.ned +++ b/src/inet/mobility/single/Ns2MotionMobility.ned @@ -12,8 +12,8 @@ import inet.mobility.base.MovingMobilityBase; simple Ns2MotionMobility extends MovingMobilityBase { parameters: - string traceFile; // the BonnMotion trace file - int nodeId; // selects line in trace file; -1 gets substituted to parent module's index + string traceFile; // The BonnMotion trace file + int nodeId; // Selects line in trace file; -1 gets substituted to parent module's index double scrollX @unit(m) = default(0m); double scrollY @unit(m) = default(0m); @class(Ns2MotionMobility); diff --git a/src/inet/mobility/single/RandomWaypointMobility.ned b/src/inet/mobility/single/RandomWaypointMobility.ned index 24702c5041f..19aaad36af0 100644 --- a/src/inet/mobility/single/RandomWaypointMobility.ned +++ b/src/inet/mobility/single/RandomWaypointMobility.ned @@ -34,9 +34,9 @@ simple RandomWaypointMobility extends MovingMobilityBase double initialX @unit(m) = default(uniform(this.constraintAreaMinX, this.constraintAreaMaxX)); double initialY @unit(m) = default(uniform(this.constraintAreaMinY, this.constraintAreaMaxY)); double initialZ @unit(m) = default(nanToZero(uniform(this.constraintAreaMinZ, this.constraintAreaMaxZ))); - bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string - volatile double speed @unit(mps) = default(mps); // use uniform(minSpeed, maxSpeed) or another distribution - volatile double waitTime @unit(s) = default(0s); // wait time between reaching a target and choosing a new one + bool initFromDisplayString = default(true); // Enables one time initialization from the subject module's display string + volatile double speed @unit(mps) = default(mps); // Use uniform(minSpeed, maxSpeed) or another distribution + volatile double waitTime @unit(s) = default(0s); // Wait time between reaching a target and choosing a new one @class(RandomWaypointMobility); } diff --git a/src/inet/mobility/single/RectangleMobility.ned b/src/inet/mobility/single/RectangleMobility.ned index 2ea42ba2d93..3292acb7a92 100644 --- a/src/inet/mobility/single/RectangleMobility.ned +++ b/src/inet/mobility/single/RectangleMobility.ned @@ -15,8 +15,8 @@ import inet.mobility.base.MovingMobilityBase; simple RectangleMobility extends MovingMobilityBase { parameters: - double startPos; // in range [0.0,4.0): topleft=0, topright=1, bottomright=2, bottomleft=3 - double speed @unit(mps); // speed of the host + double startPos; // In range [0.0,4.0): topleft=0, topright=1, bottomright=2, bottomleft=3 + double speed @unit(mps); // Speed of the host @class(RectangleMobility); } diff --git a/src/inet/mobility/single/SuperpositioningMobility.ned b/src/inet/mobility/single/SuperpositioningMobility.ned index 6f619da236d..5562c18b291 100644 --- a/src/inet/mobility/single/SuperpositioningMobility.ned +++ b/src/inet/mobility/single/SuperpositioningMobility.ned @@ -24,10 +24,10 @@ import inet.mobility.contract.IMobility; module SuperpositioningMobility extends MobilityBase { parameters: - int numElements; // number of combined mobility modules + int numElements; // Number of combined mobility modules string positionComposition @enum("zero", "sum", "average") = default("sum"); string orientationComposition @enum("zero", "sum", "average", "faceForward") = default("sum"); - element[*].subjectModule = default(""); // disable visual subject module of superposition elements by default + element[*].subjectModule = default(""); // Disable visual subject module of superposition elements by default @class(SuperpositioningMobility); submodules: element[numElements]: <> like IMobility { diff --git a/src/inet/mobility/single/TractorMobility.ned b/src/inet/mobility/single/TractorMobility.ned index c66fe8ed64a..07a7bc6178b 100644 --- a/src/inet/mobility/single/TractorMobility.ned +++ b/src/inet/mobility/single/TractorMobility.ned @@ -36,7 +36,7 @@ simple TractorMobility extends MovingMobilityBase double y1 @unit(m); double x2 @unit(m); double y2 @unit(m); - int rowCount; // the number of rows on the field + int rowCount; // The number of rows on the field @class(TractorMobility); } diff --git a/src/inet/mobility/single/TurtleMobility.ned b/src/inet/mobility/single/TurtleMobility.ned index 2d0f2de2132..8c60716596a 100644 --- a/src/inet/mobility/single/TurtleMobility.ned +++ b/src/inet/mobility/single/TurtleMobility.ned @@ -99,7 +99,7 @@ import inet.mobility.base.MovingMobilityBase; simple TurtleMobility extends MovingMobilityBase { parameters: - xml turtleScript; // describes the movement + xml turtleScript; // Describes the movement @class(TurtleMobility); } diff --git a/src/inet/mobility/single/VehicleMobility.ned b/src/inet/mobility/single/VehicleMobility.ned index d3d7b5ff070..1b4b21a51eb 100644 --- a/src/inet/mobility/single/VehicleMobility.ned +++ b/src/inet/mobility/single/VehicleMobility.ned @@ -20,13 +20,13 @@ simple VehicleMobility extends MovingMobilityBase { parameters: @class(VehicleMobility); - string waypointFile; // contains the waypoints as one waypoint x,y,z per line - double waypointProximity @unit(m); // a waypoint is reached when it is less than waypointProximity meters away + string waypointFile; // Contains the waypoints as one waypoint x,y,z per line + double waypointProximity @unit(m); // A waypoint is reached when it is less than waypointProximity meters away double speed @unit(mps); - string groundModule = default("environment.ground"); // module path of the ground module + string groundModule = default("environment.ground"); // Module path of the ground module double initialX @unit(m) = default(uniform(constraintAreaMinX, constraintAreaMaxX)); double initialY @unit(m) = default(uniform(constraintAreaMinY, constraintAreaMaxY)); double initialZ @unit(m) = default(nanToZero(uniform(constraintAreaMinZ, constraintAreaMaxZ))); - bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string + bool initFromDisplayString = default(true); // Enables one time initialization from the subject module's display string } diff --git a/src/inet/mobility/static/StationaryMobility.ned b/src/inet/mobility/static/StationaryMobility.ned index ee76d021ec6..9e9195fbf7c 100644 --- a/src/inet/mobility/static/StationaryMobility.ned +++ b/src/inet/mobility/static/StationaryMobility.ned @@ -24,8 +24,8 @@ simple StationaryMobility extends MobilityBase double initialHeading @unit(deg) = default(0deg); double initialElevation @unit(deg) = default(0deg); double initialBank @unit(deg) = default(0deg); - bool initFromDisplayString = default(true); // enables one time initialization from the subject module's display string - bool updateFromDisplayString = default(true); // enables continuous update from the subject module's display string for dragging and rotating it + bool initFromDisplayString = default(true); // Enables one time initialization from the subject module's display string + bool updateFromDisplayString = default(true); // Enables continuous update from the subject module's display string for dragging and rotating it @class(StationaryMobility); } diff --git a/src/inet/networklayer/arp/ipv4/Arp.ned b/src/inet/networklayer/arp/ipv4/Arp.ned index f46df40d16a..789f20cc474 100644 --- a/src/inet/networklayer/arp/ipv4/Arp.ned +++ b/src/inet/networklayer/arp/ipv4/Arp.ned @@ -37,10 +37,10 @@ simple Arp like IArp parameters: string interfaceTableModule; // The path to the InterfaceTable module string routingTableModule; - double retryTimeout @unit(s) = default(1s); // number seconds ARP waits between retries to resolve an IPv4 address - int retryCount = default(3); // number of times ARP will attempt to resolve an IPv4 address - double cacheTimeout @unit(s) = default(120s); // number seconds unused entries in the cache will time out - string proxyArpInterfaces = default("*"); // list of interfaces that proxy ARP is enabled (all interfaces by default) + double retryTimeout @unit(s) = default(1s); // Number seconds ARP waits between retries to resolve an IPv4 address + int retryCount = default(3); // Number of times ARP will attempt to resolve an IPv4 address + double cacheTimeout @unit(s) = default(120s); // Number seconds unused entries in the cache will time out + string proxyArpInterfaces = default("*"); // List of interfaces that proxy ARP is enabled (all interfaces by default) @display("i=block/layer"); @signal[arpRequestSent](type=inet::Packet); @signal[arpReplySent](type=inet::Packet); @@ -53,8 +53,8 @@ simple Arp like IArp @statistic[arpResolutionCompleted](title="ARP completed resolutions"; record=count); @statistic[arpResolutionFailed](title="ARP failed resolutions"; record=count); gates: - input netwIn @labels(ArpPacket+Ieee802Ctrl); // incoming ARP requests and replies - output netwOut @labels(ArpPacket+Ieee802Ctrl,Ipv4Header+Ieee802Ctrl); // outgoing ARP requests/replies, and datagrams with resolved next hop + input netwIn @labels(ArpPacket+Ieee802Ctrl); // Incoming ARP requests and replies + output netwOut @labels(ArpPacket+Ieee802Ctrl,Ipv4Header+Ieee802Ctrl); // Outgoing ARP requests/replies, and datagrams with resolved next hop input ifIn @labels(ArpPacket,Ieee802Ctrl); output ifOut @labels(ArpPacket,Ieee802Ctrl); } diff --git a/src/inet/networklayer/arp/ipv4/GlobalArp.ned b/src/inet/networklayer/arp/ipv4/GlobalArp.ned index a5783e02677..5d27a15af30 100644 --- a/src/inet/networklayer/arp/ipv4/GlobalArp.ned +++ b/src/inet/networklayer/arp/ipv4/GlobalArp.ned @@ -16,7 +16,7 @@ import inet.networklayer.contract.IArp; simple GlobalArp like IArp { parameters: - string interfaceTableModule; // path to the InterfaceTable module + string interfaceTableModule; // Path to the InterfaceTable module string addressType @enum("ipv4", "ipv6", "mac", "moduleid", "modulepath") = default("ipv4"); @display("i=block/layer"); gates: diff --git a/src/inet/networklayer/common/InterfaceTable.ned b/src/inet/networklayer/common/InterfaceTable.ned index b8c6138db10..d88dd277cd0 100644 --- a/src/inet/networklayer/common/InterfaceTable.ned +++ b/src/inet/networklayer/common/InterfaceTable.ned @@ -24,7 +24,7 @@ package inet.networklayer.common; simple InterfaceTable { parameters: - bool displayAddresses = default(false); // whether to display IP addresses on links + bool displayAddresses = default(false); // Whether to display IP addresses on links @display("i=block/table"); @signal[interfaceCreated](type=inet::NetworkInterface); @signal[interfaceDeleted](type=inet::NetworkInterface); diff --git a/src/inet/networklayer/configurator/ipv4/HostAutoConfigurator.ned b/src/inet/networklayer/configurator/ipv4/HostAutoConfigurator.ned index 68eb27f0b08..7a32098e65d 100644 --- a/src/inet/networklayer/configurator/ipv4/HostAutoConfigurator.ned +++ b/src/inet/networklayer/configurator/ipv4/HostAutoConfigurator.ned @@ -21,10 +21,10 @@ simple HostAutoConfigurator like IIpv4NodeConfigurator { parameters: string interfaceTableModule; - string interfaces = default("wlan"); // list of interfaces to autoassign addresses to, separated by a single space characters - string addressBase = default("10.0.0.0"); // start of address range from which to automatically assign an address to the autoassignInterfaces - string netmask = default("255.0.0.0"); // netmask of subnet in which to automatically assign an address to the autoassignInterfaces - string mcastGroups = default(""); // list of IP addresses of multicast groups to join, separated by a single space characters + string interfaces = default("wlan"); // List of interfaces to autoassign addresses to, separated by a single space characters + string addressBase = default("10.0.0.0"); // Start of address range from which to automatically assign an address to the autoassignInterfaces + string netmask = default("255.0.0.0"); // Netmask of subnet in which to automatically assign an address to the autoassignInterfaces + string mcastGroups = default(""); // List of IP addresses of multicast groups to join, separated by a single space characters @display("i=block/cogwheel"); } diff --git a/src/inet/networklayer/configurator/ipv4/Ipv4FlatNetworkConfigurator.ned b/src/inet/networklayer/configurator/ipv4/Ipv4FlatNetworkConfigurator.ned index 991c7a2e92d..8143fdf8613 100644 --- a/src/inet/networklayer/configurator/ipv4/Ipv4FlatNetworkConfigurator.ned +++ b/src/inet/networklayer/configurator/ipv4/Ipv4FlatNetworkConfigurator.ned @@ -50,8 +50,8 @@ import inet.networklayer.configurator.contract.IL3NetworkConfigurator; simple Ipv4FlatNetworkConfigurator like IL3NetworkConfigurator { parameters: - string networkAddress = default("192.168.0.0"); // network part of the address (see netmask parameter) - string netmask = default("255.255.0.0"); // host part of addresses are autoconfigured + string networkAddress = default("192.168.0.0"); // Network part of the address (see netmask parameter) + string netmask = default("255.255.0.0"); // Host part of addresses are autoconfigured @display("i=block/cogwheel"); @labels(node); } diff --git a/src/inet/networklayer/configurator/ipv4/Ipv4NetworkConfigurator.ned b/src/inet/networklayer/configurator/ipv4/Ipv4NetworkConfigurator.ned index bfa08d23ade..4db9196c320 100644 --- a/src/inet/networklayer/configurator/ipv4/Ipv4NetworkConfigurator.ned +++ b/src/inet/networklayer/configurator/ipv4/Ipv4NetworkConfigurator.ned @@ -403,20 +403,20 @@ simple Ipv4NetworkConfigurator extends L3NetworkConfiguratorBase { parameters: xml config = default(xml("")); // XML configuration parameters for IP address assignment and adding manual routes - bool assignAddresses = default(true); // assign IP addresses to all interfaces in the network - bool assignUniqueAddresses = default(true); // avoid using the same address and raise an error if not possible - bool assignDisjunctSubnetAddresses = default(true); // avoid using the same address prefix and netmask on different links when assigning IP addresses to interfaces - bool addStaticRoutes = default(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) - bool addDefaultRoutes = default(true); // add default routes if all routes from a source node go through the same gateway (used only if addStaticRoutes is true) - bool addSubnetRoutes = default(true); // add subnet routes instead of destination interface routes (only where applicable; used only if addStaticRoutes is true) - bool addDirectRoutes = default(true); // add direct routes (i.e. directly connected interfaces) to the routing table (used only if addStaticRoutes is true) - bool optimizeRoutes = default(true); // optimize routing tables by merging routes, the resulting routing table might route more packets than the original (used only if addStaticRoutes is true) - bool updateRoutes = default(false); // recalculate static routes if an interface goes down/up or a carrier is lost/back - bool dumpTopology = default(false); // print extracted network topology to the module output - bool dumpLinks = default(false); // print recognized network links to the module output - bool dumpAddresses = default(false); // print assigned IP addresses for all interfaces to the module output - bool dumpRoutes = default(false); // print configured and optimized routing tables for all nodes to the module output - string dumpConfig = default(""); // write configuration into the given config file that can be fed back to speed up subsequent runs (network configurations) + bool assignAddresses = default(true); // Assign IP addresses to all interfaces in the network + bool assignUniqueAddresses = default(true); // Avoid using the same address and raise an error if not possible + bool assignDisjunctSubnetAddresses = default(true); // Avoid using the same address prefix and netmask on different links when assigning IP addresses to interfaces + bool addStaticRoutes = default(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) + bool addDefaultRoutes = default(true); // Add default routes if all routes from a source node go through the same gateway (used only if addStaticRoutes is true) + bool addSubnetRoutes = default(true); // Add subnet routes instead of destination interface routes (only where applicable; used only if addStaticRoutes is true) + bool addDirectRoutes = default(true); // Add direct routes (i.e. directly connected interfaces) to the routing table (used only if addStaticRoutes is true) + bool optimizeRoutes = default(true); // Optimize routing tables by merging routes, the resulting routing table might route more packets than the original (used only if addStaticRoutes is true) + bool updateRoutes = default(false); // Recalculate static routes if an interface goes down/up or a carrier is lost/back + bool dumpTopology = default(false); // Print extracted network topology to the module output + bool dumpLinks = default(false); // Print recognized network links to the module output + bool dumpAddresses = default(false); // Print assigned IP addresses for all interfaces to the module output + bool dumpRoutes = default(false); // Print configured and optimized routing tables for all nodes to the module output + string dumpConfig = default(""); // Write configuration into the given config file that can be fed back to speed up subsequent runs (network configurations) @class(Ipv4NetworkConfigurator); @display("i=block/cogwheel"); @signal[networkConfigurationChanged]; diff --git a/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned b/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned index 9621c393125..6fc0fa6fd6c 100644 --- a/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned +++ b/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned @@ -31,8 +31,8 @@ simple Ipv4NodeConfigurator like IIpv4NodeConfigurator string interfaceTableModule; // The path to the InterfaceTable module string routingTableModule; // TODO eventually rename to networkConfigurator - string networkConfiguratorModule = default("configurator"); // the absolute path to the Ipv4NetworkConfigurator; use "" if there is no configurator - bool configureRoutingTable = default(true); // add routing entries to routing table (uses the configurator module) + string networkConfiguratorModule = default("configurator"); // The absolute path to the Ipv4NetworkConfigurator; use "" if there is no configurator + bool configureRoutingTable = default(true); // Add routing entries to routing table (uses the configurator module) @display("i=block/cogwheel"); } diff --git a/src/inet/networklayer/configurator/nexthop/NextHopNetworkConfigurator.ned b/src/inet/networklayer/configurator/nexthop/NextHopNetworkConfigurator.ned index 540a61431b9..cadc845d2a0 100644 --- a/src/inet/networklayer/configurator/nexthop/NextHopNetworkConfigurator.ned +++ b/src/inet/networklayer/configurator/nexthop/NextHopNetworkConfigurator.ned @@ -19,8 +19,8 @@ simple NextHopNetworkConfigurator extends L3NetworkConfiguratorBase @class(NextHopNetworkConfigurator); @display("i=block/cogwheel"); xml config = default(xml("")); // XML configuration parameters - bool addStaticRoutes = default(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) - bool dumpTopology = default(false); // print extracted network topology to the module output - bool dumpRoutes = default(false); // print configured and optimized routing tables for all nodes to the module output + bool addStaticRoutes = default(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) + bool dumpTopology = default(false); // Print extracted network topology to the module output + bool dumpRoutes = default(false); // Print configured and optimized routing tables for all nodes to the module output } diff --git a/src/inet/networklayer/diffserv/AFxyQueue.ned b/src/inet/networklayer/diffserv/AFxyQueue.ned index 5d7cf7131b9..b1997422c05 100644 --- a/src/inet/networklayer/diffserv/AFxyQueue.ned +++ b/src/inet/networklayer/diffserv/AFxyQueue.ned @@ -31,19 +31,19 @@ import inet.queueing.queue.PacketQueue; module AFxyQueue { parameters: - double wq = default(0.002); // smoothing factor, i.e. the weight of the current queue length in the averaged queue length + double wq = default(0.002); // Smoothing factor, i.e. the weight of the current queue length in the averaged queue length - double afx1Minth = default(50); // minimum queue length thresholds for dropping packets with drop priority 1 - double afx1Maxth = default(100); // maximum queue length thresholds for dropping packets with drop priority 1 - double afx1Maxp = default(0.3); // maximum probability of drop when the queue length is between thresholds for drop priority 1 + double afx1Minth = default(50); // Minimum queue length thresholds for dropping packets with drop priority 1 + double afx1Maxth = default(100); // Maximum queue length thresholds for dropping packets with drop priority 1 + double afx1Maxp = default(0.3); // Maximum probability of drop when the queue length is between thresholds for drop priority 1 - double afx2Minth = default(30); // minimum queue length thresholds for dropping packets with drop priority 2 - double afx2Maxth = default(60); // maximum queue length thresholds for dropping packets with drop priority 2 - double afx2Maxp = default(0.6); // maximum probability of drop when the queue length is between thresholds for drop priority 2 + double afx2Minth = default(30); // Minimum queue length thresholds for dropping packets with drop priority 2 + double afx2Maxth = default(60); // Maximum queue length thresholds for dropping packets with drop priority 2 + double afx2Maxp = default(0.6); // Maximum probability of drop when the queue length is between thresholds for drop priority 2 - double afx3Minth = default(10); // minimum queue length thresholds for dropping packets with drop priority 3 - double afx3Maxth = default(40); // maximum queue length thresholds for dropping packets with drop priority 3 - double afx3Maxp = default(0.9); // maximum probability of drop when the queue length is between thresholds for drop priority 3 + double afx3Minth = default(10); // Minimum queue length thresholds for dropping packets with drop priority 3 + double afx3Maxth = default(40); // Maximum queue length thresholds for dropping packets with drop priority 3 + double afx3Maxp = default(0.9); // Maximum probability of drop when the queue length is between thresholds for drop priority 3 @display("i=block/queue;q=l2queue"); diff --git a/src/inet/networklayer/diffserv/BehaviorAggregateClassifier.ned b/src/inet/networklayer/diffserv/BehaviorAggregateClassifier.ned index 5c6d7cf4690..078f3a39902 100644 --- a/src/inet/networklayer/diffserv/BehaviorAggregateClassifier.ned +++ b/src/inet/networklayer/diffserv/BehaviorAggregateClassifier.ned @@ -20,7 +20,7 @@ import inet.queueing.base.PacketClassifierBase; simple BehaviorAggregateClassifier extends PacketClassifierBase { parameters: - string dscps = default(""); // space separated dscp values of the gates, both names (e.g. AF11, EF) and numbers (0x0A,0b101110) can be used + string dscps = default(""); // Space separated dscp values of the gates, both names (e.g. AF11, EF) and numbers (0x0A,0b101110) can be used @class(BehaviorAggregateClassifier); @signal[pkClass](type=long); @statistic[pkClass](title="packet class"; source=pkClass; record=vector; interpolationmode=none); diff --git a/src/inet/networklayer/diffserv/DiffservQueue.ned b/src/inet/networklayer/diffserv/DiffservQueue.ned index 8e87ebbaeed..a4265a47881 100644 --- a/src/inet/networklayer/diffserv/DiffservQueue.ned +++ b/src/inet/networklayer/diffserv/DiffservQueue.ned @@ -49,7 +49,7 @@ module DiffservQueue extends CompoundPacketQueueBase @display("p=100,330"); } efMeter: TokenBucketMeter { - cir = default("10%"); // reserved EF bandwith as percentage of datarate of the interface + cir = default("10%"); // Reserved EF bandwith as percentage of datarate of the interface cbs = default(5000B); // 5 1000B packets @display("p=250,130"); } @@ -57,7 +57,7 @@ module DiffservQueue extends CompoundPacketQueueBase @display("p=400,80"); } efQueue: DropTailQueue { - packetCapacity = default(5); // keep low, for low delay and jitter + packetCapacity = default(5); // Keep low, for low delay and jitter @display("p=400,180"); } af1xQueue: AFxyQueue { diff --git a/src/inet/networklayer/diffserv/DscpMarker.ned b/src/inet/networklayer/diffserv/DscpMarker.ned index ae238377853..0d40fa2386a 100644 --- a/src/inet/networklayer/diffserv/DscpMarker.ned +++ b/src/inet/networklayer/diffserv/DscpMarker.ned @@ -20,7 +20,7 @@ import inet.queueing.base.PacketProcessorBase; simple DscpMarker extends PacketProcessorBase { parameters: - string dscps; // space separated list if dscp values; both names (e.g. AF11, EF) and numbers (0x0A,0b101110) can be used + string dscps; // Space separated list if dscp values; both names (e.g. AF11, EF) and numbers (0x0A,0b101110) can be used @class(DscpMarker); @display("i=block/star"); @signal[packetMarked](type=cPacket); diff --git a/src/inet/networklayer/diffserv/SingleRateThreeColorMeter.ned b/src/inet/networklayer/diffserv/SingleRateThreeColorMeter.ned index fa04d9e689c..ca47caec8ff 100644 --- a/src/inet/networklayer/diffserv/SingleRateThreeColorMeter.ned +++ b/src/inet/networklayer/diffserv/SingleRateThreeColorMeter.ned @@ -32,10 +32,10 @@ simple SingleRateThreeColorMeter parameters: @display("i=block/timer"); string interfaceTableModule; // The path to the InterfaceTable module - string cir; // committed information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%") - int cbs @unit(B); // committed burst size - int ebs @unit(B); // excess burst size - bool colorAwareMode = default(false); // enables color-aware mode + string cir; // Committed information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%") + int cbs @unit(B); // Committed burst size + int ebs @unit(B); // Excess burst size + bool colorAwareMode = default(false); // Enables color-aware mode gates: input in; output greenOut; diff --git a/src/inet/networklayer/diffserv/TokenBucketMeter.ned b/src/inet/networklayer/diffserv/TokenBucketMeter.ned index 6984bb24101..7dd293b55f2 100644 --- a/src/inet/networklayer/diffserv/TokenBucketMeter.ned +++ b/src/inet/networklayer/diffserv/TokenBucketMeter.ned @@ -29,9 +29,9 @@ simple TokenBucketMeter parameters: @display("i=block/timer"); string interfaceTableModule; // The path to the InterfaceTable module - string cir; // committed information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%") - int cbs @unit(B); // committed burst size - bool colorAwareMode = default(false); // enables color-aware mode + string cir; // Committed information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%") + int cbs @unit(B); // Committed burst size + bool colorAwareMode = default(false); // Enables color-aware mode gates: input in; output greenOut; diff --git a/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned b/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned index a3b9bf236e7..34e49a2df85 100644 --- a/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned +++ b/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned @@ -1,4 +1,4 @@ -// +// // Copyright (C) 2012 OpenSim Ltd. // // SPDX-License-Identifier: LGPL-3.0-or-later @@ -33,11 +33,11 @@ simple TwoRateThreeColorMeter parameters: @display("i=block/timer"); string interfaceTableModule; // The path to the InterfaceTable module - string pir; // peak information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%") - int pbs @unit(B); // peak burst size - string cir; // committed information rate, either absolute or relative bitrate; must be smaller than pir - int cbs @unit(B); // committed burst size - bool colorAwareMode = default(false); // enables color-aware mode + string pir; // Peak information rate, either absolute bitrate (e.g. "100kbps"), or relative to the link's datarate (e.g. "20%") + int pbs @unit(B); // Peak burst size + string cir; // Committed information rate, either absolute or relative bitrate; must be smaller than pir + int cbs @unit(B); // Committed burst size + bool colorAwareMode = default(false); // Enables color-aware mode gates: input in; output greenOut; diff --git a/src/inet/networklayer/flooding/Flooding.ned b/src/inet/networklayer/flooding/Flooding.ned index 54dcf419d10..757757b71cd 100644 --- a/src/inet/networklayer/flooding/Flooding.ned +++ b/src/inet/networklayer/flooding/Flooding.ned @@ -43,8 +43,8 @@ simple Flooding extends NetworkProtocolBase like INetworkProtocol { parameters: @display("i=block/fork"); - int headerLength @unit(b) = default(96b); // length of the network packet header (in bits) - bool plainFlooding = default(true); // flag whether to use plain flooding + int headerLength @unit(b) = default(96b); // Length of the network packet header (in bits) + bool plainFlooding = default(true); // Flag whether to use plain flooding // Max number of entries in the list of already broadcasted messages int bcMaxEntries = default(100); // Time after which an entry for an already broadcasted msg can be deleted diff --git a/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned b/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned index bad3093a329..ff779c9d21e 100644 --- a/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned +++ b/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned @@ -26,7 +26,7 @@ simple Ipv6NeighbourDiscovery double minIntervalBetweenRAs @unit(s) = default(30ms); //minRtrAdvInterval: 0.03 sec for MIPv6 , declared as parameter to facilitate testing without recompiling (Zarrar 15.07.07) double maxIntervalBetweenRAs @unit(s) = default(70ms); //MaxrtrAdvInterval: 0.07 sec for MIPv6, declared as parameter to facilitate testing without recompiling (Zarrar 15.07.07) @display("i=block/network"); - @signal[startDad](type=long); // emits value=1 + @signal[startDad](type=long); // Emits value=1 @statistic[startDad](title="DAD started";record=count,vector); gates: input ipv6In; diff --git a/src/inet/networklayer/ipv4/Icmp.ned b/src/inet/networklayer/ipv4/Icmp.ned index 1d7c1ce6fa5..ef2a027acea 100644 --- a/src/inet/networklayer/ipv4/Icmp.ned +++ b/src/inet/networklayer/ipv4/Icmp.ned @@ -22,7 +22,7 @@ simple Icmp gates: input transportIn; output transportOut; - input ipIn @labels(Ipv4ControlInfo/up); // delivered ICMP packets - output ipOut @labels(Ipv4ControlInfo/down); // towards network + input ipIn @labels(Ipv4ControlInfo/up); // Delivered ICMP packets + output ipOut @labels(Ipv4ControlInfo/down); // Towards network } diff --git a/src/inet/networklayer/ipv4/Igmpv2.ned b/src/inet/networklayer/ipv4/Igmpv2.ned index 96e919e4546..082c3d38ae6 100644 --- a/src/inet/networklayer/ipv4/Igmpv2.ned +++ b/src/inet/networklayer/ipv4/Igmpv2.ned @@ -111,8 +111,8 @@ simple Igmpv2 like IIgmp @selfMessageKinds(inet::IgmpTimerKind); gates: - input ipIn @labels(Ipv4ControlInfo/up); // delivered IGMP packets - output ipOut @labels(Ipv4ControlInfo/down); // to ~Ipv4 + input ipIn @labels(Ipv4ControlInfo/up); // Delivered IGMP packets + output ipOut @labels(Ipv4ControlInfo/down); // To ~Ipv4 input routerIn @labels(Ipv4ControlInfo/up); output routerOut @labels(Ipv4ControlInfo/down); diff --git a/src/inet/networklayer/ipv4/Igmpv3.ned b/src/inet/networklayer/ipv4/Igmpv3.ned index a543f289370..7698dbfc08c 100644 --- a/src/inet/networklayer/ipv4/Igmpv3.ned +++ b/src/inet/networklayer/ipv4/Igmpv3.ned @@ -29,8 +29,8 @@ simple Igmpv3 like IIgmp @selfMessageKinds(inet::IgmpTimerKind); gates: - input ipIn @labels(Ipv4ControlInfo/up); // delivered IGMP packets - output ipOut @labels(Ipv4ControlInfo/down); // to ~Ipv4 + input ipIn @labels(Ipv4ControlInfo/up); // Delivered IGMP packets + output ipOut @labels(Ipv4ControlInfo/down); // To ~Ipv4 input routerIn @labels(Ipv4ControlInfo/up); output routerOut @labels(Ipv4ControlInfo/down); diff --git a/src/inet/networklayer/ipv4/Ipv4.ned b/src/inet/networklayer/ipv4/Ipv4.ned index 5fd11e7ffe3..2d3aac6d856 100644 --- a/src/inet/networklayer/ipv4/Ipv4.ned +++ b/src/inet/networklayer/ipv4/Ipv4.ned @@ -89,11 +89,11 @@ simple Ipv4 like IIpv4 int timeToLive = default(32); int multicastTimeToLive = default(32); double fragmentTimeout @unit(s) = default(60s); - bool limitedBroadcast = default(false); // send out limited broadcast packets comming from higher layer - string directBroadcastInterfaces = default(""); // list of interfaces that direct broadcast is enabled (by default direct broadcast is disabled on all interfaces) - bool enableLocalOutMulticastRouting = default(false); // enable using the multicast routing table for determining outgoing interfaces for local out packets - bool enableTimestampOption = default(false); // when enabled IP inserts a timestamp option into the IP header - double maxLifetime @unit(s) = default(-1s); // packets older than the limit are discarded + bool limitedBroadcast = default(false); // Send out limited broadcast packets comming from higher layer + string directBroadcastInterfaces = default(""); // List of interfaces that direct broadcast is enabled (by default direct broadcast is disabled on all interfaces) + bool enableLocalOutMulticastRouting = default(false); // Enable using the multicast routing table for determining outgoing interfaces for local out packets + bool enableTimestampOption = default(false); // When enabled IP inserts a timestamp option into the IP header + double maxLifetime @unit(s) = default(-1s); // Packets older than the limit are discarded @display("i=block/routing"); @signal[packetSentToUpper](type=cPacket); @signal[packetReceivedFromUpper](type=cPacket); diff --git a/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned b/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned index 8209b624f46..17e1f020a27 100644 --- a/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned +++ b/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned @@ -40,14 +40,14 @@ simple Ipv4RoutingTable like IRoutingTable { parameters: string interfaceTableModule; // The path to the InterfaceTable module - string routerId = default("auto"); // for routers, the router id using IPv4 address dotted + string routerId = default("auto"); // For routers, the router id using IPv4 address dotted // notation; specify "auto" to select the highest // interface address; should be left empty ("") for hosts - string netmaskRoutes = default("*"); // maintain netmask routes for interfaces - bool forwarding = default(true); // turns IP forwarding on/off - bool multicastForwarding = default(false); // turns multicast forwarding on/off + string netmaskRoutes = default("*"); // Maintain netmask routes for interfaces + bool forwarding = default(true); // Turns IP forwarding on/off + bool multicastForwarding = default(false); // Turns multicast forwarding on/off bool useAdminDist = default(false); // Use Cisco like administrative distances - string routingFile = default(""); // routing table file name + string routingFile = default(""); // Routing table file name @display("i=block/table"); @signal[routeAdded](type=inet::Ipv4Route); @signal[routeDeleted](type=inet::Ipv4Route); diff --git a/src/inet/networklayer/ipv4/ipsec/IPsec.ned b/src/inet/networklayer/ipv4/ipsec/IPsec.ned index 8f715595931..b21c0023316 100644 --- a/src/inet/networklayer/ipv4/ipsec/IPsec.ned +++ b/src/inet/networklayer/ipv4/ipsec/IPsec.ned @@ -5,15 +5,15 @@ // it under the terms of the GNU Lesser General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. -// +// // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. -// +// // You should have received a copy of the GNU Lesser General Public License // along with this program. If not, see http://www.gnu.org/licenses/. -// +// package inet.networklayer.ipv4.ipsec; @@ -36,9 +36,9 @@ package inet.networklayer.ipv4.ipsec; // - Transport mode only. Tunnel mode is not supported. // - Multicast traffic is not supported. (Any multicast packet is let through unchanged.) // - Anti-replay mechanism is not implemented. -// - DSCP-based SA selection is not implemented. +// - DSCP-based SA selection is not implemented. +// // -// // Configuration: // // Security policies and security associations are defined using XML. The XML @@ -55,7 +55,7 @@ package inet.networklayer.ipv4.ipsec; // Structural elements (notation: ?=optional, *=zero or more): // // - root: SecurityPolicy* -// - SecurityPolicy: Selector, Direction, Action, Protection?, EspMode?, +// - SecurityPolicy: Selector, Direction, Action, Protection?, EspMode?, // EncryptionAlg?, AuthenticationAlg?, MaxTfcPadLength?, SecurityAssociation* // - Selector: LocalAddress?, RemoteAddress?, Protocol?, LocalPort?, RemotePort?, ICMPType?, ICMPCode? // - SecurityAssociation: SPI, Selector? @@ -77,7 +77,7 @@ package inet.networklayer.ipv4.ipsec; // and authentication is in use (protection is AH, or ESP with mode INTEGRITY or COMBINED). // Possible values are: NONE, HMAC_MD5_96, HMAC_SHA1, AES_128_GMAC, AES_192_GMAC, // AES_256_GMAC, HMAC_SHA2_256_128, HMAC_SHA2_384_192, HMAC_SHA2_512_256. -// - MaxTfcPadLength: Maximum length of random Traffic Confidentiality (TFC) padding. +// - MaxTfcPadLength: Maximum length of random Traffic Confidentiality (TFC) padding. // The actual TFC pad length will be drawn with uniform distribution over [0,max]. // - LocalAddress, RemoteAddress: comma-separated list of addresses / address ranges // - Protocol: comma-separated list of protocol names/numbers and/or their ranges. @@ -173,30 +173,30 @@ package inet.networklayer.ipv4.ipsec; // is processed in the POST_ROUTING hook, and ingress traffic in the LOCAL_IN // hook. // -// @see ~SecurityPolicyDatabase, ~SecurityAssociationDatabase +// @see ~SecurityPolicyDatabase, ~SecurityAssociationDatabase // simple IPsec { parameters: @display("i=block/control;is=s"); - + string networkProtocolModule = default("^.ip"); string interfaceTableModule; string spdModule = default("^.spd"); string sadModule = default("^.sad"); xml spdConfig; - string defaultProtection = default(""); // if not "": value to use where element is absent from the configuration - string defaultEspMode = default(""); // if not "": value to use where element is absent from the configuration - string defaultEncryptionAlg = default(""); // if not "": value to use where element is absent from the configuration - string defaultAuthenticationAlg = default(""); // if not "": value to use where element is absent from the configuration - int defaultMaxTfcPadLength = default(0); // value to use where element is absent from the configuration - + string defaultProtection = default(""); // If not "": value to use where element is absent from the configuration + string defaultEspMode = default(""); // If not "": value to use where element is absent from the configuration + string defaultEncryptionAlg = default(""); // If not "": value to use where element is absent from the configuration + string defaultAuthenticationAlg = default(""); // If not "": value to use where element is absent from the configuration + int defaultMaxTfcPadLength = default(0); // Value to use where element is absent from the configuration + volatile double ahProtectOutDelay @unit(s) = default(0.0s); volatile double ahProtectInDelay @unit(s) = default(0.0s); volatile double espProtectOutDelay @unit(s) = default(0.0s); volatile double espProtectInDelay @unit(s) = default(0.0s); - + @signal[inProtectedAccept](type=long); @signal[inProtectedDrop](type=long); @signal[inUnprotectedBypass](type=long); @@ -206,7 +206,7 @@ simple IPsec @signal[outDrop](type=long); @signal[inProcessDelay](type=double); @signal[outProcessDelay](type=double); - + @statistic[inProtectedAccept](title="Incoming Protected Packet Accepted"; record=count,vector); @statistic[inProtectedDrop](title="Incoming Protected Packet Dropped"; record=count,vector); @statistic[inUnprotectedBypass](title="Incoming Unprotected Packet Bypassed"; record=count,vector); diff --git a/src/inet/networklayer/ldp/Ldp.ned b/src/inet/networklayer/ldp/Ldp.ned index a772054842d..f4079005efe 100644 --- a/src/inet/networklayer/ldp/Ldp.ned +++ b/src/inet/networklayer/ldp/Ldp.ned @@ -38,8 +38,8 @@ simple Ldp like IApp double helloInterval @unit(s) = default(5s); @display("i=block/control"); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation gates: input socketIn @labels(TcpCommand/up,UdpControlInfo/up); diff --git a/src/inet/networklayer/mpls/LibTable.ned b/src/inet/networklayer/mpls/LibTable.ned index 3aa699175c3..ed590dc062f 100644 --- a/src/inet/networklayer/mpls/LibTable.ned +++ b/src/inet/networklayer/mpls/LibTable.ned @@ -32,7 +32,7 @@ package inet.networklayer.mpls; simple LibTable { parameters: - xml config = default(xml("")); // table contents to be loaded on startup + xml config = default(xml("")); // Table contents to be loaded on startup @display("i=block/table2"); } diff --git a/src/inet/networklayer/nexthop/NextHopRoutingTable.ned b/src/inet/networklayer/nexthop/NextHopRoutingTable.ned index a9533ac06c4..f365f4fec19 100644 --- a/src/inet/networklayer/nexthop/NextHopRoutingTable.ned +++ b/src/inet/networklayer/nexthop/NextHopRoutingTable.ned @@ -18,11 +18,11 @@ simple NextHopRoutingTable like IRoutingTable string interfaceTableModule; // The path to the InterfaceTable module @display("i=block/table"); string addressType @enum("mac","modulepath","moduleid") = default("modulepath"); - string routerId = default("auto"); // for routers, the router id using address dotted + string routerId = default("auto"); // For routers, the router id using address dotted // notation; specify "auto" to select the highest // interface address; should be left empty ("") for hosts - bool forwarding = default(true); // turns IP forwarding on/off - bool multicastForwarding = default(false); // turns multicast forwarding on/off + bool forwarding = default(true); // Turns IP forwarding on/off + bool multicastForwarding = default(false); // Turns multicast forwarding on/off @signal[routeAdded](type=inet::NextHopRoute); @signal[routeDeleted](type=inet::NextHopRoute); @signal[routeChanged](type=inet::NextHopRoute); diff --git a/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned b/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned index ea1ff3195f8..b96d2f07821 100644 --- a/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned +++ b/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned @@ -37,7 +37,7 @@ simple ProbabilisticBroadcast extends NetworkProtocolBase like INetworkProtocol { parameters: @class(ProbabilisticBroadcast); - int headerLength @unit(b) = default(96b); // length of the network packet header (in bits) + int headerLength @unit(b) = default(96b); // Length of the network packet header (in bits) // period between two probabilistic broadcast attempts double bcperiod @unit(s) = default(2 s); // probability of broadcast for each attempt diff --git a/src/inet/networklayer/rsvpte/RsvpTe.ned b/src/inet/networklayer/rsvpte/RsvpTe.ned index 233476d27c1..80a6f88b6d5 100644 --- a/src/inet/networklayer/rsvpte/RsvpTe.ned +++ b/src/inet/networklayer/rsvpte/RsvpTe.ned @@ -1,7 +1,7 @@ // // Copyright (C) 2005 Vojtech Janota // -// SPDX-License-Identifier: LGPL-3.0-or-later +// SPDX-License-Identifier: LGPL-3.0-or-later // package inet.networklayer.rsvpte; @@ -87,8 +87,8 @@ simple RsvpTe string libTableModule; string tedModule; string classifierModule; // The path to the module which implements the IIngressClassifier C++ interface - xml traffic = default(xml("")); // specifies paths to set up - string peers; // names of the interfaces towards RSVP peers + xml traffic = default(xml("")); // Specifies paths to set up + string peers; // Names of the interfaces towards RSVP peers double helloInterval @unit(s); double helloTimeout @unit(s); @display("i=block/control"); diff --git a/src/inet/networklayer/wiseroute/WiseRoute.ned b/src/inet/networklayer/wiseroute/WiseRoute.ned index c1c16352a58..880a4b0a32c 100644 --- a/src/inet/networklayer/wiseroute/WiseRoute.ned +++ b/src/inet/networklayer/wiseroute/WiseRoute.ned @@ -44,7 +44,7 @@ import inet.networklayer.contract.INetworkProtocol; simple WiseRoute extends NetworkProtocolBase like INetworkProtocol { parameters: - int headerLength @unit(b) = default(96b); // length of the network packet header (in bits) + int headerLength @unit(b) = default(96b); // Length of the network packet header (in bits) // debug switch bool debug = default(false); diff --git a/src/inet/node/base/LinkLayerNodeBase.ned b/src/inet/node/base/LinkLayerNodeBase.ned index d9b982614c7..3d452d0f4c4 100644 --- a/src/inet/node/base/LinkLayerNodeBase.ned +++ b/src/inet/node/base/LinkLayerNodeBase.ned @@ -30,8 +30,8 @@ module LinkLayerNodeBase extends NodeBase like IEthernetNetworkNode int numPcapRecorders = default(recordPcap ? 1 : 0); int numLoInterfaces = default(1); int numWlanInterfaces = default(0); - int numEthInterfaces = default(0); // minimum number of ethernet interfaces - int numPppInterfaces = default(0); // minimum number of PPP interfaces + int numEthInterfaces = default(0); // Minimum number of ethernet interfaces + int numPppInterfaces = default(0); // Minimum number of PPP interfaces int numTunInterfaces = default(0); int numVirtInterfaces = default(0); string fcsMode @enum("declared","computed") = default("declared"); diff --git a/src/inet/node/base/NodeBase.ned b/src/inet/node/base/NodeBase.ned index 85a7ec7759a..005160df1f5 100644 --- a/src/inet/node/base/NodeBase.ned +++ b/src/inet/node/base/NodeBase.ned @@ -31,9 +31,9 @@ module NodeBase like INetworkNode bool hasStatus = default(false); bool hasEnvironment = default(false); string osgModel = default(""); // 3D model for OSG visualization, no 3D model by default - string osgModelColor = default(""); // tint color, no colorization by default - string canvasImage = default(""); // image for canvas visualization, no image by default - string canvasImageColor = default(""); // tint color, no colorization by default + string osgModelColor = default(""); // Tint color, no colorization by default + string canvasImage = default(""); // Image for canvas visualization, no image by default + string canvasImageColor = default(""); // Tint color, no colorization by default mobility.subjectModule = default("^"); *.mobilityModule = default(exists(mobility) ? absPath(".mobility") : ""); *.energySourceModule = default(exists(energyStorage) ? absPath(".energyStorage") : ""); diff --git a/src/inet/node/ethernet/EthernetHost.ned b/src/inet/node/ethernet/EthernetHost.ned index aadf98d02eb..b0903617ad4 100644 --- a/src/inet/node/ethernet/EthernetHost.ned +++ b/src/inet/node/ethernet/EthernetHost.ned @@ -26,7 +26,7 @@ module EthernetHost { parameters: bool hasStatus = default(false); - bool csmacdSupport = default(true); // by default use CSMA/CD + bool csmacdSupport = default(true); // By default use CSMA/CD string fcsMode @enum("declared","computed") = default("declared"); @networkNode(); @labels(node,ethernet-node); diff --git a/src/inet/node/ethernet/EthernetSwitch.ned b/src/inet/node/ethernet/EthernetSwitch.ned index cae3675fe43..28850bd94ee 100644 --- a/src/inet/node/ethernet/EthernetSwitch.ned +++ b/src/inet/node/ethernet/EthernetSwitch.ned @@ -49,7 +49,7 @@ module EthernetSwitch like IEthernetNetworkNode bool hasCutthroughSwitching = default(false); string fcsMode @enum("declared","computed") = default("declared"); string spanningTreeProtocol = default("Stp"); - int numEthInterfaces = default(0); // minimum number of ethernet interfaces + int numEthInterfaces = default(0); // Minimum number of ethernet interfaces eth[*].encap.typename = default(""); *.fcsMode = this.fcsMode; **.interfaceTableModule = default(absPath(".interfaceTable")); diff --git a/src/inet/node/inet/StandardHost.ned b/src/inet/node/inet/StandardHost.ned index 12248fb861b..88ca7bd0fa8 100644 --- a/src/inet/node/inet/StandardHost.ned +++ b/src/inet/node/inet/StandardHost.ned @@ -31,8 +31,8 @@ module StandardHost extends ApplicationLayerNodeBase parameters: @display("i=device/pc2"); @figure[submodules]; - forwarding = default(false); // disable routing by default - ipv4.arp.proxyArpInterfaces = default(""); // proxy arp is disabled on hosts by default + forwarding = default(false); // Disable routing by default + ipv4.arp.proxyArpInterfaces = default(""); // Proxy arp is disabled on hosts by default *.routingTableModule = default("^.ipv4.routingTable"); } diff --git a/src/inet/node/tsn/TsnClock.ned b/src/inet/node/tsn/TsnClock.ned index 6a5143f0eab..fc6234618fe 100644 --- a/src/inet/node/tsn/TsnClock.ned +++ b/src/inet/node/tsn/TsnClock.ned @@ -17,10 +17,10 @@ import inet.linklayer.ieee8021as.GptpMaster; module TsnClock extends GptpMaster { parameters: - bool hasCutthroughSwitching = default(false); // enable cut-through switching support - clock.typename = default("OscillatorBasedClock"); // master clocks cannot be set - ethernet.typename = default("EthernetLayer"); // use Ethernet protocol layer outside of network interfaces - eth[*].typename = default("LayeredEthernetInterface"); // switch to modular Ethernet interface - eth[*].phyLayer.typename = default(hasCutthroughSwitching ? "EthernetStreamingPhyLayer" : "EthernetPhyLayer"); // use packet streaming when cut-through switching is enabled - @display("i=device/card"); // change icon to emphasise hardware device + bool hasCutthroughSwitching = default(false); // Enable cut-through switching support + clock.typename = default("OscillatorBasedClock"); // Master clocks cannot be set + ethernet.typename = default("EthernetLayer"); // Use Ethernet protocol layer outside of network interfaces + eth[*].typename = default("LayeredEthernetInterface"); // Switch to modular Ethernet interface + eth[*].phyLayer.typename = default(hasCutthroughSwitching ? "EthernetStreamingPhyLayer" : "EthernetPhyLayer"); // Use packet streaming when cut-through switching is enabled + @display("i=device/card"); // Change icon to emphasise hardware device } diff --git a/src/inet/node/tsn/TsnDevice.ned b/src/inet/node/tsn/TsnDevice.ned index aaf6cd83319..5d1500a31c5 100644 --- a/src/inet/node/tsn/TsnDevice.ned +++ b/src/inet/node/tsn/TsnDevice.ned @@ -20,34 +20,34 @@ import inet.node.inet.StandardHost; module TsnDevice extends StandardHost { parameters: - bool hasTimeSynchronization = default(false); // enable IEEE 802.1 AS time synchronization - bool hasIngressTrafficFiltering = default(false); // enable IEEE 802.1 Qci ingress per-stream filtering - bool hasEgressTrafficFiltering = default(false); // enable IEEE 802.1 Qci egress per-stream filtering - bool hasEgressTrafficShaping = default(false); // enable IEEE 802.1 egress traffic shaping (credit based shaping, time aware shaping, asynchronous shaping) - bool hasStreamRedundancy = default(false); // enable IEEE 802.1 CB frame replication and elimination - bool hasIncomingStreams = default(false); // enable IEEE 802.1 stream decoding - bool hasOutgoingStreams = default(false); // enable IEEE 802.1 stream identification and stream encoding - bool hasFramePreemption = default(false); // enable IEEE 802.1 Qbu frame preemption - bool hasCutthroughSwitching = default(false); // enable cut-through switching support + bool hasTimeSynchronization = default(false); // Enable IEEE 802.1 AS time synchronization + bool hasIngressTrafficFiltering = default(false); // Enable IEEE 802.1 Qci ingress per-stream filtering + bool hasEgressTrafficFiltering = default(false); // Enable IEEE 802.1 Qci egress per-stream filtering + bool hasEgressTrafficShaping = default(false); // Enable IEEE 802.1 egress traffic shaping (credit based shaping, time aware shaping, asynchronous shaping) + bool hasStreamRedundancy = default(false); // Enable IEEE 802.1 CB frame replication and elimination + bool hasIncomingStreams = default(false); // Enable IEEE 802.1 stream decoding + bool hasOutgoingStreams = default(false); // Enable IEEE 802.1 stream identification and stream encoding + bool hasFramePreemption = default(false); // Enable IEEE 802.1 Qbu frame preemption + bool hasCutthroughSwitching = default(false); // Enable cut-through switching support bool hasBridging = default(hasIncomingStreams || hasOutgoingStreams || hasStreamRedundancy || hasIngressTrafficFiltering || hasEgressTrafficFiltering); - clock.typename = default(hasTimeSynchronization ? "SettableClock" : ""); // enable explicit local clock model - ethernet.typename = default("EthernetLayer"); // use Ethernet protocol layer outside of network interfaces - eth[*].typename = default("LayeredEthernetInterface"); // switch to modular Ethernet interface + clock.typename = default(hasTimeSynchronization ? "SettableClock" : ""); // Enable explicit local clock model + ethernet.typename = default("EthernetLayer"); // Use Ethernet protocol layer outside of network interfaces + eth[*].typename = default("LayeredEthernetInterface"); // Switch to modular Ethernet interface eth[*].macLayer.typename = default(hasFramePreemption ? "EthernetPreemptingMacLayer" : "EthernetMacLayer"); - eth[*].macLayer.queue.typename = default(hasEgressTrafficShaping ? "Ieee8021qTimeAwareShaper" : (hasFramePreemption ? "" : "PacketQueue")); // use priority queue having multiple subqueues controlled by separate gates - eth[*].phyLayer.typename = default(hasCutthroughSwitching ? "EthernetStreamingPhyLayer" : (hasFramePreemption ? "EthernetPreemptingPhyLayer" : "EthernetPhyLayer")); // use packet streaming when cut-through switching is enabled - bridging.typename = default(hasBridging ? "BridgingLayer" : ""); // switch to modular bridging - bridging.interfaceRelay.typename = default(""); // disable frame relaying - bridging.streamIdentifier.typename = default(hasOutgoingStreams || hasStreamRedundancy ? "StreamIdentifierLayer" : ""); // enable stream identification when stream redundancy is enabled - bridging.streamIdentifier.identifier.hasSequenceNumbering = default(hasStreamRedundancy); // enable sequence numberinf if stream redundancy is enabled - bridging.streamRelay.typename = default(hasStreamRedundancy ? "StreamRelayLayer" : ""); // enable stream merging and stream splitting when stream redundancy is enabled - bridging.streamFilter.typename = default(hasIngressTrafficFiltering || hasEgressTrafficFiltering ? "StreamFilterLayer" : ""); // enable stream filtering when ingress or egress per-stream filtering is enabled - bridging.streamFilter.ingress.typename = default(hasIngressTrafficFiltering ? "SimpleIeee8021qFilter" : ""); // use IEEE 802.1 Qci ingress filter when ingress per-stream filtering is enabled - bridging.streamFilter.egress.typename = default(hasEgressTrafficFiltering ? "SimpleIeee8021qFilter" : ""); // use IEEE 802.1 Qci egress filter when egress per-stream filtering is enabled - bridging.streamCoder.typename = default(hasIncomingStreams || hasOutgoingStreams || hasStreamRedundancy ? "StreamCoderLayer" : ""); // enable stream endocing/decoding when stream redundancy is enabled + eth[*].macLayer.queue.typename = default(hasEgressTrafficShaping ? "Ieee8021qTimeAwareShaper" : (hasFramePreemption ? "" : "PacketQueue")); // Use priority queue having multiple subqueues controlled by separate gates + eth[*].phyLayer.typename = default(hasCutthroughSwitching ? "EthernetStreamingPhyLayer" : (hasFramePreemption ? "EthernetPreemptingPhyLayer" : "EthernetPhyLayer")); // Use packet streaming when cut-through switching is enabled + bridging.typename = default(hasBridging ? "BridgingLayer" : ""); // Switch to modular bridging + bridging.interfaceRelay.typename = default(""); // Disable frame relaying + bridging.streamIdentifier.typename = default(hasOutgoingStreams || hasStreamRedundancy ? "StreamIdentifierLayer" : ""); // Enable stream identification when stream redundancy is enabled + bridging.streamIdentifier.identifier.hasSequenceNumbering = default(hasStreamRedundancy); // Enable sequence numberinf if stream redundancy is enabled + bridging.streamRelay.typename = default(hasStreamRedundancy ? "StreamRelayLayer" : ""); // Enable stream merging and stream splitting when stream redundancy is enabled + bridging.streamFilter.typename = default(hasIngressTrafficFiltering || hasEgressTrafficFiltering ? "StreamFilterLayer" : ""); // Enable stream filtering when ingress or egress per-stream filtering is enabled + bridging.streamFilter.ingress.typename = default(hasIngressTrafficFiltering ? "SimpleIeee8021qFilter" : ""); // Use IEEE 802.1 Qci ingress filter when ingress per-stream filtering is enabled + bridging.streamFilter.egress.typename = default(hasEgressTrafficFiltering ? "SimpleIeee8021qFilter" : ""); // Use IEEE 802.1 Qci egress filter when egress per-stream filtering is enabled + bridging.streamCoder.typename = default(hasIncomingStreams || hasOutgoingStreams || hasStreamRedundancy ? "StreamCoderLayer" : ""); // Enable stream endocing/decoding when stream redundancy is enabled ieee8021r.typename = default(hasStreamRedundancy ? "Ieee8021rProtocol" : ""); ieee8021q.typename = default(hasIncomingStreams || hasOutgoingStreams || hasStreamRedundancy ? "Ieee8021qProtocol" : ""); - @display("i=device/card"); // change icon to emphasise hardware device + @display("i=device/card"); // Change icon to emphasise hardware device submodules: gptp: like IApp if hasTimeSynchronization { gptpNodeType = default("SLAVE_NODE"); diff --git a/src/inet/node/tsn/TsnSwitch.ned b/src/inet/node/tsn/TsnSwitch.ned index 4963d20f505..d228ad2d9cc 100644 --- a/src/inet/node/tsn/TsnSwitch.ned +++ b/src/inet/node/tsn/TsnSwitch.ned @@ -20,30 +20,30 @@ import inet.node.ethernet.EthernetSwitch; module TsnSwitch extends EthernetSwitch { parameters: - bool hasTimeSynchronization = default(false); // enable IEEE 802.1 AS time synchronization - bool hasIngressTrafficFiltering = default(false); // enable IEEE 802.1 Qci ingress per-stream filtering - bool hasEgressTrafficShaping = default(false); // enable IEEE 802.1 egress traffic shaping (credit based shaping, time aware shaping, asynchronous shaping) - bool hasStreamRedundancy = default(false); // enable IEEE 802.1 CB frame replication and elimination - bool hasIncomingStreams = default(false); // enable IEEE 802.1 stream decoding - bool hasOutgoingStreams = default(false); // enable IEEE 802.1 stream identification and stream encoding - bool hasFramePreemption = default(false); // enable IEEE 802.1 Qbu frame preemption - hasGptp = default(hasTimeSynchronization); // enable gPTP protocol - gptp.gptpNodeType = default("BRIDGE_NODE"); // configure gPTP bridge node type - gptp.slavePort = default("eth0"); // configure default gPTP bridge slave port - clock.typename = default(hasTimeSynchronization ? "SettableClock" : ""); // enable explicit local clock model when time synchronization is enabled - ethernet.typename = default("EthernetLayer"); // use Ethernet protocol layer outside of network interfaces - eth[*].typename = default(hasCutthroughSwitching ? "EthernetCutthroughInterface" : "LayeredEthernetInterface"); // switch to modular Ethernet interface + bool hasTimeSynchronization = default(false); // Enable IEEE 802.1 AS time synchronization + bool hasIngressTrafficFiltering = default(false); // Enable IEEE 802.1 Qci ingress per-stream filtering + bool hasEgressTrafficShaping = default(false); // Enable IEEE 802.1 egress traffic shaping (credit based shaping, time aware shaping, asynchronous shaping) + bool hasStreamRedundancy = default(false); // Enable IEEE 802.1 CB frame replication and elimination + bool hasIncomingStreams = default(false); // Enable IEEE 802.1 stream decoding + bool hasOutgoingStreams = default(false); // Enable IEEE 802.1 stream identification and stream encoding + bool hasFramePreemption = default(false); // Enable IEEE 802.1 Qbu frame preemption + hasGptp = default(hasTimeSynchronization); // Enable gPTP protocol + gptp.gptpNodeType = default("BRIDGE_NODE"); // Configure gPTP bridge node type + gptp.slavePort = default("eth0"); // Configure default gPTP bridge slave port + clock.typename = default(hasTimeSynchronization ? "SettableClock" : ""); // Enable explicit local clock model when time synchronization is enabled + ethernet.typename = default("EthernetLayer"); // Use Ethernet protocol layer outside of network interfaces + eth[*].typename = default(hasCutthroughSwitching ? "EthernetCutthroughInterface" : "LayeredEthernetInterface"); // Switch to modular Ethernet interface eth[*].macLayer.typename = default(hasFramePreemption ? "EthernetPreemptingMacLayer" : "EthernetMacLayer"); - eth[*].macLayer.queue.typename = default(hasEgressTrafficShaping ? "Ieee8021qTimeAwareShaper" : "PacketQueue"); // use compound priority queue having multiple subqueues controlled by separate gates when egress traffic shaping is enabled - eth[*].phyLayer.typename = default(hasCutthroughSwitching ? "EthernetStreamThroughPhyLayer" : (hasFramePreemption ? "EthernetPreemptingPhyLayer" : "EthernetPhyLayer")); // use packet streaming when cut-through switching is enabled - bridging.typename = default("BridgingLayer"); // switch to modular bridging - bridging.directionReverser.cutthroughBarrier.typename = default(hasCutthroughSwitching ? "EthernetCutthroughBarrier" : ""); // enable cut-through barrier when cut-through switching is enabled - bridging.streamIdentifier.typename = default(hasOutgoingStreams || hasStreamRedundancy ? "StreamIdentifierLayer" : ""); // enable stream identification when stream redundancy is enabled - bridging.streamRelay.typename = default(hasStreamRedundancy ? "StreamRelayLayer" : ""); // enable stream merging and stream splitting when stream redundancy is enabled - bridging.streamFilter.typename = default(hasIngressTrafficFiltering ? "StreamFilterLayer" : ""); // enable stream filtering when ingress per-stream filtering is enabled - bridging.streamFilter.ingress.typename = default(hasIngressTrafficFiltering ? "SimpleIeee8021qFilter" : ""); // use 802.1 Qci ingress filtering when ingress per-stream filtering is enabled - bridging.streamCoder.typename = default(hasIncomingStreams || hasOutgoingStreams || hasIngressTrafficFiltering || hasStreamRedundancy ? "StreamCoderLayer" : ""); // enable stream endocing/decoding when stream redundancy is enabled - bridging.interfaceRelay.learner.typename = default(hasIncomingStreams || hasOutgoingStreams ? "" : "RelayInterfaceLearner"); // disable learning MAC addresses in the MAC forwarding table because it would change static TSN stream configuration + eth[*].macLayer.queue.typename = default(hasEgressTrafficShaping ? "Ieee8021qTimeAwareShaper" : "PacketQueue"); // Use compound priority queue having multiple subqueues controlled by separate gates when egress traffic shaping is enabled + eth[*].phyLayer.typename = default(hasCutthroughSwitching ? "EthernetStreamThroughPhyLayer" : (hasFramePreemption ? "EthernetPreemptingPhyLayer" : "EthernetPhyLayer")); // Use packet streaming when cut-through switching is enabled + bridging.typename = default("BridgingLayer"); // Switch to modular bridging + bridging.directionReverser.cutthroughBarrier.typename = default(hasCutthroughSwitching ? "EthernetCutthroughBarrier" : ""); // Enable cut-through barrier when cut-through switching is enabled + bridging.streamIdentifier.typename = default(hasOutgoingStreams || hasStreamRedundancy ? "StreamIdentifierLayer" : ""); // Enable stream identification when stream redundancy is enabled + bridging.streamRelay.typename = default(hasStreamRedundancy ? "StreamRelayLayer" : ""); // Enable stream merging and stream splitting when stream redundancy is enabled + bridging.streamFilter.typename = default(hasIngressTrafficFiltering ? "StreamFilterLayer" : ""); // Enable stream filtering when ingress per-stream filtering is enabled + bridging.streamFilter.ingress.typename = default(hasIngressTrafficFiltering ? "SimpleIeee8021qFilter" : ""); // Use 802.1 Qci ingress filtering when ingress per-stream filtering is enabled + bridging.streamCoder.typename = default(hasIncomingStreams || hasOutgoingStreams || hasIngressTrafficFiltering || hasStreamRedundancy ? "StreamCoderLayer" : ""); // Enable stream endocing/decoding when stream redundancy is enabled + bridging.interfaceRelay.learner.typename = default(hasIncomingStreams || hasOutgoingStreams ? "" : "RelayInterfaceLearner"); // Disable learning MAC addresses in the MAC forwarding table because it would change static TSN stream configuration ieee8021q.typename = default("Ieee8021qProtocol"); ieee8021r.typename = default("Ieee8021rProtocol"); } diff --git a/src/inet/node/wireless/AccessPoint.ned b/src/inet/node/wireless/AccessPoint.ned index f7d0149e9fd..847427e26da 100644 --- a/src/inet/node/wireless/AccessPoint.ned +++ b/src/inet/node/wireless/AccessPoint.ned @@ -38,7 +38,7 @@ module AccessPoint @networkNode(); @labels(node,ethernet-node,wireless-node); @display("i=device/accesspoint"); - int numWlanInterfaces = default(1); // the number of radios in the access point + int numWlanInterfaces = default(1); // The number of radios in the access point bool hasStatus = default(false); string fcsMode @enum("declared","computed") = default("declared"); wlan[*].protocol = default("ethernetmac"); diff --git a/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned b/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned index b1591b30bff..6a6dc60e0e0 100644 --- a/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned +++ b/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned @@ -42,10 +42,10 @@ module ApskLayeredTransmitter like ITransmitter { parameters: string levelOfDetail @enum("packet", "bit", "symbol", "sample") = default("symbol"); - double bitrate @unit(bps); // net bitrate of the transmitter - double power @unit(W); // scalar transmission power for the whole signal duration - double centerFrequency @unit(Hz); // center frequency of the narrowband carrier signal - double bandwidth @unit(Hz); // bandwidth + double bitrate @unit(bps); // Net bitrate of the transmitter + double power @unit(W); // Scalar transmission power for the whole signal duration + double centerFrequency @unit(Hz); // Center frequency of the narrowband carrier signal + double bandwidth @unit(Hz); // Bandwidth double preambleDuration @unit(s) = default(0s); @display("i=block/wtx"); @class(ApskLayeredTransmitter); diff --git a/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalMediumAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalMediumAnalogModel.ned index 9b202ad66af..d4a2eddd1ad 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalMediumAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalMediumAnalogModel.ned @@ -16,7 +16,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IMediumAnalogMode module DimensionalMediumAnalogModel like IMediumAnalogModel { parameters: - bool attenuateWithCenterFrequency = default(true); // true means frequency selectivity will always use the carrier frequencey as opposed to using the frequency where the change in power occurs + bool attenuateWithCenterFrequency = default(true); // True means frequency selectivity will always use the carrier frequencey as opposed to using the frequency where the change in power occurs @display("i=block/tunnel"); @class(DimensionalMediumAnalogModel); } diff --git a/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalReceiverAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalReceiverAnalogModel.ned index 667e302a6c6..6a0c6e67acd 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalReceiverAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalReceiverAnalogModel.ned @@ -14,6 +14,6 @@ simple DimensionalReceiverAnalogModel like IReceiverAnalogModel parameters: double defaultCenterFrequency @unit(Hz) = default(nan Hz); double defaultBandwidth @unit(Hz) = default(nan Hz); - double defaultSensitivity @unit(dBm) = default(nan dBm); // reception is not possible if the signal power is below sensitivity (idle or busy states) + double defaultSensitivity @unit(dBm) = default(nan dBm); // Reception is not possible if the signal power is below sensitivity (idle or busy states) @display("i=block/tunnel"); } diff --git a/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalTransmitterAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalTransmitterAnalogModel.ned index 65595b3a62f..40718d2b1a5 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalTransmitterAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalTransmitterAnalogModel.ned @@ -12,14 +12,14 @@ import inet.physicallayer.wireless.common.contract.packetlevel.ITransmitterAnalo module DimensionalTransmitterAnalogModel like ITransmitterAnalogModel { parameters: - double power @unit(W) = default(nan Hz); // default transmission power - double centerFrequency @unit(Hz) = default(nan Hz); // default center frequency - double bandwidth @unit(Hz) = default(nan Hz); // default bandwidth - int gainFunctionCacheLimit = default(0); // limits the number of gain functions cached for a given duration, centerFrequency and bandwidth - string timeGains = default("left s 0dB either e 0dB right"); // sequence of interpolation method, time, gain tuples; time can be an expression, gain is in [dB] or [0..inf); default value is a flat signal - string timeGainsNormalization @enum("","maximum","integral") = default(""); // determines how the time gains function is normalized, no normalization by default - string frequencyGains = default("left s 0dB either e 0dB right"); // sequence of interpolation method, frequency, gain tuples; frequency can be an expression, gain is in [dB] or [0..1]; default value is a flat signal - string frequencyGainsNormalization @enum("","maximum","integral") = default("integral"); // determines how the frequency gains function is normalized, integral normalization by default + double power @unit(W) = default(nan Hz); // Default transmission power + double centerFrequency @unit(Hz) = default(nan Hz); // Default center frequency + double bandwidth @unit(Hz) = default(nan Hz); // Default bandwidth + int gainFunctionCacheLimit = default(0); // Limits the number of gain functions cached for a given duration, centerFrequency and bandwidth + string timeGains = default("left s 0dB either e 0dB right"); // Sequence of interpolation method, time, gain tuples; time can be an expression, gain is in [dB] or [0..inf); default value is a flat signal + string timeGainsNormalization @enum("","maximum","integral") = default(""); // Determines how the time gains function is normalized, no normalization by default + string frequencyGains = default("left s 0dB either e 0dB right"); // Sequence of interpolation method, frequency, gain tuples; frequency can be an expression, gain is in [dB] or [0..1]; default value is a flat signal + string frequencyGainsNormalization @enum("","maximum","integral") = default("integral"); // Determines how the frequency gains function is normalized, integral normalization by default @class(DimensionalTransmitterAnalogModel); @display("i=block/tunnel"); } diff --git a/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarMediumAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarMediumAnalogModel.ned index fb355a6095c..f9e28c88f45 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarMediumAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarMediumAnalogModel.ned @@ -17,7 +17,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IMediumAnalogMode module ScalarMediumAnalogModel like IMediumAnalogModel { parameters: - bool ignorePartialInterference = default(false); // enabled means interference only partially overlapping with the signal being received is ignored, otherwise the simulation stops with an error + bool ignorePartialInterference = default(false); // Enabled means interference only partially overlapping with the signal being received is ignored, otherwise the simulation stops with an error @display("i=block/tunnel"); @class(ScalarMediumAnalogModel); } diff --git a/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarReceiverAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarReceiverAnalogModel.ned index 4663e16b2e3..de7bc91a6de 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarReceiverAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarReceiverAnalogModel.ned @@ -14,6 +14,6 @@ simple ScalarReceiverAnalogModel like IReceiverAnalogModel parameters: double defaultCenterFrequency @unit(Hz) = default(nan Hz); double defaultBandwidth @unit(Hz) = default(nan Hz); - double defaultSensitivity @unit(dBm) = default(nan dBm); // reception is not possible if the signal power is below sensitivity (idle or busy states) + double defaultSensitivity @unit(dBm) = default(nan dBm); // Reception is not possible if the signal power is below sensitivity (idle or busy states) @display("i=block/tunnel"); } diff --git a/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarTransmitterAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarTransmitterAnalogModel.ned index 1b9f715db7b..0dd055933ab 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarTransmitterAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/scalar/ScalarTransmitterAnalogModel.ned @@ -12,9 +12,9 @@ import inet.physicallayer.wireless.common.contract.packetlevel.ITransmitterAnalo module ScalarTransmitterAnalogModel like ITransmitterAnalogModel { parameters: - double power @unit(W) = default(nan W); // default power - double centerFrequency @unit(Hz) = default(nan Hz); // default center frequency - double bandwidth @unit(Hz) = default(nan Hz); // default bandwidth + double power @unit(W) = default(nan W); // Default power + double centerFrequency @unit(Hz) = default(nan Hz); // Default center frequency + double bandwidth @unit(Hz) = default(nan Hz); // Default bandwidth @class(ScalarTransmitterAnalogModel); @display("i=block/tunnel"); } diff --git a/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskReceiverAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskReceiverAnalogModel.ned index 52c70c18018..5e0d1d441ee 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskReceiverAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskReceiverAnalogModel.ned @@ -15,6 +15,6 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IReceiverAnalogMo simple UnitDiskReceiverAnalogModel like IReceiverAnalogModel { parameters: - bool ignoreInterference = default(false); // true means interfering transmissions are ignored when determining whether a reception is successful or not + bool ignoreInterference = default(false); // True means interfering transmissions are ignored when determining whether a reception is successful or not @display("i=block/tunnel"); } diff --git a/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskTransmitterAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskTransmitterAnalogModel.ned index cee73aebee3..1bbd954d2ff 100644 --- a/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskTransmitterAnalogModel.ned +++ b/src/inet/physicallayer/wireless/common/analogmodel/unitdisk/UnitDiskTransmitterAnalogModel.ned @@ -18,9 +18,9 @@ import inet.physicallayer.wireless.common.contract.packetlevel.ITransmitterAnalo module UnitDiskTransmitterAnalogModel like ITransmitterAnalogModel { parameters: - double communicationRange @unit(m); // the range where the reception of transmissions produced by this transmitter is possible - double interferenceRange @unit(m) = default(communicationRange); // the range where transmissions produced by this transmitter interfere with other transmissions - double detectionRange @unit(m) = default(interferenceRange); // the range where transmissions produced by this transmitter can be detected at all + double communicationRange @unit(m); // The range where the reception of transmissions produced by this transmitter is possible + double interferenceRange @unit(m) = default(communicationRange); // The range where transmissions produced by this transmitter interfere with other transmissions + double detectionRange @unit(m) = default(interferenceRange); // The range where transmissions produced by this transmitter can be detected at all @class(UnitDiskTransmitterAnalogModel); @display("i=block/tunnel"); } diff --git a/src/inet/physicallayer/wireless/common/antenna/AxiallySymmetricAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/AxiallySymmetricAntenna.ned index c5d48c80c4e..6f9cc758557 100644 --- a/src/inet/physicallayer/wireless/common/antenna/AxiallySymmetricAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/AxiallySymmetricAntenna.ned @@ -17,8 +17,8 @@ module AxiallySymmetricAntenna extends AntennaBase { parameters: double baseGain @unit(dB) = default(0dB); - string gains = default("0 0"); // sequence of angle [degree] in the range (0, 180) and gain [dB] pairs - string axisOfSymmetry = default("x"); // allows matching the antenna radiation pattern (IAntennaGain) to the visual representation, antenna orientation is determined by the antenna's mobility model + string gains = default("0 0"); // Sequence of angle [degree] in the range (0, 180) and gain [dB] pairs + string axisOfSymmetry = default("x"); // Allows matching the antenna radiation pattern (IAntennaGain) to the visual representation, antenna orientation is determined by the antenna's mobility model @class(AxiallySymmetricAntenna); } diff --git a/src/inet/physicallayer/wireless/common/antenna/ConstantGainAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/ConstantGainAntenna.ned index 5fc3b81dbfb..cfd204c3c3e 100644 --- a/src/inet/physicallayer/wireless/common/antenna/ConstantGainAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/ConstantGainAntenna.ned @@ -16,7 +16,7 @@ import inet.physicallayer.wireless.common.base.packetlevel.AntennaBase; module ConstantGainAntenna extends AntennaBase { parameters: - double gain @unit(dB); // antenna gain indepent of transmission or reception direction + double gain @unit(dB); // Antenna gain indepent of transmission or reception direction @class(ConstantGainAntenna); } diff --git a/src/inet/physicallayer/wireless/common/antenna/CosineAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/CosineAntenna.ned index 1965cb19181..068659a5f27 100644 --- a/src/inet/physicallayer/wireless/common/antenna/CosineAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/CosineAntenna.ned @@ -27,7 +27,7 @@ import inet.physicallayer.wireless.common.base.packetlevel.AntennaBase; module CosineAntenna extends AntennaBase { parameters: - double maxGain @unit(dB); // gain at the antenna boresight + double maxGain @unit(dB); // Gain at the antenna boresight double beamWidth @unit(deg); // 3dB beam width @class(CosineAntenna); } diff --git a/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned index 16658063dff..f1b6b263993 100644 --- a/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned @@ -17,8 +17,8 @@ import inet.physicallayer.wireless.common.base.packetlevel.AntennaBase; module DipoleAntenna extends AntennaBase { parameters: - double length @unit(m); // the length of the dipole antenna - string wireAxis = default("z"); // allows matching the antenna radiation pattern (IAntennaGain) to the visual representation, antenna orientation is determined by the antenna's mobility model + double length @unit(m); // The length of the dipole antenna + string wireAxis = default("z"); // Allows matching the antenna radiation pattern (IAntennaGain) to the visual representation, antenna orientation is determined by the antenna's mobility model // the default value is Z axis, so that antenna mobility models are not required when antennas are approximately positioned in the same plane @class(DipoleAntenna); } diff --git a/src/inet/physicallayer/wireless/common/antenna/InterpolatingAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/InterpolatingAntenna.ned index abced5ed7fc..9a59cbdf8ef 100644 --- a/src/inet/physicallayer/wireless/common/antenna/InterpolatingAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/InterpolatingAntenna.ned @@ -21,9 +21,9 @@ import inet.physicallayer.wireless.common.base.packetlevel.AntennaBase; module InterpolatingAntenna extends AntennaBase { parameters: - string headingGains = default("0 0"); // sequence of angle [degree] and gain [dB] pairs - string elevationGains = default("0 0"); // sequence of angle [degree] and gain [dB] pairs - string bankGains = default("0 0"); // sequence of angle [degree] and gain [dB] pairs + string headingGains = default("0 0"); // Sequence of angle [degree] and gain [dB] pairs + string elevationGains = default("0 0"); // Sequence of angle [degree] and gain [dB] pairs + string bankGains = default("0 0"); // Sequence of angle [degree] and gain [dB] pairs @class(InterpolatingAntenna); } diff --git a/src/inet/physicallayer/wireless/common/antenna/ParabolicAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/ParabolicAntenna.ned index 32e7fafca54..0fdc2166da1 100644 --- a/src/inet/physicallayer/wireless/common/antenna/ParabolicAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/ParabolicAntenna.ned @@ -21,8 +21,8 @@ import inet.physicallayer.wireless.common.base.packetlevel.AntennaBase; module ParabolicAntenna extends AntennaBase { parameters: - double maxGain @unit(dB); // maximum gain of the antenna radiation pattern - double minGain @unit(dB); // minimum gain of the antenna radiation pattern + double maxGain @unit(dB); // Maximum gain of the antenna radiation pattern + double minGain @unit(dB); // Minimum gain of the antenna radiation pattern double beamWidth @unit(deg); // 3dB beam width @class(ParabolicAntenna); } diff --git a/src/inet/physicallayer/wireless/common/backgroundnoise/DimensionalBackgroundNoise.ned b/src/inet/physicallayer/wireless/common/backgroundnoise/DimensionalBackgroundNoise.ned index ad140196137..0e0234e9885 100644 --- a/src/inet/physicallayer/wireless/common/backgroundnoise/DimensionalBackgroundNoise.ned +++ b/src/inet/physicallayer/wireless/common/backgroundnoise/DimensionalBackgroundNoise.ned @@ -12,12 +12,12 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IBackgroundNoise; module DimensionalBackgroundNoise like IBackgroundNoise { parameters: - int gainFunctionCacheLimit = default(0); // limits the number of gain functions cached for a given duration, centerFrequency and bandwidth - string timeGains = default("left 0s 0dB left"); // sequence of interpolation method, time, gain tuples; time can be an expression, gain is in [dB] or [0..inf); default value is a flat signal - string timeGainsNormalization @enum("", "maximum", "integral") = default(""); // determines how the time gains function is normalized, no normalization by default - string frequencyGains = default("left 0Hz 0dB left"); // sequence of interpolation method, frequency, gain tuples; frequency can be an expression, gain is in [dB] or [0..1]; default value is a flat signal - string frequencyGainsNormalization @enum("", "maximum", "integral") = default("integral"); // determines how the frequency gains function is normalized, integral normalization by default - double power @unit(dBm); // noise power + int gainFunctionCacheLimit = default(0); // Limits the number of gain functions cached for a given duration, centerFrequency and bandwidth + string timeGains = default("left 0s 0dB left"); // Sequence of interpolation method, time, gain tuples; time can be an expression, gain is in [dB] or [0..inf); default value is a flat signal + string timeGainsNormalization @enum("", "maximum", "integral") = default(""); // Determines how the time gains function is normalized, no normalization by default + string frequencyGains = default("left 0Hz 0dB left"); // Sequence of interpolation method, frequency, gain tuples; frequency can be an expression, gain is in [dB] or [0..1]; default value is a flat signal + string frequencyGainsNormalization @enum("", "maximum", "integral") = default("integral"); // Determines how the frequency gains function is normalized, integral normalization by default + double power @unit(dBm); // Noise power @class(DimensionalBackgroundNoise); @display("i=block/mac"); } diff --git a/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicDimensionalBackgroundNoise.ned b/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicDimensionalBackgroundNoise.ned index b5595e0127a..561da143045 100644 --- a/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicDimensionalBackgroundNoise.ned +++ b/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicDimensionalBackgroundNoise.ned @@ -17,9 +17,9 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IBackgroundNoise; module IsotropicDimensionalBackgroundNoise like IBackgroundNoise { parameters: - double powerSpectralDensity @unit(dBmWpMHz) = default(nan dBmWpMHz); // when specified, the power and bandwidth parameters are not used - double power @unit(dBm) = default(nan dBm); // when specified, the bandwidth can be determined automatically by matching the signal's bandwidth - double bandwidth @unit(Hz) = default(nan Hz); // determined automatically if the value is NaN, otherwise must match the signal's bandwidth + double powerSpectralDensity @unit(dBmWpMHz) = default(nan dBmWpMHz); // When specified, the power and bandwidth parameters are not used + double power @unit(dBm) = default(nan dBm); // When specified, the bandwidth can be determined automatically by matching the signal's bandwidth + double bandwidth @unit(Hz) = default(nan Hz); // Determined automatically if the value is NaN, otherwise must match the signal's bandwidth @class(IsotropicDimensionalBackgroundNoise); @display("i=block/mac"); } diff --git a/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicScalarBackgroundNoise.ned b/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicScalarBackgroundNoise.ned index abb050edf5d..4b0ff654be4 100644 --- a/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicScalarBackgroundNoise.ned +++ b/src/inet/physicallayer/wireless/common/backgroundnoise/IsotropicScalarBackgroundNoise.ned @@ -17,7 +17,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IBackgroundNoise; module IsotropicScalarBackgroundNoise like IBackgroundNoise { parameters: - double power @unit(dBm); // noise power + double power @unit(dBm); // Noise power double bandwidth @unit(Hz) = default(nan Hz); @class(IsotropicScalarBackgroundNoise); @display("i=block/mac"); diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/AntennaBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/AntennaBase.ned index 0d581c385c7..062083ad2f8 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/AntennaBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/AntennaBase.ned @@ -16,9 +16,9 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IAntenna; module AntennaBase like IAntenna { parameters: - string mobilityModule; // the path to the mobility module relative to this module, only used if no mobility submodule is present - int numAntennas = default(1); // the number of antennas in the antenna array - mobility.subjectModule = default(""); // disable subject module of mobility submodule by default + string mobilityModule; // The path to the mobility module relative to this module, only used if no mobility submodule is present + int numAntennas = default(1); // The number of antennas in the antenna array + mobility.subjectModule = default(""); // Disable subject module of mobility submodule by default @display("i=device/antennatower"); submodules: mobility: like IMobility if typename != "" { diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/DimensionalTransmitterBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/DimensionalTransmitterBase.ned index 66fa2d421c4..898465040bc 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/DimensionalTransmitterBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/DimensionalTransmitterBase.ned @@ -26,11 +26,11 @@ package inet.physicallayer.wireless.common.base.packetlevel; module DimensionalTransmitterBase extends NarrowbandTransmitterBase { parameters: - int gainFunctionCacheLimit = default(0); // limits the number of gain functions cached for a given duration, centerFrequency and bandwidth - string timeGains = default("left s 0dB either e 0dB right"); // sequence of interpolation method, time, gain tuples; time can be an expression, gain is in [dB] or [0..inf); default value is a flat signal - string timeGainsNormalization @enum("","maximum","integral") = default(""); // determines how the time gains function is normalized, no normalization by default - string frequencyGains = default("left s 0dB either e 0dB right"); // sequence of interpolation method, frequency, gain tuples; frequency can be an expression, gain is in [dB] or [0..1]; default value is a flat signal - string frequencyGainsNormalization @enum("","maximum","integral") = default("integral"); // determines how the frequency gains function is normalized, integral normalization by default + int gainFunctionCacheLimit = default(0); // Limits the number of gain functions cached for a given duration, centerFrequency and bandwidth + string timeGains = default("left s 0dB either e 0dB right"); // Sequence of interpolation method, time, gain tuples; time can be an expression, gain is in [dB] or [0..inf); default value is a flat signal + string timeGainsNormalization @enum("","maximum","integral") = default(""); // Determines how the time gains function is normalized, no normalization by default + string frequencyGains = default("left s 0dB either e 0dB right"); // Sequence of interpolation method, frequency, gain tuples; frequency can be an expression, gain is in [dB] or [0..1]; default value is a flat signal + string frequencyGainsNormalization @enum("","maximum","integral") = default("integral"); // Determines how the frequency gains function is normalized, integral normalization by default modulation = default("BPSK"); @class(DimensionalTransmitterBase); } diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned index 7ddae0aa7f2..8cf14ca6d2f 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned @@ -17,7 +17,7 @@ module ErrorModelBase like IErrorModel parameters: string corruptionMode @enum("packet", "chunk", "byte", "bit") = default("packet"); string snirMode @enum("min", "mean") = default("min"); - double snirOffset @unit(dB) = default(0dB); // offset the calculated SNIR before further computing the PER, BER, SER or corrupt bits and symbols + double snirOffset @unit(dB) = default(0dB); // Offset the calculated SNIR before further computing the PER, BER, SER or corrupt bits and symbols // this can be used, for example, to represents cross symbol interference due to OFDM lobe overlapping, symbol frequency/time offset mismatch, and symbol frequency/time size mismatch @display("i=block/broadcast"); @class(ErrorModelBase); diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandRadioBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandRadioBase.ned index c60c4b3eab7..ae7b0e4aa5a 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandRadioBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandRadioBase.ned @@ -15,9 +15,9 @@ import inet.physicallayer.wireless.common.radio.packetlevel.Radio; module NarrowbandRadioBase extends Radio { parameters: - double centerFrequency @unit(Hz); // center frequency of the band where the radio transmits and receives signals on the medium - double bandwidth @unit(Hz); // bandwidth of the band where the radio transmits and receives signals on the medium - *.centerFrequency = default(this.centerFrequency); // passed down to transmitter and receiver by default - *.bandwidth = default(this.bandwidth); // passed down to transmitter and receiver by default + double centerFrequency @unit(Hz); // Center frequency of the band where the radio transmits and receives signals on the medium + double bandwidth @unit(Hz); // Bandwidth of the band where the radio transmits and receives signals on the medium + *.centerFrequency = default(this.centerFrequency); // Passed down to transmitter and receiver by default + *.bandwidth = default(this.bandwidth); // Passed down to transmitter and receiver by default } diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandReceiverBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandReceiverBase.ned index a3b0d1d8617..8f22154eb89 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandReceiverBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandReceiverBase.ned @@ -16,11 +16,11 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IReceiver; module NarrowbandReceiverBase extends SnirReceiverBase like IReceiver { parameters: - double energyDetection @unit(dBm); // no signal is detected at all below this reception power threshold (idle state) - double sensitivity @unit(dBm); // reception is not possible if the signal power is below sensitivity (idle or busy states) - double centerFrequency @unit(Hz); // center frequency of the band where this receiver listens on the medium - double bandwidth @unit(Hz); // bandwidth of the band where this receiver listens on the medium - string modulation; // one of "BPSK", "16-QAM", "256-QAM" + double energyDetection @unit(dBm); // No signal is detected at all below this reception power threshold (idle state) + double sensitivity @unit(dBm); // Reception is not possible if the signal power is below sensitivity (idle or busy states) + double centerFrequency @unit(Hz); // Center frequency of the band where this receiver listens on the medium + double bandwidth @unit(Hz); // Bandwidth of the band where this receiver listens on the medium + string modulation; // One of "BPSK", "16-QAM", "256-QAM" analogModel.defaultSensitivity = default(this.sensitivity); analogModel.defaultCenterFrequency = default(this.centerFrequency); analogModel.defaultBandwidth = default(this.bandwidth); diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandTransmitterBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandTransmitterBase.ned index e25e43dba17..5ab78860db2 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandTransmitterBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/NarrowbandTransmitterBase.ned @@ -15,12 +15,12 @@ import inet.physicallayer.wireless.common.contract.packetlevel.ITransmitter; module NarrowbandTransmitterBase extends TransmitterBase like ITransmitter { parameters: - double preambleDuration @unit(s); // preamble duration - int headerLength @unit(b); // number of header bits added to the length of the MAC frame - double bitrate @unit(bps); // the bitrate of the transmitter is used to compute the duration of the transmission - double power @unit(W); // transmission power - double centerFrequency @unit(Hz); // center frequency of the band where the transmitter transmits on the medium - double bandwidth @unit(Hz); // bandwidth of the band where the transmitter transmits on the medium + double preambleDuration @unit(s); // Preamble duration + int headerLength @unit(b); // Number of header bits added to the length of the MAC frame + double bitrate @unit(bps); // The bitrate of the transmitter is used to compute the duration of the transmission + double power @unit(W); // Transmission power + double centerFrequency @unit(Hz); // Center frequency of the band where the transmitter transmits on the medium + double bandwidth @unit(Hz); // Bandwidth of the band where the transmitter transmits on the medium double codeRate = default(1); string modulation; // "BPSK", "16-QAM", "256-QAM" analogModel.power = default(this.power); diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/PropagationBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/PropagationBase.ned index 2f8c0f8ca66..9e33a4d5e11 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/PropagationBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/PropagationBase.ned @@ -15,7 +15,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IPropagation; module PropagationBase like IPropagation { parameters: - double propagationSpeed @unit(mps) = default(299792458mps); // the theoretical propagation speed of signals on the medium (used by path loss models) + double propagationSpeed @unit(mps) = default(299792458mps); // The theoretical propagation speed of signals on the medium (used by path loss models) @display("i=block/timer"); } diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/ReceiverBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/ReceiverBase.ned index d2f7bbbecd6..0dc3bf75c7b 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/ReceiverBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/ReceiverBase.ned @@ -12,7 +12,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IReceiverAnalogMo module ReceiverBase { parameters: - bool ignoreInterference = default(false); // true means interfering transmissions are ignored when determining whether a reception is successful or not + bool ignoreInterference = default(false); // True means interfering transmissions are ignored when determining whether a reception is successful or not string signalAnalogRepresentation @enum("unitDisk","scalar","dimensional") = default("scalar"); analogModel.typename = default(signalAnalogRepresentation == "unitDisk" ? "UnitDiskReceiverAnalogModel" : signalAnalogRepresentation == "scalar" ? "ScalarReceiverAnalogModel" : "DimensionalReceiverAnalogModel"); @display("i=block/tx"); diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/SnirReceiverBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/SnirReceiverBase.ned index a2989afa1e1..5d9a85eb77b 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/SnirReceiverBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/SnirReceiverBase.ned @@ -15,7 +15,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IReceiver; module SnirReceiverBase extends ReceiverBase like IReceiver { parameters: - double snirThreshold @unit(dB); // reception is not successful if the SNIR is below this threshold (unsuccessful reception) + double snirThreshold @unit(dB); // Reception is not successful if the SNIR is below this threshold (unsuccessful reception) string snirThresholdMode @enum("min","mean") = default("min"); @display("i=block/wrx"); } diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/TracingObstacleLossBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/TracingObstacleLossBase.ned index d273e4f6f2b..142ae3a1056 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/TracingObstacleLossBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/TracingObstacleLossBase.ned @@ -15,7 +15,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IObstacleLoss; module TracingObstacleLossBase like IObstacleLoss { parameters: - string physicalEnvironmentModule = default("physicalEnvironment"); // module path of the physical environment model + string physicalEnvironmentModule = default("physicalEnvironment"); // Module path of the physical environment model @display("i=block/control"); @signal[obstaclePenetrated]; } diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/TransmitterBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/TransmitterBase.ned index f15abc28d75..d2aa6ddf2b9 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/TransmitterBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/TransmitterBase.ned @@ -12,7 +12,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.ITransmitterAnalo module TransmitterBase { parameters: - string signalAnalogRepresentation @enum("unitDisk","scalar","dimensional") = default("scalar"); // determines the analog domain signal representation of transmissions + string signalAnalogRepresentation @enum("unitDisk","scalar","dimensional") = default("scalar"); // Determines the analog domain signal representation of transmissions analogModel.typename = default(signalAnalogRepresentation == "unitDisk" ? "UnitDiskTransmitterAnalogModel" : signalAnalogRepresentation == "scalar" ? "ScalarTransmitterAnalogModel" : "DimensionalTransmitterAnalogModel"); @display("i=block/tx"); submodules: diff --git a/src/inet/physicallayer/wireless/common/contract/packetlevel/IRadio.ned b/src/inet/physicallayer/wireless/common/contract/packetlevel/IRadio.ned index 7a638440f27..1dea6efee70 100644 --- a/src/inet/physicallayer/wireless/common/contract/packetlevel/IRadio.ned +++ b/src/inet/physicallayer/wireless/common/contract/packetlevel/IRadio.ned @@ -36,17 +36,17 @@ moduleinterface IRadio extends IPhysicalLayer { parameters: @display("i=block/wrxtx"); - @signal[radioModeChanged](type=long); // type=inet::physicallayer::RadioMode + @signal[radioModeChanged](type=long); // Type=inet::physicallayer::RadioMode @signal[listeningChanged](type=long); //TODO always emit 0 - @signal[receptionStateChanged](type=long); // type=inet::physicallayer::ReceptionState - @signal[transmissionStateChanged](type=long); // type=inet::physicallayer::TransmissionState - @signal[radioChannelChanged](type=long); // the long is the new channel number - @signal[receivedSignalPartChanged](type=long); // type=IRadioSignal::SignalPart - @signal[transmittedSignalPartChanged](type=long); // type=IRadioSignal::SignalPart - @signal[transmissionStarted](type=cObject); // type=ITransmission - @signal[transmissionEnded](type=cObject); // type=ITransmission - @signal[receptionStarted](type=cObject); // type=IReception - @signal[receptionEnded](type=cObject); // type=IReception + @signal[receptionStateChanged](type=long); // Type=inet::physicallayer::ReceptionState + @signal[transmissionStateChanged](type=long); // Type=inet::physicallayer::TransmissionState + @signal[radioChannelChanged](type=long); // The long is the new channel number + @signal[receivedSignalPartChanged](type=long); // Type=IRadioSignal::SignalPart + @signal[transmittedSignalPartChanged](type=long); // Type=IRadioSignal::SignalPart + @signal[transmissionStarted](type=cObject); // Type=ITransmission + @signal[transmissionEnded](type=cObject); // Type=ITransmission + @signal[receptionStarted](type=cObject); // Type=IReception + @signal[receptionEnded](type=cObject); // Type=IReception gates: input radioIn @labels(IWirelessSignal); } diff --git a/src/inet/physicallayer/wireless/common/errormodel/packetlevel/StochasticErrorModel.ned b/src/inet/physicallayer/wireless/common/errormodel/packetlevel/StochasticErrorModel.ned index bf4166511c7..d0b4616ac9f 100644 --- a/src/inet/physicallayer/wireless/common/errormodel/packetlevel/StochasticErrorModel.ned +++ b/src/inet/physicallayer/wireless/common/errormodel/packetlevel/StochasticErrorModel.ned @@ -17,9 +17,9 @@ import inet.physicallayer.wireless.common.base.packetlevel.ErrorModelBase; module StochasticErrorModel extends ErrorModelBase { parameters: - double packetErrorRate = default(nan); // a probability in the range [0, 1] or NaN if not set - double bitErrorRate = default(nan); // a probability in the range [0, 1] or NaN if not set - double symbolErrorRate = default(nan); // a probability in the range [0, 1] or NaN if not set + double packetErrorRate = default(nan); // A probability in the range [0, 1] or NaN if not set + double bitErrorRate = default(nan); // A probability in the range [0, 1] or NaN if not set + double symbolErrorRate = default(nan); // A probability in the range [0, 1] or NaN if not set @class(StochasticErrorModel); } diff --git a/src/inet/physicallayer/wireless/common/medium/MediumLimitCache.ned b/src/inet/physicallayer/wireless/common/medium/MediumLimitCache.ned index c0933a9515e..b5bde2d485d 100644 --- a/src/inet/physicallayer/wireless/common/medium/MediumLimitCache.ned +++ b/src/inet/physicallayer/wireless/common/medium/MediumLimitCache.ned @@ -13,15 +13,15 @@ module MediumLimitCache like IMediumLimitCache { parameters: double centerFrequency @unit(Hz) = default(nan Hz); // TODO rename to maxRangeCenterFrequency? - double maxSpeed @unit(mps) = default(nan mps); // maxium speed on the medium, NaN means medium computes using mobility models + double maxSpeed @unit(mps) = default(nan mps); // Maxium speed on the medium, NaN means medium computes using mobility models double maxTransmissionPower @unit(W) = default(nan W); // TODO @unit(W) + dBm/dBW <--> W double minInterferencePower @unit(dBm) = default(nan dBm); // TODO @unit(W) + dBm/dBW <--> W double minReceptionPower @unit(dBm) = default(nan dBm); // TODO @unit(W) + dBm/dBW <--> W - double maxAntennaGain @unit(dB) = default(0dB); // maximum antenna gain on the medium, NaN means medium computes using antenna models - double minInterferenceTime @unit(s) = default(1ps); // minimum time interval to consider two overlapping signals interfering - double maxTransmissionDuration @unit(s) = default(10ms); // maximum duration of a transmission on the medium - double maxCommunicationRange @unit(m) = default(nan m); // maximum communication range on the medium, NaN means medium computes using transmitter and receiver models - double maxInterferenceRange @unit(m) = default(nan m); // maximum interference range on the medium, NaN means medium computes using transmitter and receiver models + double maxAntennaGain @unit(dB) = default(0dB); // Maximum antenna gain on the medium, NaN means medium computes using antenna models + double minInterferenceTime @unit(s) = default(1ps); // Minimum time interval to consider two overlapping signals interfering + double maxTransmissionDuration @unit(s) = default(10ms); // Maximum duration of a transmission on the medium + double maxCommunicationRange @unit(m) = default(nan m); // Maximum communication range on the medium, NaN means medium computes using transmitter and receiver models + double maxInterferenceRange @unit(m) = default(nan m); // Maximum interference range on the medium, NaN means medium computes using transmitter and receiver models @display("i=block/table2"); @class(MediumLimitCache); } diff --git a/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned b/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned index a7217c44215..e9f57f5c3ec 100644 --- a/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned +++ b/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned @@ -27,18 +27,18 @@ import inet.physicallayer.wireless.common.contract.packetlevel.IRadioMedium; module RadioMedium like IRadioMedium { parameters: - string physicalEnvironmentModule = default("physicalEnvironment"); // module path of the physical environment model + string physicalEnvironmentModule = default("physicalEnvironment"); // Module path of the physical environment model string signalAnalogRepresentation @enum("unitDisk","scalar","dimensional") = default("scalar"); // filter parameters that control when signals are sent to receiver radios - string rangeFilter = default(""); // when either set to 'interferenceRange' or 'communicationRange' the radio medium doesn't send signals to a radio if it's outside the provided range - bool radioModeFilter = default(false); // when enabled the radio medium doesn't send signals to a radio if it's neither in receiver nor in transceiver mode - bool listeningFilter = default(false); // when enabled the radio medium doesn't send signals to a radio if it listens on the channel in incompatible mode (e.g. different carrier frequency and bandwidth, different modulation) - bool macAddressFilter = default(false); // when enabled the radio medium doesn't send signals to a radio if it the destination mac address differs + string rangeFilter = default(""); // When either set to 'interferenceRange' or 'communicationRange' the radio medium doesn't send signals to a radio if it's outside the provided range + bool radioModeFilter = default(false); // When enabled the radio medium doesn't send signals to a radio if it's neither in receiver nor in transceiver mode + bool listeningFilter = default(false); // When enabled the radio medium doesn't send signals to a radio if it listens on the channel in incompatible mode (e.g. different carrier frequency and bandwidth, different modulation) + bool macAddressFilter = default(false); // When enabled the radio medium doesn't send signals to a radio if it the destination mac address differs // logging parameters - bool recordTransmissionLog = default(false); // when enabled the medium writes one line per transmission into the communication log file - bool recordReceptionLog = default(false); // when enabled the medium writes one line per reception into the communication log file + bool recordTransmissionLog = default(false); // When enabled the medium writes one line per transmission into the communication log file + bool recordReceptionLog = default(false); // When enabled the medium writes one line per reception into the communication log file @class(RadioMedium); @display("i=misc/sun"); diff --git a/src/inet/physicallayer/wireless/common/neighborcache/GridNeighborCache.ned b/src/inet/physicallayer/wireless/common/neighborcache/GridNeighborCache.ned index ae4566b7af5..300065d1b0d 100644 --- a/src/inet/physicallayer/wireless/common/neighborcache/GridNeighborCache.ned +++ b/src/inet/physicallayer/wireless/common/neighborcache/GridNeighborCache.ned @@ -20,9 +20,9 @@ module GridNeighborCache like INeighborCache double cellSizeX @unit(m) = default(nan m); // NaN means use cell count double cellSizeY @unit(m) = default(nan m); // NaN means use cell count double cellSizeZ @unit(m) = default(nan m); // NaN means use cell count - int cellCountX = default(10); // divide space to so many cells - int cellCountY = default(10); // divide space to so many cells - int cellCountZ = default(10); // divide space to so many cells + int cellCountX = default(10); // Divide space to so many cells + int cellCountY = default(10); // Divide space to so many cells + int cellCountZ = default(10); // Divide space to so many cells double refillPeriod @unit(s) = default(1s); @display("i=block/table2"); @class(GridNeighborCache); diff --git a/src/inet/physicallayer/wireless/common/obstacleloss/DielectricObstacleLoss.ned b/src/inet/physicallayer/wireless/common/obstacleloss/DielectricObstacleLoss.ned index e8b7e823b54..017d3cb00d2 100644 --- a/src/inet/physicallayer/wireless/common/obstacleloss/DielectricObstacleLoss.ned +++ b/src/inet/physicallayer/wireless/common/obstacleloss/DielectricObstacleLoss.ned @@ -18,8 +18,8 @@ import inet.physicallayer.wireless.common.base.packetlevel.TracingObstacleLossBa module DielectricObstacleLoss extends TracingObstacleLossBase { parameters: - bool enableDielectricLoss = default(true); // enables/disables material dielectric loss - bool enableReflectionLoss = default(true); // enables/disables surface reflection loss + bool enableDielectricLoss = default(true); // Enables/disables material dielectric loss + bool enableReflectionLoss = default(true); // Enables/disables surface reflection loss @class(DielectricObstacleLoss); } diff --git a/src/inet/physicallayer/wireless/common/pathloss/TwoRayGroundReflection.ned b/src/inet/physicallayer/wireless/common/pathloss/TwoRayGroundReflection.ned index 728b71bf94a..6864f91bab7 100644 --- a/src/inet/physicallayer/wireless/common/pathloss/TwoRayGroundReflection.ned +++ b/src/inet/physicallayer/wireless/common/pathloss/TwoRayGroundReflection.ned @@ -11,6 +11,6 @@ module TwoRayGroundReflection extends FreeSpacePathLoss { parameters: @class(TwoRayGroundReflection); - string physicalEnvironmentModule = default("physicalEnvironment"); // the path of the environment model relative to the network + string physicalEnvironmentModule = default("physicalEnvironment"); // The path of the environment model relative to the network } diff --git a/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned b/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned index 685db35ce2d..9aa1f4c3a18 100644 --- a/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned +++ b/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned @@ -17,9 +17,9 @@ import inet.physicallayer.wireless.common.base.packetlevel.PropagationBase; module ConstantSpeedPropagation extends PropagationBase { parameters: - bool ignoreMovementDuringTransmission = default(true); // true means that the movement of the transmitter and the receiver during the signal transmission is ignored - bool ignoreMovementDuringPropagation = default(true); // true means that the movement of the transmitter and the receiver during the signal propagation is ignored - bool ignoreMovementDuringReception = default(true); // true means that the movement of the transmitter and the receiver during the signal reception is ignored + bool ignoreMovementDuringTransmission = default(true); // True means that the movement of the transmitter and the receiver during the signal transmission is ignored + bool ignoreMovementDuringPropagation = default(true); // True means that the movement of the transmitter and the receiver during the signal propagation is ignored + bool ignoreMovementDuringReception = default(true); // True means that the movement of the transmitter and the receiver during the signal reception is ignored @class(ConstantSpeedPropagation); } diff --git a/src/inet/physicallayer/wireless/common/propagation/ConstantTimePropagation.ned b/src/inet/physicallayer/wireless/common/propagation/ConstantTimePropagation.ned index b4046c753f9..95eb9cb32d9 100644 --- a/src/inet/physicallayer/wireless/common/propagation/ConstantTimePropagation.ned +++ b/src/inet/physicallayer/wireless/common/propagation/ConstantTimePropagation.ned @@ -17,7 +17,7 @@ import inet.physicallayer.wireless.common.base.packetlevel.PropagationBase; module ConstantTimePropagation extends PropagationBase { parameters: - double propagationTime @unit(s) = default(0s); // the time it takes for a signal to propagate from any transmitter to any receiver + double propagationTime @unit(s) = default(0s); // The time it takes for a signal to propagate from any transmitter to any receiver @class(ConstantTimePropagation); } diff --git a/src/inet/physicallayer/wireless/common/radio/packetlevel/Radio.ned b/src/inet/physicallayer/wireless/common/radio/packetlevel/Radio.ned index 753584d4c08..eb5833e799a 100644 --- a/src/inet/physicallayer/wireless/common/radio/packetlevel/Radio.ned +++ b/src/inet/physicallayer/wireless/common/radio/packetlevel/Radio.ned @@ -42,19 +42,19 @@ import inet.power.contract.IEnergyConsumer; module Radio extends PhysicalLayerBase like IRadio { parameters: - string radioMediumModule = default("radioMedium"); // module path of the medium module where this radio communicates - string energySourceModule = default(""); // module path of the energy source module which provides energy to the radio + string radioMediumModule = default("radioMedium"); // Module path of the medium module where this radio communicates + string energySourceModule = default(""); // Module path of the energy source module which provides energy to the radio string initialRadioMode @enum("off","sleep","receiver","transmitter","transceiver") = default("off"); - string switchingTimes = default("ms 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0"); // time parameters to switch between radio modes + string switchingTimes = default("ms 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0"); // Time parameters to switch between radio modes - bool sendRawBytes = default(false); // when true packets are serialized into a sequence of bytes before sending out + bool sendRawBytes = default(false); // When true packets are serialized into a sequence of bytes before sending out - bool separateTransmissionParts = default(false); // when enabled the transmission of preamble, header and data part are simulated separately - bool separateReceptionParts = default(false); // when enabled the reception of preamble, header and data part are simulated separately + bool separateTransmissionParts = default(false); // When enabled the transmission of preamble, header and data part are simulated separately + bool separateReceptionParts = default(false); // When enabled the reception of preamble, header and data part are simulated separately - bool displayCommunicationRange = default(false); // if true communication range is displayed as a blue circle around the node - bool displayInterferenceRange = default(false); // if true interference range is displayed as a gray circle around the node + bool displayCommunicationRange = default(false); // If true communication range is displayed as a blue circle around the node + bool displayInterferenceRange = default(false); // If true interference range is displayed as a gray circle around the node string signalAnalogRepresentation @enum("unitDisk", "scalar", "dimensional") = default("scalar"); diff --git a/src/inet/physicallayer/wireless/generic/GenericReceiver.ned b/src/inet/physicallayer/wireless/generic/GenericReceiver.ned index a80f4f15f80..b54bb393d94 100644 --- a/src/inet/physicallayer/wireless/generic/GenericReceiver.ned +++ b/src/inet/physicallayer/wireless/generic/GenericReceiver.ned @@ -20,7 +20,7 @@ module GenericReceiver extends SnirReceiverBase like IReceiver parameters: double energyDetection @unit(dBm) = default(-85 dBm); snirThresholdMode = "mean"; - snirThreshold = -100dB; // to match the previous permissive behavior + snirThreshold = -100dB; // To match the previous permissive behavior *.ignoreInterference = default(this.ignoreInterference); @class(GenericReceiver); @display("i=block/wrx"); diff --git a/src/inet/physicallayer/wireless/generic/GenericTransmitter.ned b/src/inet/physicallayer/wireless/generic/GenericTransmitter.ned index 677c8b70345..f03ae1069dd 100644 --- a/src/inet/physicallayer/wireless/generic/GenericTransmitter.ned +++ b/src/inet/physicallayer/wireless/generic/GenericTransmitter.ned @@ -18,9 +18,9 @@ import inet.physicallayer.wireless.common.contract.packetlevel.ITransmitter; module GenericTransmitter extends TransmitterBase like ITransmitter { parameters: - double preambleDuration @unit(s) = default(0s); // preamble added before the PHY header - int headerLength @unit(b) = default(96b); // number of PHY header bits - double bitrate @unit(bps); // the bitrate of the transmitter is used to compute the duration of PHY header and the data part + double preambleDuration @unit(s) = default(0s); // Preamble added before the PHY header + int headerLength @unit(b) = default(96b); // Number of PHY header bits + double bitrate @unit(bps); // The bitrate of the transmitter is used to compute the duration of PHY header and the data part @class(GenericTransmitter); @display("i=block/wtx"); } diff --git a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Radio.ned b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Radio.ned index 8ed9c273ad1..5226f104c0f 100644 --- a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Radio.ned +++ b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Radio.ned @@ -25,20 +25,20 @@ import inet.physicallayer.wireless.common.base.packetlevel.FlatRadioBase; module Ieee80211Radio extends FlatRadioBase { parameters: - string opMode @enum("a", "b", "g(erp)", "g(mixed)", "n(mixed-2.4Ghz)", "p", "ac") = default("g(mixed)"); // operation mode - string bandName @enum("2.4 GHz", "5 GHz", "5 GHz (20 MHz)", "5 GHz (40 MHz)", "5 GHz (80 MHz)", "5 GHz (160 MHz)", "5.9 GHz") = default("2.4 GHz"); // band name - int channelNumber = default(0); // initial channel number within the band (TODO this is offset by 1) + string opMode @enum("a", "b", "g(erp)", "g(mixed)", "n(mixed-2.4Ghz)", "p", "ac") = default("g(mixed)"); // Operation mode + string bandName @enum("2.4 GHz", "5 GHz", "5 GHz (20 MHz)", "5 GHz (40 MHz)", "5 GHz (80 MHz)", "5 GHz (160 MHz)", "5.9 GHz") = default("2.4 GHz"); // Band name + int channelNumber = default(0); // Initial channel number within the band (TODO this is offset by 1) string crcMode @enum("declared","computed") = default("declared"); transmitter.typename = default("Ieee80211Transmitter"); receiver.typename = default("Ieee80211Receiver"); receiver.errorModel.typename = default(signalAnalogRepresentation != "unitDisk" ? "Ieee80211NistErrorModel" : ""); - centerFrequency @unit(Hz) = default(2.412GHz); // the center frequency of the band is automatically set by the radio + centerFrequency @unit(Hz) = default(2.412GHz); // The center frequency of the band is automatically set by the radio bandwidth @unit(Hz) = default(nan MHz); transmitter.preambleDuration = default(-1 s); transmitter.bitrate = default(11Mbps); transmitter.headerLength = default(192b); transmitter.power = default(20mW); - receiver.bandwidth = default(22 MHz); // the highest value + receiver.bandwidth = default(22 MHz); // The highest value receiver.sensitivity = default(-85dBm); receiver.energyDetection = default(-85dBm); receiver.snirThreshold = default(4dB); diff --git a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned index fefe17880d3..9c807092f3e 100644 --- a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned +++ b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned @@ -20,14 +20,14 @@ simple Ieee80211StateBasedCcEnergyConsumer extends StateBasedCcEnergyConsumer parameters: offCurrentConsumption = default(0mA); sleepCurrentConsumption = default(0.01mA); - switchingCurrentConsumption = default(100mA); // tx/rx calibration mode + switchingCurrentConsumption = default(100mA); // Tx/rx calibration mode receiverIdleCurrentConsumption = default(100mA); - receiverBusyCurrentConsumption = default(100mA); // no info yet + receiverBusyCurrentConsumption = default(100mA); // No info yet receiverReceivingCurrentConsumption = default(100mA); receiverReceivingPreambleCurrentConsumption = default(receiverReceivingCurrentConsumption); receiverReceivingHeaderCurrentConsumption = default(receiverReceivingCurrentConsumption); receiverReceivingDataCurrentConsumption = default(receiverReceivingCurrentConsumption); - transmitterIdleCurrentConsumption = default(100mA); // no info yet + transmitterIdleCurrentConsumption = default(100mA); // No info yet transmitterTransmittingCurrentConsumption = default(250mA); transmitterTransmittingPreambleCurrentConsumption = default(transmitterTransmittingCurrentConsumption); transmitterTransmittingHeaderCurrentConsumption = default(transmitterTransmittingCurrentConsumption); diff --git a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedEpEnergyConsumer.ned b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedEpEnergyConsumer.ned index 23846d2f18a..2a1208641de 100644 --- a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedEpEnergyConsumer.ned +++ b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedEpEnergyConsumer.ned @@ -20,14 +20,14 @@ simple Ieee80211StateBasedEpEnergyConsumer extends StateBasedEpEnergyConsumer parameters: offPowerConsumption = default(0mW); sleepPowerConsumption = default(0.05mW); - switchingPowerConsumption = default(100mW); // tx/rx calibration mode + switchingPowerConsumption = default(100mW); // Tx/rx calibration mode receiverIdlePowerConsumption = default(0.5W); - receiverBusyPowerConsumption = default(0.5W); // no info yet + receiverBusyPowerConsumption = default(0.5W); // No info yet receiverReceivingPowerConsumption = default(1W); receiverReceivingPreamblePowerConsumption = default(receiverReceivingPowerConsumption); receiverReceivingHeaderPowerConsumption = default(receiverReceivingPowerConsumption); receiverReceivingDataPowerConsumption = default(receiverReceivingPowerConsumption); - transmitterIdlePowerConsumption = default(1W); // no info yet + transmitterIdlePowerConsumption = default(1W); // No info yet transmitterTransmittingPowerConsumption = default(2.5W); transmitterTransmittingPreamblePowerConsumption = default(transmitterTransmittingPowerConsumption); transmitterTransmittingHeaderPowerConsumption = default(transmitterTransmittingPowerConsumption); diff --git a/src/inet/physicallayer/wireless/noise/NoiseSource.ned b/src/inet/physicallayer/wireless/noise/NoiseSource.ned index fca4e21f5e6..a6e1cfd199a 100644 --- a/src/inet/physicallayer/wireless/noise/NoiseSource.ned +++ b/src/inet/physicallayer/wireless/noise/NoiseSource.ned @@ -15,7 +15,7 @@ import inet.physicallayer.wireless.common.contract.packetlevel.ITransmitter; module NoiseSource like IRadio { parameters: - string radioMediumModule = default("radioMedium"); // module path of the medium module where this radio communicates + string radioMediumModule = default("radioMedium"); // Module path of the medium module where this radio communicates volatile double sleepInterval @unit(s); *.mobilityModule = default(absPath(".mobility")); @networkNode; diff --git a/src/inet/physicallayer/wireless/noise/NoiseTransmitter.ned b/src/inet/physicallayer/wireless/noise/NoiseTransmitter.ned index e31b1a40684..7ff328b3369 100644 --- a/src/inet/physicallayer/wireless/noise/NoiseTransmitter.ned +++ b/src/inet/physicallayer/wireless/noise/NoiseTransmitter.ned @@ -27,7 +27,7 @@ module NoiseTransmitter extends TransmitterBase like ITransmitter volatile double centerFrequency @unit(Hz) = default(nan Hz); volatile double bandwidth @unit(Hz) = default(0Hz); volatile double power @unit(W); - int gainFunctionCacheLimit = default(0); // limits the number of gain functions cached for a given duration, centerFrequency and bandwidth + int gainFunctionCacheLimit = default(0); // Limits the number of gain functions cached for a given duration, centerFrequency and bandwidth @class(NoiseTransmitter); @display("i=block/wtx"); } diff --git a/src/inet/physicallayer/wireless/shortcut/ShortcutRadio.ned b/src/inet/physicallayer/wireless/shortcut/ShortcutRadio.ned index bd2eaa9a529..c2f723a89ae 100644 --- a/src/inet/physicallayer/wireless/shortcut/ShortcutRadio.ned +++ b/src/inet/physicallayer/wireless/shortcut/ShortcutRadio.ned @@ -23,11 +23,11 @@ simple ShortcutRadio extends PhysicalLayerBase like IRadio parameters: string interfaceTableModule; double bitrate @unit(bps); - volatile int lengthOverhead @unit(b) = default(0b); // extra length added to packets - volatile double durationOverhead @unit(s) = default(0s); // extra transmission duration added to packets - volatile double propagationDelay @unit(s) = default(0s); // propagation time to all destinations - volatile double packetLoss = default(0); // packet loss probability + volatile int lengthOverhead @unit(b) = default(0b); // Extra length added to packets + volatile double durationOverhead @unit(s) = default(0s); // Extra transmission duration added to packets + volatile double propagationDelay @unit(s) = default(0s); // Propagation time to all destinations + volatile double packetLoss = default(0); // Packet loss probability @class(ShortcutRadio); - @signal[transmissionStateChanged](type=long); // type=inet::physicallayer::TransmissionState + @signal[transmissionStateChanged](type=long); // Type=inet::physicallayer::TransmissionState } diff --git a/src/inet/power/consumer/AlternatingEpEnergyConsumer.ned b/src/inet/power/consumer/AlternatingEpEnergyConsumer.ned index b25af24b8ea..9ace1d65cbd 100644 --- a/src/inet/power/consumer/AlternatingEpEnergyConsumer.ned +++ b/src/inet/power/consumer/AlternatingEpEnergyConsumer.ned @@ -20,10 +20,10 @@ import inet.power.base.EpEnergyConsumerBase; simple AlternatingEpEnergyConsumer extends EpEnergyConsumerBase { parameters: - string energySourceModule = default("^.energyStorage"); // module path of energy source - volatile double powerConsumption @unit(W); // amount of power consumed in consumption mode - volatile double consumptionInterval @unit(s); // time interval for consumption mode - volatile double sleepInterval @unit(s); // time interval for sleep mode + string energySourceModule = default("^.energyStorage"); // Module path of energy source + volatile double powerConsumption @unit(W); // Amount of power consumed in consumption mode + volatile double consumptionInterval @unit(s); // Time interval for consumption mode + volatile double sleepInterval @unit(s); // Time interval for sleep mode @class(AlternatingEpEnergyConsumer); } diff --git a/src/inet/power/generator/AlternatingEpEnergyGenerator.ned b/src/inet/power/generator/AlternatingEpEnergyGenerator.ned index 4394d81e66e..a63fed892ff 100644 --- a/src/inet/power/generator/AlternatingEpEnergyGenerator.ned +++ b/src/inet/power/generator/AlternatingEpEnergyGenerator.ned @@ -20,10 +20,10 @@ import inet.power.base.EpEnergyGeneratorBase; simple AlternatingEpEnergyGenerator extends EpEnergyGeneratorBase { parameters: - string energySinkModule = default("^.energyStorage"); // module path of energy sink - volatile double powerGeneration @unit(W); // amount of power generated in generation mode - volatile double generationInterval @unit(s); // time interval for generation mode - volatile double sleepInterval @unit(s); // time interval for sleep mode + string energySinkModule = default("^.energyStorage"); // Module path of energy sink + volatile double powerGeneration @unit(W); // Amount of power generated in generation mode + volatile double generationInterval @unit(s); // Time interval for generation mode + volatile double sleepInterval @unit(s); // Time interval for sleep mode @class(AlternatingEpEnergyGenerator); } diff --git a/src/inet/power/management/SimpleEpEnergyManagement.ned b/src/inet/power/management/SimpleEpEnergyManagement.ned index 1488e93efdb..1c141e7ae28 100644 --- a/src/inet/power/management/SimpleEpEnergyManagement.ned +++ b/src/inet/power/management/SimpleEpEnergyManagement.ned @@ -22,8 +22,8 @@ import inet.power.contract.IEpEnergyManagement; simple SimpleEpEnergyManagement like IEpEnergyManagement { parameters: - double nodeShutdownCapacity @unit(J) = default(nan J); // initiates node shutdown when the residual energy capacity decreases below this value - double nodeStartCapacity @unit(J) = default(nan J); // initiates node start when the residual energy capacity increases above this value + double nodeShutdownCapacity @unit(J) = default(nan J); // Initiates node shutdown when the residual energy capacity decreases below this value + double nodeStartCapacity @unit(J) = default(nan J); // Initiates node start when the residual energy capacity increases above this value @class(SimpleEpEnergyManagement); @display("i=block/plug"); } diff --git a/src/inet/power/storage/CcBatteryPack.ned b/src/inet/power/storage/CcBatteryPack.ned index 94c8a3c409e..4ec81b25fca 100644 --- a/src/inet/power/storage/CcBatteryPack.ned +++ b/src/inet/power/storage/CcBatteryPack.ned @@ -12,12 +12,12 @@ import inet.power.storage.SimpleCcBattery; simple CcBatteryPack extends SimpleCcBattery { parameters: - int numberOfCells = default(1); // number of cells in the battery pack + int numberOfCells = default(1); // Number of cells in the battery pack string arrangement @enum("serial", "parallel") = default ("serial"); - double cellNominalCapacity @unit(C) = default(7200 C); // typical capacity of AA battery is 2 Ah = 7200 C + double cellNominalCapacity @unit(C) = default(7200 C); // Typical capacity of AA battery is 2 Ah = 7200 C double cellNominalVoltage @unit(V) = default(1.5 V); double cellInternalResistance @unit(Ohm) = default(0.1 Ohm); - nominalCapacity = default(numberOfCells * cellNominalCapacity); // cell capacities are added when arranged in parallel - nominalVoltage = default(arrangement == "serial" ? numberOfCells * cellNominalVoltage : cellNominalVoltage); // voltage is added when cells arranged in series - internalResistance = default(arrangement == "serial" ? numberOfCells * cellInternalResistance : cellInternalResistance / numberOfCells); // internal resistance is added when cells arranged in series + nominalCapacity = default(numberOfCells * cellNominalCapacity); // Cell capacities are added when arranged in parallel + nominalVoltage = default(arrangement == "serial" ? numberOfCells * cellNominalVoltage : cellNominalVoltage); // Voltage is added when cells arranged in series + internalResistance = default(arrangement == "serial" ? numberOfCells * cellInternalResistance : cellInternalResistance / numberOfCells); // Internal resistance is added when cells arranged in series } diff --git a/src/inet/power/storage/SimpleCcBattery.ned b/src/inet/power/storage/SimpleCcBattery.ned index 16ac62ba04a..97c7c26f27a 100644 --- a/src/inet/power/storage/SimpleCcBattery.ned +++ b/src/inet/power/storage/SimpleCcBattery.ned @@ -20,10 +20,10 @@ import inet.power.base.CcEnergyStorageBase; simple SimpleCcBattery extends CcEnergyStorageBase { parameters: - double nominalCapacity @unit(C); // maximum amount of charge stored - double initialCapacity @unit(C) = default(nominalCapacity); // the initially stored amount of charge - double nominalVoltage @unit(V); // open circuit voltage at maximum charge - double internalResistance @unit(Ohm); // internal resistance + double nominalCapacity @unit(C); // Maximum amount of charge stored + double initialCapacity @unit(C) = default(nominalCapacity); // The initially stored amount of charge + double nominalVoltage @unit(V); // Open circuit voltage at maximum charge + double internalResistance @unit(Ohm); // Internal resistance string displayStringTextFormat = default("%c (%p)"); @class(SimpleCcBattery); } diff --git a/src/inet/power/storage/SimpleEpEnergyStorage.ned b/src/inet/power/storage/SimpleEpEnergyStorage.ned index 9adee9c37e1..34970e4129b 100644 --- a/src/inet/power/storage/SimpleEpEnergyStorage.ned +++ b/src/inet/power/storage/SimpleEpEnergyStorage.ned @@ -22,9 +22,9 @@ import inet.power.base.EpEnergyStorageBase; simple SimpleEpEnergyStorage extends EpEnergyStorageBase { parameters: - double nominalCapacity @unit(J); // the maximum amount of energy stored - double initialCapacity @unit(J) = default(nominalCapacity); // the initially stored amount of energy - double printCapacityStep @unit(J) = default(0.01 * nominalCapacity); // displays residual capacity changes in the log + double nominalCapacity @unit(J); // The maximum amount of energy stored + double initialCapacity @unit(J) = default(nominalCapacity); // The initially stored amount of energy + double printCapacityStep @unit(J) = default(0.01 * nominalCapacity); // Displays residual capacity changes in the log string displayStringTextFormat = default("%c (%p)"); @class(SimpleEpEnergyStorage); } diff --git a/src/inet/protocolelement/common/InterpacketGapInserter.ned b/src/inet/protocolelement/common/InterpacketGapInserter.ned index 1a499a58aed..9101b1bbc71 100644 --- a/src/inet/protocolelement/common/InterpacketGapInserter.ned +++ b/src/inet/protocolelement/common/InterpacketGapInserter.ned @@ -12,8 +12,8 @@ import inet.queueing.base.PacketProcessorBase; simple InterpacketGapInserter extends PacketProcessorBase { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - bool initialChannelBusy = default(false); // assume that channel was busy before the simulation started + string clockModule = default(""); // Relative path of a module that implements IClock; optional + bool initialChannelBusy = default(false); // Assume that channel was busy before the simulation started volatile double duration @unit(s); displayStringTextFormat = default("delayed %p pk (%l)\nifg: %g"); @display("i=block/timer"); diff --git a/src/inet/protocolelement/common/PacketEmitter.ned b/src/inet/protocolelement/common/PacketEmitter.ned index c2efa5f01a5..38db21a22be 100644 --- a/src/inet/protocolelement/common/PacketEmitter.ned +++ b/src/inet/protocolelement/common/PacketEmitter.ned @@ -13,7 +13,7 @@ import inet.queueing.contract.IPacketFlow; simple PacketEmitter extends PacketFlowBase like IPacketFlow { parameters: - object packetFilter = default("*"); // which packets are considered, matches all packets by default + object packetFilter = default("*"); // Which packets are considered, matches all packets by default string direction @enum("undefined", "inbound", "outbound") = default("undefined"); string signalName; @class(PacketEmitter); diff --git a/src/inet/protocolelement/common/PacketStreamer.ned b/src/inet/protocolelement/common/PacketStreamer.ned index 95800e90352..b85e58f82f4 100644 --- a/src/inet/protocolelement/common/PacketStreamer.ned +++ b/src/inet/protocolelement/common/PacketStreamer.ned @@ -15,7 +15,7 @@ import inet.queueing.contract.IPacketFlow; simple PacketStreamer extends PacketProcessorBase like IPacketFlow { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional double datarate @unit(bps) = default(nan bps); @class(PacketStreamer); @display("i=block/cogwheel"); diff --git a/src/inet/protocolelement/fragmentation/PreemptableStreamer.ned b/src/inet/protocolelement/fragmentation/PreemptableStreamer.ned index 87189092771..a29080c8105 100644 --- a/src/inet/protocolelement/fragmentation/PreemptableStreamer.ned +++ b/src/inet/protocolelement/fragmentation/PreemptableStreamer.ned @@ -17,7 +17,7 @@ import inet.queueing.contract.IPacketFlow; simple PreemptableStreamer extends PacketProcessorBase like IPacketFlow { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional double datarate @unit(bps) = default(nan bps); int minPacketLength @unit(b); int roundingLength @unit(b) = default(1B); diff --git a/src/inet/protocolelement/redundancy/StreamClassifier.ned b/src/inet/protocolelement/redundancy/StreamClassifier.ned index 1d24ffcd4a3..d1d37b58e4b 100644 --- a/src/inet/protocolelement/redundancy/StreamClassifier.ned +++ b/src/inet/protocolelement/redundancy/StreamClassifier.ned @@ -18,8 +18,8 @@ simple StreamClassifier extends PacketClassifierBase like IPacketClassifier { parameters: string mode @enum("req", "ind", "both") = default("both"); - object mapping = default({}); // maps stream name to gate index - int gateIndexOffset = default(0); // specify value to be added to the mapping output gate index - int defaultGateIndex = default(0); // default gate index if no matching streams are found + object mapping = default({}); // Maps stream name to gate index + int gateIndexOffset = default(0); // Specify value to be added to the mapping output gate index + int defaultGateIndex = default(0); // Default gate index if no matching streams are found @class(StreamClassifier); } diff --git a/src/inet/protocolelement/redundancy/StreamDecoder.ned b/src/inet/protocolelement/redundancy/StreamDecoder.ned index bc22f719450..c8bcfb2c97e 100644 --- a/src/inet/protocolelement/redundancy/StreamDecoder.ned +++ b/src/inet/protocolelement/redundancy/StreamDecoder.ned @@ -21,8 +21,8 @@ import inet.queueing.contract.IPacketFlow; simple StreamDecoder extends PacketFlowBase like IPacketFlow { parameters: - string interfaceTableModule; // relative module path of the interface table - object mapping @mutable = default([]); // array of objects, where each object maps a network interface name pattern, a source address, a destination address, a VLAN id and a PCP value to a stream name, for example [{stream: "s1", interface: "eth0", destination: "dest1", pcp: 3}, ...] + string interfaceTableModule; // Relative module path of the interface table + object mapping @mutable = default([]); // Array of objects, where each object maps a network interface name pattern, a source address, a destination address, a VLAN id and a PCP value to a stream name, for example [{stream: "s1", interface: "eth0", destination: "dest1", pcp: 3}, ...] @class(StreamDecoder); @display("i=block/blackboard"); } diff --git a/src/inet/protocolelement/redundancy/StreamEncoder.ned b/src/inet/protocolelement/redundancy/StreamEncoder.ned index 298800ce599..559ff0daf9f 100644 --- a/src/inet/protocolelement/redundancy/StreamEncoder.ned +++ b/src/inet/protocolelement/redundancy/StreamEncoder.ned @@ -20,7 +20,7 @@ import inet.queueing.contract.IPacketFlow; simple StreamEncoder extends PacketFlowBase like IPacketFlow { parameters: - object mapping @mutable = default([]); // array of objects, where each object maps a stream name to a VLAN id, and PCP value, for example [{stream: "s1", vlan: 12, pcp: 7}, ...] + object mapping @mutable = default([]); // Array of objects, where each object maps a stream name to a VLAN id, and PCP value, for example [{stream: "s1", vlan: 12, pcp: 7}, ...] @class(StreamEncoder); @display("i=block/blackboard"); } diff --git a/src/inet/protocolelement/redundancy/StreamFilter.ned b/src/inet/protocolelement/redundancy/StreamFilter.ned index b802159a388..df09c75c71e 100644 --- a/src/inet/protocolelement/redundancy/StreamFilter.ned +++ b/src/inet/protocolelement/redundancy/StreamFilter.ned @@ -18,6 +18,6 @@ simple StreamFilter extends PacketFilterBase like IPacketFilter { parameters: string mode @enum("req", "ind", "both") = default("both"); - string streamNameFilter = default("*"); // filter expression for the stream name + string streamNameFilter = default("*"); // Filter expression for the stream name @class(StreamFilter); } diff --git a/src/inet/protocolelement/redundancy/StreamIdentifier.ned b/src/inet/protocolelement/redundancy/StreamIdentifier.ned index 6b5493b3be0..3b79f2d67f0 100644 --- a/src/inet/protocolelement/redundancy/StreamIdentifier.ned +++ b/src/inet/protocolelement/redundancy/StreamIdentifier.ned @@ -19,7 +19,7 @@ simple StreamIdentifier extends PacketFlowBase like IPacketFlow { parameters: bool hasSequenceNumbering = default(true); - object mapping @mutable = default([]); // array of objects, where each object specifies a stream name and a packetFilter, for example [{stream: "s0", packetFilter: "*"}, ...] + object mapping @mutable = default([]); // Array of objects, where each object specifies a stream name and a packetFilter, for example [{stream: "s0", packetFilter: "*"}, ...] @class(StreamIdentifier); @display("i=block/blackboard"); } diff --git a/src/inet/protocolelement/redundancy/StreamMerger.ned b/src/inet/protocolelement/redundancy/StreamMerger.ned index 4fa1000b3ed..08175b58aed 100644 --- a/src/inet/protocolelement/redundancy/StreamMerger.ned +++ b/src/inet/protocolelement/redundancy/StreamMerger.ned @@ -19,8 +19,8 @@ import inet.queueing.contract.IPacketFilter; simple StreamMerger extends PacketFilterBase like IPacketFilter { parameters: - object mapping @mutable = default({}); // map of input streams to output streams, empty string means no stream, for example {s0: "s1", ...} - int bufferSize = default(10); // window size for sequence numbers per stream + object mapping @mutable = default({}); // Map of input streams to output streams, empty string means no stream, for example {s0: "s1", ...} + int bufferSize = default(10); // Window size for sequence numbers per stream @class(StreamMerger); @display("i=block/join"); } diff --git a/src/inet/protocolelement/redundancy/StreamSplitter.ned b/src/inet/protocolelement/redundancy/StreamSplitter.ned index 9aafac2a56b..3456ca0a885 100644 --- a/src/inet/protocolelement/redundancy/StreamSplitter.ned +++ b/src/inet/protocolelement/redundancy/StreamSplitter.ned @@ -22,7 +22,7 @@ import inet.queueing.contract.IPacketPusher; simple StreamSplitter extends PacketPusherBase like IPacketPusher { parameters: - object mapping @mutable = default({}); // map from input stream names to array of output stream names, empty string means no stream + object mapping @mutable = default({}); // Map from input stream names to array of output stream names, empty string means no stream @class(StreamSplitter); @display("i=block/fork"); } diff --git a/src/inet/protocolelement/shaper/EligibilityTimeFilter.ned b/src/inet/protocolelement/shaper/EligibilityTimeFilter.ned index 71dc788a478..5820c409ec3 100644 --- a/src/inet/protocolelement/shaper/EligibilityTimeFilter.ned +++ b/src/inet/protocolelement/shaper/EligibilityTimeFilter.ned @@ -24,7 +24,7 @@ import inet.queueing.contract.IPacketFilter; simple EligibilityTimeFilter extends PacketFilterBase like IPacketFilter { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - double maxResidenceTime @unit(s) = default(-1s); // optional max residence time limit, not used by default + string clockModule = default(""); // Relative path of a module that implements IClock; optional + double maxResidenceTime @unit(s) = default(-1s); // Optional max residence time limit, not used by default @class(EligibilityTimeFilter); } diff --git a/src/inet/protocolelement/shaper/EligibilityTimeGate.ned b/src/inet/protocolelement/shaper/EligibilityTimeGate.ned index dc65998e970..1f115f92fe0 100644 --- a/src/inet/protocolelement/shaper/EligibilityTimeGate.ned +++ b/src/inet/protocolelement/shaper/EligibilityTimeGate.ned @@ -23,7 +23,7 @@ import inet.queueing.contract.IPacketGate; simple EligibilityTimeGate extends PacketGateBase like IPacketGate { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional @signal[remainingEligibilityTimeChanged](type=simtime_t); @statistic[remainingEligibilityTime](title="remaining eligibility time"; source=remainingEligibilityTimeChanged; record=vector; unit=s; interpolationmode=linear); @class(EligibilityTimeGate); diff --git a/src/inet/protocolelement/shaper/EligibilityTimeMeter.ned b/src/inet/protocolelement/shaper/EligibilityTimeMeter.ned index 590748fb415..fc1777b8fe8 100644 --- a/src/inet/protocolelement/shaper/EligibilityTimeMeter.ned +++ b/src/inet/protocolelement/shaper/EligibilityTimeMeter.ned @@ -23,11 +23,11 @@ import inet.queueing.contract.IPacketMeter; simple EligibilityTimeMeter extends PacketMeterBase like IPacketMeter { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - int packetOverheadLength @unit(b) = default(0b); // extra packet length taken into account, can be used to represent overhead added by lower layers - double committedInformationRate @unit(bps); // committed information rate of the packet flow - int committedBurstSize @unit(b); // committed burst size of the packet flow - double maxResidenceTime @unit(s) = default(-1s); // maximum packet residence time measured from the packet arrival time to the meter module to the transmission eligiblity time, not used by default + string clockModule = default(""); // Relative path of a module that implements IClock; optional + int packetOverheadLength @unit(b) = default(0b); // Extra packet length taken into account, can be used to represent overhead added by lower layers + double committedInformationRate @unit(bps); // Committed information rate of the packet flow + int committedBurstSize @unit(b); // Committed burst size of the packet flow + double maxResidenceTime @unit(s) = default(-1s); // Maximum packet residence time measured from the packet arrival time to the meter module to the transmission eligiblity time, not used by default @class(EligibilityTimeMeter); @signal[tokensChanged](type=double); @statistic[numTokens](title="number of tokens"; source=tokensChanged; record=vector; unit=tk; interpolationmode=linear); diff --git a/src/inet/protocolelement/shaper/EligibilityTimeQueue.ned b/src/inet/protocolelement/shaper/EligibilityTimeQueue.ned index ea6a6cfb9d8..eae36f2aaf6 100644 --- a/src/inet/protocolelement/shaper/EligibilityTimeQueue.ned +++ b/src/inet/protocolelement/shaper/EligibilityTimeQueue.ned @@ -20,5 +20,5 @@ import inet.queueing.queue.PacketQueue; simple EligibilityTimeQueue extends PacketQueue { parameters: - comparatorClass = default("inet::PacketEligibilityTimeComparator"); // specifies the class that compares the eligibility time in the ~EligibilityTimeTag of two packets + comparatorClass = default("inet::PacketEligibilityTimeComparator"); // Specifies the class that compares the eligibility time in the ~EligibilityTimeTag of two packets } diff --git a/src/inet/protocolelement/shaper/GroupEligibilityTimeMeter.ned b/src/inet/protocolelement/shaper/GroupEligibilityTimeMeter.ned index b1396a1dc3c..a5c6b0e4f95 100644 --- a/src/inet/protocolelement/shaper/GroupEligibilityTimeMeter.ned +++ b/src/inet/protocolelement/shaper/GroupEligibilityTimeMeter.ned @@ -15,10 +15,10 @@ package inet.protocolelement.shaper; // // @see ~ATS8021qFilter, ~EligibilityTimeGate, ~EligibilityTimeFilter, ~EligibilityTimeQueue, ~EligibilityTimeTag // - + simple GroupEligibilityTimeMeter extends EligibilityTimeMeter { - parameters: - string groupEligibilityTimeTableModule; // relative path to the eligibilityTimeTable + parameters: + string groupEligibilityTimeTableModule; // Relative path to the eligibilityTimeTable @class(inet::MyEligibilityTimeMeter); } \ No newline at end of file diff --git a/src/inet/protocolelement/transceiver/base/PacketTransmitterBase.ned b/src/inet/protocolelement/transceiver/base/PacketTransmitterBase.ned index 08ac597401d..5048041e01e 100644 --- a/src/inet/protocolelement/transceiver/base/PacketTransmitterBase.ned +++ b/src/inet/protocolelement/transceiver/base/PacketTransmitterBase.ned @@ -12,7 +12,7 @@ import inet.queueing.base.PacketProcessorBase; simple PacketTransmitterBase extends PacketProcessorBase { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional volatile double datarate @unit(bps); @class(PacketTransmitterBase); @display("i=block/wtx"); diff --git a/src/inet/queueing/base/PacketBufferBase.ned b/src/inet/queueing/base/PacketBufferBase.ned index 75e3d3ab5aa..50e11f095a4 100644 --- a/src/inet/queueing/base/PacketBufferBase.ned +++ b/src/inet/queueing/base/PacketBufferBase.ned @@ -23,7 +23,7 @@ package inet.queueing.base; simple PacketBufferBase extends PacketProcessorBase { parameters: - displayStringTextFormat = default("contains %p pk (%l)\nadded %a removed %r dropped %d"); // determines display string text above the submodule + displayStringTextFormat = default("contains %p pk (%l)\nadded %a removed %r dropped %d"); // Determines display string text above the submodule @display("i=block/buffer"); gates: input in @loose; diff --git a/src/inet/queueing/base/PacketDelayerBase.ned b/src/inet/queueing/base/PacketDelayerBase.ned index 1843130d847..c28fb77e7a4 100644 --- a/src/inet/queueing/base/PacketDelayerBase.ned +++ b/src/inet/queueing/base/PacketDelayerBase.ned @@ -10,7 +10,7 @@ package inet.queueing.base; simple PacketDelayerBase extends PacketProcessorBase { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional int schedulingPriority = default(0); bool scheduleZeroDelay = default(true); @class(PacketDelayerBase); diff --git a/src/inet/queueing/base/PacketFilterBase.ned b/src/inet/queueing/base/PacketFilterBase.ned index aa3c03184f6..09ea35cb6e5 100644 --- a/src/inet/queueing/base/PacketFilterBase.ned +++ b/src/inet/queueing/base/PacketFilterBase.ned @@ -18,7 +18,7 @@ simple PacketFilterBase extends PacketProcessorBase { parameters: bool backpressure = default(false); - displayStringTextFormat = default("dropped %d/%p pk (%k/%l)"); // determines the text that is written on top of the submodule + displayStringTextFormat = default("dropped %d/%p pk (%k/%l)"); // Determines the text that is written on top of the submodule @class(PacketFilterBase); @display("i=block/downarrow"); @signal[packetPushedIn](type=inet::Packet); diff --git a/src/inet/queueing/base/PacketLabelerBase.ned b/src/inet/queueing/base/PacketLabelerBase.ned index 7b96adb8c69..4f24b9bcf4c 100644 --- a/src/inet/queueing/base/PacketLabelerBase.ned +++ b/src/inet/queueing/base/PacketLabelerBase.ned @@ -13,7 +13,7 @@ package inet.queueing.base; simple PacketLabelerBase extends PacketMarkerBase { parameters: - string labels = default(""); // a space separated list of labels + string labels = default(""); // A space separated list of labels @class(PacketLabelerBase); @display("i=block/star"); } diff --git a/src/inet/queueing/base/PacketProcessorBase.ned b/src/inet/queueing/base/PacketProcessorBase.ned index 0cbd617f157..0bb6da77606 100644 --- a/src/inet/queueing/base/PacketProcessorBase.ned +++ b/src/inet/queueing/base/PacketProcessorBase.ned @@ -18,6 +18,6 @@ package inet.queueing.base; simple PacketProcessorBase { parameters: - string displayStringTextFormat = default("processed %p pk (%l)"); // determines the text that is written on top of the submodule + string displayStringTextFormat = default("processed %p pk (%l)"); // Determines the text that is written on top of the submodule @display("i=block/star"); } diff --git a/src/inet/queueing/base/PacketQueueBase.ned b/src/inet/queueing/base/PacketQueueBase.ned index 08ba2f0232e..76a788a8f01 100644 --- a/src/inet/queueing/base/PacketQueueBase.ned +++ b/src/inet/queueing/base/PacketQueueBase.ned @@ -25,7 +25,7 @@ package inet.queueing.base; simple PacketQueueBase extends PacketProcessorBase { parameters: - displayStringTextFormat = default("contains %p pk (%l)\npushed %u pulled %o dropped %d"); // determines display string text above the submodule + displayStringTextFormat = default("contains %p pk (%l)\npushed %u pulled %o dropped %d"); // Determines display string text above the submodule @display("i=block/queue"); gates: input in @loose; diff --git a/src/inet/queueing/base/PacketSourceBase.ned b/src/inet/queueing/base/PacketSourceBase.ned index e76afd02d54..e4f666011e0 100644 --- a/src/inet/queueing/base/PacketSourceBase.ned +++ b/src/inet/queueing/base/PacketSourceBase.ned @@ -34,8 +34,8 @@ package inet.queueing.base; simple PacketSourceBase extends PacketProcessorBase { parameters: - string packetNameFormat = default("%a-%c"); // see directives in module documentation - string packetRepresentation @units("bitCount","bits","byteCount","bytes","applicationPacket") = default("byteCount"); // determines the chunk of the packet data + string packetNameFormat = default("%a-%c"); // See directives in module documentation + string packetRepresentation @units("bitCount","bits","byteCount","bytes","applicationPacket") = default("byteCount"); // Determines the chunk of the packet data string packetProtocol = default("unknown"); volatile int packetLength @unit(b); volatile int packetData = default(-1); diff --git a/src/inet/queueing/base/PacketTaggerBase.ned b/src/inet/queueing/base/PacketTaggerBase.ned index 02509000e54..d8da8904fcc 100644 --- a/src/inet/queueing/base/PacketTaggerBase.ned +++ b/src/inet/queueing/base/PacketTaggerBase.ned @@ -13,15 +13,15 @@ package inet.queueing.base; simple PacketTaggerBase extends PacketMarkerBase { parameters: - int dscp = default(-1); // specifies differentiated services code point - int ecn = default(-1); // specifies explicit congestion notification - int tos = default(-1); // if not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value - string interfaceName = default(""); // specifies outgoing interface, unused by default - int hopLimit = default(-1); // specifies network layer TTL, unused by default - int vlanId = default(-1); // specifies VLAN, unused by default - int pcp = default(-1); // specifies PCP, unused by default - int userPriority = default(-1); // specifies user priority, unused by default - double transmissionPower @unit(W) = default(nan W); // specifies signal transmission power, unused by default + int dscp = default(-1); // Specifies differentiated services code point + int ecn = default(-1); // Specifies explicit congestion notification + int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value + string interfaceName = default(""); // Specifies outgoing interface, unused by default + int hopLimit = default(-1); // Specifies network layer TTL, unused by default + int vlanId = default(-1); // Specifies VLAN, unused by default + int pcp = default(-1); // Specifies PCP, unused by default + int userPriority = default(-1); // Specifies user priority, unused by default + double transmissionPower @unit(W) = default(nan W); // Specifies signal transmission power, unused by default object encapsulationProtocols = default([]); displayStringTextFormat = default("tagged %p pk (%l)"); @class(PacketTaggerBase); diff --git a/src/inet/queueing/base/TokenGeneratorBase.ned b/src/inet/queueing/base/TokenGeneratorBase.ned index 63624f1dc46..7e29dd3ed57 100644 --- a/src/inet/queueing/base/TokenGeneratorBase.ned +++ b/src/inet/queueing/base/TokenGeneratorBase.ned @@ -13,8 +13,8 @@ package inet.queueing.base; simple TokenGeneratorBase extends PacketProcessorBase { parameters: - string storageModule; // module path of the token storage where the tokens are generated via C++ method call - displayStringTextFormat = default("generated %t tk\nto %s"); // determines display string text above the submodule + string storageModule; // Module path of the token storage where the tokens are generated via C++ method call + displayStringTextFormat = default("generated %t tk\nto %s"); // Determines display string text above the submodule @class(TokenGeneratorBase); @display("i=block/control"); @signal[tokensCreated](type=double); diff --git a/src/inet/queueing/buffer/PacketBuffer.ned b/src/inet/queueing/buffer/PacketBuffer.ned index 647c2b6df8f..fd372a9ed63 100644 --- a/src/inet/queueing/buffer/PacketBuffer.ned +++ b/src/inet/queueing/buffer/PacketBuffer.ned @@ -21,9 +21,9 @@ import inet.queueing.contract.IPacketBuffer; simple PacketBuffer extends PacketBufferBase like IPacketBuffer { parameters: - int packetCapacity = default(-1); // maximum number of packets in the queue, no limit by default - int dataCapacity @unit(b) = default(-1b); // maximum total length of packets in the queue, no limit by default - string dropperClass = default(""); // determines which packets are dropped when the buffer is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class + int packetCapacity = default(-1); // Maximum number of packets in the queue, no limit by default + int dataCapacity @unit(b) = default(-1b); // Maximum total length of packets in the queue, no limit by default + string dropperClass = default(""); // Determines which packets are dropped when the buffer is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class @class(PacketBuffer); @display("i=block/buffer"); @signal[packetAdded](type=inet::Packet); diff --git a/src/inet/queueing/classifier/ContentBasedClassifier.ned b/src/inet/queueing/classifier/ContentBasedClassifier.ned index caf556ec830..54d74efdb3f 100644 --- a/src/inet/queueing/classifier/ContentBasedClassifier.ned +++ b/src/inet/queueing/classifier/ContentBasedClassifier.ned @@ -20,7 +20,7 @@ import inet.queueing.contract.IPacketClassifier; simple ContentBasedClassifier extends PacketClassifierBase like IPacketClassifier { parameters: - int defaultGateIndex = default(0); // default gate index if no matching labels are found - object packetFilters; // array of packet filter expressions + int defaultGateIndex = default(0); // Default gate index if no matching labels are found + object packetFilters; // Array of packet filter expressions @class(ContentBasedClassifier); } diff --git a/src/inet/queueing/classifier/DualRateThreeColorClassifier.ned b/src/inet/queueing/classifier/DualRateThreeColorClassifier.ned index 4e2b9893af3..07c2a1f6562 100644 --- a/src/inet/queueing/classifier/DualRateThreeColorClassifier.ned +++ b/src/inet/queueing/classifier/DualRateThreeColorClassifier.ned @@ -26,11 +26,11 @@ package inet.queueing.classifier; simple DualRateThreeColorClassifier extends MultiTokenBucketClassifier { parameters: - double committedInformationRate @unit(bps); // committed information rate - double excessInformationRate @unit(bps); // excess information rate - int committedBurstSize @unit(b); // committed burst size - int excessBurstSize @unit(b); // excess burst size - int bitsPerToken = default(8); // how many bits are represented by 1 token + double committedInformationRate @unit(bps); // Committed information rate + double excessInformationRate @unit(bps); // Excess information rate + int committedBurstSize @unit(b); // Committed burst size + int excessBurstSize @unit(b); // Excess burst size + int bitsPerToken = default(8); // How many bits are represented by 1 token buckets = [{initialNumTokens: dropUnit(committedBurstSize) / bitsPerToken, maxNumTokens: dropUnit(committedBurstSize) / bitsPerToken, tokenProductionRate: dropUnit(committedInformationRate) / bitsPerToken}, {initialNumTokens: dropUnit(excessBurstSize) / bitsPerToken, maxNumTokens: dropUnit(excessBurstSize) / bitsPerToken, tokenProductionRate: dropUnit(excessInformationRate) / bitsPerToken}]; tokenConsumptionPerBit = 1 / bitsPerToken; diff --git a/src/inet/queueing/classifier/LabelClassifier.ned b/src/inet/queueing/classifier/LabelClassifier.ned index a796baeb924..25f9f6c837e 100644 --- a/src/inet/queueing/classifier/LabelClassifier.ned +++ b/src/inet/queueing/classifier/LabelClassifier.ned @@ -16,7 +16,7 @@ import inet.queueing.contract.IPacketClassifier; simple LabelClassifier extends PacketClassifierBase like IPacketClassifier { parameters: - int defaultGateIndex = default(0); // default gate index if no matching labels are found - string labelsToGateIndices; // space separated list of label and gate index pairs + int defaultGateIndex = default(0); // Default gate index if no matching labels are found + string labelsToGateIndices; // Space separated list of label and gate index pairs @class(LabelClassifier); } diff --git a/src/inet/queueing/classifier/MarkovClassifier.ned b/src/inet/queueing/classifier/MarkovClassifier.ned index 8a849ccd24c..7ed6f34e6f0 100644 --- a/src/inet/queueing/classifier/MarkovClassifier.ned +++ b/src/inet/queueing/classifier/MarkovClassifier.ned @@ -19,9 +19,9 @@ simple MarkovClassifier extends PacketClassifierBase like IPacketClassifier { parameters: displayStringTextFormat = default("classified %p pk (%l)\ncurrent state: %s"); - string clockModule = default(""); // relative path of a module that implements IClock; optional - int initialState = default(0); // the index of the start state of the Markov process - string transitionProbabilities; // the transition matrix (N x N) of the Markov process, specified as a list of probabilities - string waitIntervals; // the amount of time the Markov process stays in a given state, a list of intervals (N) indexed by the state + string clockModule = default(""); // Relative path of a module that implements IClock; optional + int initialState = default(0); // The index of the start state of the Markov process + string transitionProbabilities; // The transition matrix (N x N) of the Markov process, specified as a list of probabilities + string waitIntervals; // The amount of time the Markov process stays in a given state, a list of intervals (N) indexed by the state @class(MarkovClassifier); } diff --git a/src/inet/queueing/classifier/MultiTokenBucketClassifier.ned b/src/inet/queueing/classifier/MultiTokenBucketClassifier.ned index bbcc4b2d5a6..c2d150d8a75 100644 --- a/src/inet/queueing/classifier/MultiTokenBucketClassifier.ned +++ b/src/inet/queueing/classifier/MultiTokenBucketClassifier.ned @@ -18,10 +18,10 @@ import inet.queueing.contract.IPacketClassifier; simple MultiTokenBucketClassifier extends PacketClassifierBase like IPacketClassifier { parameters: - object buckets; // array of objects specifying the token buckets + object buckets; // Array of objects specifying the token buckets // example: [{initialNumTokens: 100, maxNumTokens: 1000, tokenProductionRate: 10, excessTokenModule: ".other"}] - double tokenConsumptionPerPacket = default(0); // how many tokens are consumed per packet - double tokenConsumptionPerBit = default(1); // how many tokens are consumed per bit + double tokenConsumptionPerPacket = default(0); // How many tokens are consumed per packet + double tokenConsumptionPerBit = default(1); // How many tokens are consumed per bit displayStringTextFormat = default("contains %n tk\nmetered %p pk (%l)"); @signal[tokensChanged](type=double); @statistic[numTokens](title="number of tokens"; source=demux(tokensChanged); record=vector; unit=tk; interpolationmode=linear); diff --git a/src/inet/queueing/classifier/PacketClassifier.ned b/src/inet/queueing/classifier/PacketClassifier.ned index a7e81ef125d..80df1cdeb1c 100644 --- a/src/inet/queueing/classifier/PacketClassifier.ned +++ b/src/inet/queueing/classifier/PacketClassifier.ned @@ -21,6 +21,6 @@ import inet.queueing.contract.IPacketClassifier; simple PacketClassifier extends PacketClassifierBase like IPacketClassifier { parameters: - string classifierClass; // determines the output queue of packets, the parameter must be the name of a C++ class which implements the IPacketClassifierFunction interface and is registered via Register_Class + string classifierClass; // Determines the output queue of packets, the parameter must be the name of a C++ class which implements the IPacketClassifierFunction interface and is registered via Register_Class @class(PacketClassifier); } diff --git a/src/inet/queueing/classifier/SingleRateThreeColorClassifier.ned b/src/inet/queueing/classifier/SingleRateThreeColorClassifier.ned index d0a03e6278c..e7bdbd7a16d 100644 --- a/src/inet/queueing/classifier/SingleRateThreeColorClassifier.ned +++ b/src/inet/queueing/classifier/SingleRateThreeColorClassifier.ned @@ -24,10 +24,10 @@ package inet.queueing.classifier; simple SingleRateThreeColorClassifier extends MultiTokenBucketClassifier { parameters: - double committedInformationRate @unit(bps); // committed information rate - int committedBurstSize @unit(b); // committed burst size - int excessBurstSize @unit(b); // excess burst size - int bitsPerToken = default(8); // how many bits are represented by 1 token + double committedInformationRate @unit(bps); // Committed information rate + int committedBurstSize @unit(b); // Committed burst size + int excessBurstSize @unit(b); // Excess burst size + int bitsPerToken = default(8); // How many bits are represented by 1 token buckets = [{initialNumTokens: dropUnit(committedBurstSize) / bitsPerToken, maxNumTokens: dropUnit(committedBurstSize) / bitsPerToken, tokenProductionRate: dropUnit(committedInformationRate) / bitsPerToken}, {initialNumTokens: dropUnit(excessBurstSize) / bitsPerToken, maxNumTokens: dropUnit(excessBurstSize) / bitsPerToken, tokenProductionRate: 0}]; tokenConsumptionPerBit = 1 / bitsPerToken; diff --git a/src/inet/queueing/classifier/SingleRateTwoColorClassifier.ned b/src/inet/queueing/classifier/SingleRateTwoColorClassifier.ned index d151c3e160e..a0b87f1e5f8 100644 --- a/src/inet/queueing/classifier/SingleRateTwoColorClassifier.ned +++ b/src/inet/queueing/classifier/SingleRateTwoColorClassifier.ned @@ -23,9 +23,9 @@ package inet.queueing.classifier; simple SingleRateTwoColorClassifier extends TokenBucketClassifier { parameters: - double committedInformationRate @unit(bps); // committed information rate - int committedBurstSize @unit(b); // committed burst size - int bitsPerToken = default(8); // how many bits are represented by 1 token + double committedInformationRate @unit(bps); // Committed information rate + int committedBurstSize @unit(b); // Committed burst size + int bitsPerToken = default(8); // How many bits are represented by 1 token initialNumTokens = default(maxNumTokens); maxNumTokens = dropUnit(committedBurstSize) / bitsPerToken; tokenProductionRate = dropUnit(committedInformationRate) / bitsPerToken; diff --git a/src/inet/queueing/classifier/TokenBucketClassifier.ned b/src/inet/queueing/classifier/TokenBucketClassifier.ned index 0b4a57d59e7..0bc26ab0301 100644 --- a/src/inet/queueing/classifier/TokenBucketClassifier.ned +++ b/src/inet/queueing/classifier/TokenBucketClassifier.ned @@ -21,12 +21,12 @@ import inet.queueing.contract.IPacketClassifier; simple TokenBucketClassifier extends PacketClassifierBase like IPacketClassifier { parameters: - double initialNumTokens = default(0); // initial number of tokens - double maxNumTokens = default(inf); // maximum number of tokens + double initialNumTokens = default(0); // Initial number of tokens + double maxNumTokens = default(inf); // Maximum number of tokens double tokenProductionRate; - double tokenConsumptionPerPacket = default(0); // how many tokens are consumed per packet - double tokenConsumptionPerBit = default(1); // how many tokens are consumed per bit - string excessTokenModule = default(""); // specifies the module (~ITokenStorage) that receives the excess tokens that are produced by this module + double tokenConsumptionPerPacket = default(0); // How many tokens are consumed per packet + double tokenConsumptionPerBit = default(1); // How many tokens are consumed per bit + string excessTokenModule = default(""); // Specifies the module (~ITokenStorage) that receives the excess tokens that are produced by this module displayStringTextFormat = default("contains %n tk\nmetered %p pk (%l)"); @signal[tokensChanged](type=double); @statistic[numTokens](title="number of tokens"; source=tokensChanged; record=vector; unit=tk; interpolationmode=linear); diff --git a/src/inet/queueing/common/OrdinalBasedDuplicator.ned b/src/inet/queueing/common/OrdinalBasedDuplicator.ned index b229dd11ce1..7da396bec59 100644 --- a/src/inet/queueing/common/OrdinalBasedDuplicator.ned +++ b/src/inet/queueing/common/OrdinalBasedDuplicator.ned @@ -17,7 +17,7 @@ import inet.queueing.base.PacketDuplicatorBase; simple OrdinalBasedDuplicator extends PacketDuplicatorBase { parameters: - string duplicatesVector = default(""); // the duplicatesVector format is ";;...;" + string duplicatesVector = default(""); // The duplicatesVector format is ";;...;" // packet numbers in ascending order e.g. "5;6;12;13;" @display("i=block/control"); @class(OrdinalBasedDuplicator); diff --git a/src/inet/queueing/common/PacketDelayer.ned b/src/inet/queueing/common/PacketDelayer.ned index 529070c8092..4065b88f3ad 100644 --- a/src/inet/queueing/common/PacketDelayer.ned +++ b/src/inet/queueing/common/PacketDelayer.ned @@ -20,7 +20,7 @@ import inet.queueing.contract.IPacketDelayer; simple PacketDelayer extends PacketDelayerBase like IPacketDelayer { parameters: - volatile double delay @unit(s); // specifies delay per packet - volatile double bitrate @unit(bps) = default(inf bps); // determines additional delay per bit + volatile double delay @unit(s); // Specifies delay per packet + volatile double bitrate @unit(bps) = default(inf bps); // Determines additional delay per bit @class(PacketDelayer); } diff --git a/src/inet/queueing/common/PacketDuplicator.ned b/src/inet/queueing/common/PacketDuplicator.ned index 02f5f1d1fe6..fc0930baf68 100644 --- a/src/inet/queueing/common/PacketDuplicator.ned +++ b/src/inet/queueing/common/PacketDuplicator.ned @@ -19,7 +19,7 @@ import inet.queueing.contract.IPassivePacketSink; simple PacketDuplicator extends PacketDuplicatorBase like IPassivePacketSink, IActivePacketSource { parameters: - volatile int numDuplicates = default(1); // number of duplicates, 0 means only the original packet is forwarded + volatile int numDuplicates = default(1); // Number of duplicates, 0 means only the original packet is forwarded @class(PacketDuplicator); @display("i=block/star"); gates: diff --git a/src/inet/queueing/common/PacketHistory.ned b/src/inet/queueing/common/PacketHistory.ned index d0c57b8482d..7f7fef0967c 100644 --- a/src/inet/queueing/common/PacketHistory.ned +++ b/src/inet/queueing/common/PacketHistory.ned @@ -20,7 +20,7 @@ import inet.queueing.contract.IPacketQueue; module PacketHistory like IPassivePacketSink, IActivePacketSource { parameters: - int size = default(100); // the number of packets to remember + int size = default(100); // The number of packets to remember @display("i=block/passiveq"); gates: input in @labels(push); diff --git a/src/inet/queueing/common/QueueingPacketDelayer.ned b/src/inet/queueing/common/QueueingPacketDelayer.ned index d255b5993d3..c8a388e82fb 100644 --- a/src/inet/queueing/common/QueueingPacketDelayer.ned +++ b/src/inet/queueing/common/QueueingPacketDelayer.ned @@ -14,7 +14,7 @@ import inet.queueing.contract.IPacketServer; module QueueingPacketDelayer like IPacketDelayer { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional volatile double delay @unit(s); *.clockModule = default(absPath(this.clockModule)); @display("i=block/delay"); diff --git a/src/inet/queueing/filter/ContentBasedFilter.ned b/src/inet/queueing/filter/ContentBasedFilter.ned index ac9c8b58675..a5474f20b67 100644 --- a/src/inet/queueing/filter/ContentBasedFilter.ned +++ b/src/inet/queueing/filter/ContentBasedFilter.ned @@ -21,6 +21,6 @@ import inet.queueing.contract.IPacketFilter; simple ContentBasedFilter extends PacketFilterBase like IPacketFilter { parameters: - object packetFilter = default("*"); // packet filter expressions, matches all packets by default + object packetFilter = default("*"); // Packet filter expressions, matches all packets by default @class(ContentBasedFilter); } diff --git a/src/inet/queueing/filter/LabelFilter.ned b/src/inet/queueing/filter/LabelFilter.ned index 38141d4440f..51aa9e9c13b 100644 --- a/src/inet/queueing/filter/LabelFilter.ned +++ b/src/inet/queueing/filter/LabelFilter.ned @@ -17,6 +17,6 @@ import inet.queueing.contract.IPacketFilter; simple LabelFilter extends PacketFilterBase like IPacketFilter { parameters: - string labelFilter @mutable; // the label filter as a match expression (e.g. green or red) + string labelFilter @mutable; // The label filter as a match expression (e.g. green or red) @class(LabelFilter); } diff --git a/src/inet/queueing/filter/OrdinalBasedDropper.ned b/src/inet/queueing/filter/OrdinalBasedDropper.ned index 79e9773e0af..a89186e25a5 100644 --- a/src/inet/queueing/filter/OrdinalBasedDropper.ned +++ b/src/inet/queueing/filter/OrdinalBasedDropper.ned @@ -16,7 +16,7 @@ import inet.queueing.base.PacketFilterBase; simple OrdinalBasedDropper extends PacketFilterBase { parameters: - string dropsVector = default(""); // the dropsVector format is ";;...;" + string dropsVector = default(""); // The dropsVector format is ";;...;" // packet numbers in ascending order e.g. "5;6;12;13;" @class(OrdinalBasedDropper); } diff --git a/src/inet/queueing/filter/PacketFilter.ned b/src/inet/queueing/filter/PacketFilter.ned index 76b52a6eaa9..46ccde67cb7 100644 --- a/src/inet/queueing/filter/PacketFilter.ned +++ b/src/inet/queueing/filter/PacketFilter.ned @@ -21,6 +21,6 @@ import inet.queueing.contract.IPacketFilter; simple PacketFilter extends PacketFilterBase like IPacketFilter { parameters: - string filterClass; // determines the packets which pass the filter, the parameter must be the name of a C++ class which implements the IPacketFilterFunction interface and is registered via Register_Class + string filterClass; // Determines the packets which pass the filter, the parameter must be the name of a C++ class which implements the IPacketFilterFunction interface and is registered via Register_Class @class(PacketFilter); } diff --git a/src/inet/queueing/filter/RedDropper.ned b/src/inet/queueing/filter/RedDropper.ned index 3c93bddb6af..bf61d1e48eb 100644 --- a/src/inet/queueing/filter/RedDropper.ned +++ b/src/inet/queueing/filter/RedDropper.ned @@ -38,13 +38,13 @@ simple RedDropper extends PacketFilterBase { parameters: string collectionModule = default(""); - double wq = default(0.002); // weight of the current queue length in the averaged queue length, in range [0.0, 1.0] - double minth = default(5); // minimum threshold for avg queue length - double maxth = default(50); // maximum threshold for avg queue length (=buffer capacity), in range (minth,packetCapacity] - double maxp = default(0.02); // maximum value for pbs, in range [0.0, 1.0] - double pkrate = default(150); // average packet rate for calculations when queue is empty - bool useEcn = default(false); // if enabled, packets are marked with ECN if applicable - int packetCapacity = default(int(maxth)); // packets are dropped if queue length is greater + double wq = default(0.002); // Weight of the current queue length in the averaged queue length, in range [0.0, 1.0] + double minth = default(5); // Minimum threshold for avg queue length + double maxth = default(50); // Maximum threshold for avg queue length (=buffer capacity), in range (minth,packetCapacity] + double maxp = default(0.02); // Maximum value for pbs, in range [0.0, 1.0] + double pkrate = default(150); // Average packet rate for calculations when queue is empty + bool useEcn = default(false); // If enabled, packets are marked with ECN if applicable + int packetCapacity = default(int(maxth)); // Packets are dropped if queue length is greater @class(RedDropper); @display("i=block/downarrow"); @signal[packetDropped](type=inet::Packet); diff --git a/src/inet/queueing/flow/FlowMeasurementRecorder.ned b/src/inet/queueing/flow/FlowMeasurementRecorder.ned index 9acafebdf32..588f6b8ccbe 100644 --- a/src/inet/queueing/flow/FlowMeasurementRecorder.ned +++ b/src/inet/queueing/flow/FlowMeasurementRecorder.ned @@ -25,11 +25,11 @@ import inet.queueing.contract.IPacketFlow; simple FlowMeasurementRecorder extends PacketFlowBase like IPacketFlow { parameters: - object packetFilter = default("*"); // which packets are considered, matches all packets by default - int offset @unit(b) = default(0b); // designates the packet part to be measured - int length @unit(b) = default(-1b); // designates the packet part to be measured - string flowName = default(""); // use packet flow to separate measurement from other measurements - string measure = default("not packetEvent"); // match expression for a combination of: packetEvent, elapsedTime, delayingTime, queueingTime, processingTime, transmissionTime, propagationTime + object packetFilter = default("*"); // Which packets are considered, matches all packets by default + int offset @unit(b) = default(0b); // Designates the packet part to be measured + int length @unit(b) = default(-1b); // Designates the packet part to be measured + string flowName = default(""); // Use packet flow to separate measurement from other measurements + string measure = default("not packetEvent"); // Match expression for a combination of: packetEvent, elapsedTime, delayingTime, queueingTime, processingTime, transmissionTime, propagationTime bool endMeasurement = default(true); string packetEventFileName = default("results/" + expand("${configname}-") + fullPath() + "-packetEvent.json"); @class(FlowMeasurementRecorder); diff --git a/src/inet/queueing/flow/FlowMeasurementStarter.ned b/src/inet/queueing/flow/FlowMeasurementStarter.ned index 2131ebc3712..fbd76a8f7a4 100644 --- a/src/inet/queueing/flow/FlowMeasurementStarter.ned +++ b/src/inet/queueing/flow/FlowMeasurementStarter.ned @@ -13,11 +13,11 @@ import inet.queueing.contract.IPacketFlow; simple FlowMeasurementStarter extends PacketFlowBase like IPacketFlow { parameters: - object packetFilter = default("*"); // which packets are considered, matches all packets by default - int offset @unit(b) = default(0b); // designates the packet part to be measured - int length @unit(b) = default(-1b); // designates the packet part to be measured - string flowName = default(""); // use packet flow to separate measurement from other measurements - string measure = default("not packetEvent"); // match expression for a combination of: packetEvent, elapsedTime, delayingTime, queueingTime, processingTime, transmissionTime, propagationTime + object packetFilter = default("*"); // Which packets are considered, matches all packets by default + int offset @unit(b) = default(0b); // Designates the packet part to be measured + int length @unit(b) = default(-1b); // Designates the packet part to be measured + string flowName = default(""); // Use packet flow to separate measurement from other measurements + string measure = default("not packetEvent"); // Match expression for a combination of: packetEvent, elapsedTime, delayingTime, queueingTime, processingTime, transmissionTime, propagationTime @class(FlowMeasurementStarter); @display("i=block/timer"); @signal[packetFlowStarted](type=inet::Packet); diff --git a/src/inet/queueing/gate/CreditBasedGate.ned b/src/inet/queueing/gate/CreditBasedGate.ned index 14c6e82da73..2c8ef6a1228 100644 --- a/src/inet/queueing/gate/CreditBasedGate.ned +++ b/src/inet/queueing/gate/CreditBasedGate.ned @@ -32,14 +32,14 @@ import inet.queueing.contract.IPacketGate; simple CreditBasedGate extends PacketGateBase like IPacketGate { parameters: - double idleCreditGainRate; // rate of credit increase while the packets that passed through this gate don't use the physical channel - double transmitCreditSpendRate; // rate of credit decrease while the packets that passed through this gate use the physical channel - double initialCredit = default(0); // initial number of credits - double transmitCreditLimit = default(0); // credit limit above which the gate is open - double minCredit = default(-inf); // minimum number of credits - double maxCredit = default(inf); // maximum number of credits - bool accumulateCreditInGuardBand = default(false); // whether credit increases during implicit guard band when no packets can be sent anymore - displayStringTextFormat = default("contains %n cr\nserved %p pk (%l)"); // determines display string text above the submodule + double idleCreditGainRate; // Rate of credit increase while the packets that passed through this gate don't use the physical channel + double transmitCreditSpendRate; // Rate of credit decrease while the packets that passed through this gate use the physical channel + double initialCredit = default(0); // Initial number of credits + double transmitCreditLimit = default(0); // Credit limit above which the gate is open + double minCredit = default(-inf); // Minimum number of credits + double maxCredit = default(inf); // Maximum number of credits + bool accumulateCreditInGuardBand = default(false); // Whether credit increases during implicit guard band when no packets can be sent anymore + displayStringTextFormat = default("contains %n cr\nserved %p pk (%l)"); // Determines display string text above the submodule @class(CreditBasedGate); @signal[creditsChanged](type=double); @statistic[numCredits](title="number of credits"; source=creditsChanged; record=vector; unit=cr; interpolationmode=linear); diff --git a/src/inet/queueing/gate/GateControlList.ned b/src/inet/queueing/gate/GateControlList.ned index f7427e07e23..ab155b9d7d4 100644 --- a/src/inet/queueing/gate/GateControlList.ned +++ b/src/inet/queueing/gate/GateControlList.ned @@ -14,10 +14,10 @@ package inet.queueing.gate; simple GateControlList { parameters: - object durations @mutable @unit(s) = default([]); // list of entry durations, e.g. [4ms, 2ms, 2ms, 2ms] - object gateStates @mutable = default([]); // list of gateStates, e.g. ["10000000", "01111111", "10000000", "01111111"] - int numGates = default(8); // number of configured PeriodicGate modules - string mapping; // string specifying the gate index for the ith gate states, e.g. "76543210" means reverse gate index order + object durations @mutable @unit(s) = default([]); // List of entry durations, e.g. [4ms, 2ms, 2ms, 2ms] + object gateStates @mutable = default([]); // List of gateStates, e.g. ["10000000", "01111111", "10000000", "01111111"] + int numGates = default(8); // Number of configured PeriodicGate modules + string mapping; // String specifying the gate index for the ith gate states, e.g. "76543210" means reverse gate index order @class(GateControlList); @display("i=block/table"); } diff --git a/src/inet/queueing/gate/PacketGate.ned b/src/inet/queueing/gate/PacketGate.ned index bc4792f0edf..9a67a9ecd56 100644 --- a/src/inet/queueing/gate/PacketGate.ned +++ b/src/inet/queueing/gate/PacketGate.ned @@ -17,7 +17,7 @@ import inet.queueing.contract.IPacketGate; simple PacketGate extends PacketGateBase like IPacketGate { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional bool initiallyOpen = default(false); double openTime @unit(s); double closeTime @unit(s); diff --git a/src/inet/queueing/gate/PeriodicGate.ned b/src/inet/queueing/gate/PeriodicGate.ned index d1660b9e333..d732f1e00b2 100644 --- a/src/inet/queueing/gate/PeriodicGate.ned +++ b/src/inet/queueing/gate/PeriodicGate.ned @@ -18,14 +18,14 @@ import inet.queueing.contract.IPacketGate; simple PeriodicGate extends PacketGateBase like IPacketGate { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - bool initiallyOpen @mutable = default(true); // specifies if the gate is initially open or closed - double offset @mutable @unit(s) = default(0s); // specifies where the period starts in the list of gate state change durations; where it is in the period at the start - object durations @mutable @unit(s) = default([]); // list of time durations within the period that determine if the gate is open or closed; period is the sum of the durations - bool scheduleForAbsoluteTime = default(true); // when a clock is used relative means that setting the clock will not affect the simulation time of the event + string clockModule = default(""); // Relative path of a module that implements IClock; optional + bool initiallyOpen @mutable = default(true); // Specifies if the gate is initially open or closed + double offset @mutable @unit(s) = default(0s); // Specifies where the period starts in the list of gate state change durations; where it is in the period at the start + object durations @mutable @unit(s) = default([]); // List of time durations within the period that determine if the gate is open or closed; period is the sum of the durations + bool scheduleForAbsoluteTime = default(true); // When a clock is used relative means that setting the clock will not affect the simulation time of the event int openSchedulingPriority = default(0); // FES scheduling priority for the next gate open event int closeSchedulingPriority = default(0); // FES scheduling priority for the next gate close event - bool enableImplicitGuardBand = default(true); // implicit guard band means that a packet is not allowed to be forwarded if it cannot finish transmission before the end of window. + bool enableImplicitGuardBand = default(true); // Implicit guard band means that a packet is not allowed to be forwarded if it cannot finish transmission before the end of window. @class(PeriodicGate); @signal[guardBandStateChanged](type=bool); @statistic[guardBandState](title="guard band state"; type=enum; enum=ON, OFF; source=guardBandStateChanged; record=vector; interpolationmode=sample-hold); diff --git a/src/inet/queueing/marker/ContentBasedLabeler.ned b/src/inet/queueing/marker/ContentBasedLabeler.ned index ec7a007e649..c06cd21961b 100644 --- a/src/inet/queueing/marker/ContentBasedLabeler.ned +++ b/src/inet/queueing/marker/ContentBasedLabeler.ned @@ -16,6 +16,6 @@ import inet.queueing.contract.IPacketMarker; simple ContentBasedLabeler extends PacketLabelerBase like IPacketMarker { parameters: - object packetFilters = default(["*"]); // array of packet filter expressions, matches all packets by default + object packetFilters = default(["*"]); // Array of packet filter expressions, matches all packets by default @class(ContentBasedLabeler); } diff --git a/src/inet/queueing/marker/ContentBasedTagger.ned b/src/inet/queueing/marker/ContentBasedTagger.ned index dfe317110f2..02888a964f8 100644 --- a/src/inet/queueing/marker/ContentBasedTagger.ned +++ b/src/inet/queueing/marker/ContentBasedTagger.ned @@ -16,6 +16,6 @@ import inet.queueing.contract.IPacketMarker; simple ContentBasedTagger extends PacketTaggerBase like IPacketMarker { parameters: - object packetFilter = default("*"); // packet filter expressions, matches all packets by default + object packetFilter = default("*"); // Packet filter expressions, matches all packets by default @class(ContentBasedTagger); } diff --git a/src/inet/queueing/marker/PacketLabeler.ned b/src/inet/queueing/marker/PacketLabeler.ned index 137f3be419e..58a2b0ae46e 100644 --- a/src/inet/queueing/marker/PacketLabeler.ned +++ b/src/inet/queueing/marker/PacketLabeler.ned @@ -17,8 +17,8 @@ import inet.queueing.contract.IPacketMarker; simple PacketLabeler extends PacketMarkerBase like IPacketMarker { parameters: - string filterClasses = default(""); // determines the packets which are marked, the parameter must be the name of a C++ class which implements the IPacketFilterFunction interface and is registered via Register_Class - string labels = default(""); // a space separated list of labels + string filterClasses = default(""); // Determines the packets which are marked, the parameter must be the name of a C++ class which implements the IPacketFilterFunction interface and is registered via Register_Class + string labels = default(""); // A space separated list of labels @display("i=block/star"); @class(PacketLabeler); } diff --git a/src/inet/queueing/marker/PacketTagger.ned b/src/inet/queueing/marker/PacketTagger.ned index 167e7636b89..86b3c0ff6b7 100644 --- a/src/inet/queueing/marker/PacketTagger.ned +++ b/src/inet/queueing/marker/PacketTagger.ned @@ -16,6 +16,6 @@ import inet.queueing.contract.IPacketMarker; simple PacketTagger extends PacketTaggerBase like IPacketMarker { parameters: - string filterClass = default("inet::queueing::AnyPacketFilter"); // determines which packets are tagged + string filterClass = default("inet::queueing::AnyPacketFilter"); // Determines which packets are tagged @class(PacketTagger); } diff --git a/src/inet/queueing/meter/DualRateThreeColorMeter.ned b/src/inet/queueing/meter/DualRateThreeColorMeter.ned index 73c007d64bb..86048a26fba 100644 --- a/src/inet/queueing/meter/DualRateThreeColorMeter.ned +++ b/src/inet/queueing/meter/DualRateThreeColorMeter.ned @@ -27,12 +27,12 @@ package inet.queueing.meter; simple DualRateThreeColorMeter extends MultiTokenBucketMeter { parameters: - double committedInformationRate @unit(bps); // committed information rate - double excessInformationRate @unit(bps); // excess information rate - int committedBurstSize @unit(b); // committed burst size - int excessBurstSize @unit(b); // excess burst size - int bitsPerToken = default(8); // how many bits are represented by 1 token - bool colorAware = default(false); // enables color-aware mode where packets can only be demoted + double committedInformationRate @unit(bps); // Committed information rate + double excessInformationRate @unit(bps); // Excess information rate + int committedBurstSize @unit(b); // Committed burst size + int excessBurstSize @unit(b); // Excess burst size + int bitsPerToken = default(8); // How many bits are represented by 1 token + bool colorAware = default(false); // Enables color-aware mode where packets can only be demoted buckets = [{initialNumTokens: dropUnit(committedBurstSize) / bitsPerToken, maxNumTokens: dropUnit(committedBurstSize) / bitsPerToken, tokenProductionRate: dropUnit(committedInformationRate) / bitsPerToken, label: "green"}, {initialNumTokens: dropUnit(excessBurstSize) / bitsPerToken, maxNumTokens: dropUnit(excessBurstSize) / bitsPerToken, tokenProductionRate: dropUnit(excessInformationRate) / bitsPerToken, label: "yellow"}]; tokenConsumptionPerBit = 1 / bitsPerToken; diff --git a/src/inet/queueing/meter/ExponentialRateMeter.ned b/src/inet/queueing/meter/ExponentialRateMeter.ned index abe6bb62b77..944e0ceea4a 100644 --- a/src/inet/queueing/meter/ExponentialRateMeter.ned +++ b/src/inet/queueing/meter/ExponentialRateMeter.ned @@ -20,6 +20,6 @@ import inet.queueing.contract.IPacketMeter; simple ExponentialRateMeter extends PacketMeterBase like IPacketMeter { parameters: - double alpha; // parameter in the range of (0, 1) for the exponential weight decrease + double alpha; // Parameter in the range of (0, 1) for the exponential weight decrease @class(ExponentialRateMeter); } diff --git a/src/inet/queueing/meter/MultiTokenBucketMeter.ned b/src/inet/queueing/meter/MultiTokenBucketMeter.ned index 6a35eec28d0..b47067abad9 100644 --- a/src/inet/queueing/meter/MultiTokenBucketMeter.ned +++ b/src/inet/queueing/meter/MultiTokenBucketMeter.ned @@ -18,12 +18,12 @@ import inet.queueing.contract.IPacketMeter; simple MultiTokenBucketMeter extends PacketMeterBase like IPacketMeter { parameters: - object buckets; // array of objects specifying the token buckets, see ~TokenBucketMeter for parameters + object buckets; // Array of objects specifying the token buckets, see ~TokenBucketMeter for parameters // example: [{initialNumTokens: 100, maxNumTokens: 1000, tokenProductionRate: 10, label: "green", excessTokenModule: ".other"}] - double tokenConsumptionPerPacket = default(0); // how many tokens are consumed per packet - double tokenConsumptionPerBit = default(1); // how many tokens are consumed per bit - string defaultLabel = default(""); // the label that is attached to packets if there are not enouth tokens in the bucket, no label by default - object labelPriority = default([]); // the list of labels in the order of priority, if specified packets can only be promoted in this order + double tokenConsumptionPerPacket = default(0); // How many tokens are consumed per packet + double tokenConsumptionPerBit = default(1); // How many tokens are consumed per bit + string defaultLabel = default(""); // The label that is attached to packets if there are not enouth tokens in the bucket, no label by default + object labelPriority = default([]); // The list of labels in the order of priority, if specified packets can only be promoted in this order displayStringTextFormat = default("contains %n tk\nmetered %p pk (%l)"); @signal[tokensChanged](type=double); @statistic[numTokens](title="number of tokens"; source=demux(tokensChanged); record=vector; unit=tk; interpolationmode=linear); diff --git a/src/inet/queueing/meter/SingleRateThreeColorMeter.ned b/src/inet/queueing/meter/SingleRateThreeColorMeter.ned index b7e04ac9c30..081b68e4c3c 100644 --- a/src/inet/queueing/meter/SingleRateThreeColorMeter.ned +++ b/src/inet/queueing/meter/SingleRateThreeColorMeter.ned @@ -25,11 +25,11 @@ package inet.queueing.meter; simple SingleRateThreeColorMeter extends MultiTokenBucketMeter { parameters: - double committedInformationRate @unit(bps); // committed information rate - int committedBurstSize @unit(b); // committed burst size - int excessBurstSize @unit(b); // excess burst size - int bitsPerToken = default(8); // how many bits are represented by 1 token - bool colorAware = default(false); // enables color-aware mode where packets can only be demoted + double committedInformationRate @unit(bps); // Committed information rate + int committedBurstSize @unit(b); // Committed burst size + int excessBurstSize @unit(b); // Excess burst size + int bitsPerToken = default(8); // How many bits are represented by 1 token + bool colorAware = default(false); // Enables color-aware mode where packets can only be demoted buckets = [{initialNumTokens: dropUnit(committedBurstSize) / bitsPerToken, maxNumTokens: dropUnit(committedBurstSize) / bitsPerToken, tokenProductionRate: dropUnit(committedInformationRate) / bitsPerToken, label: "green"}, {initialNumTokens: dropUnit(excessBurstSize) / bitsPerToken, maxNumTokens: dropUnit(excessBurstSize) / bitsPerToken, tokenProductionRate: 0, label: "yellow"}]; tokenConsumptionPerBit = 1 / bitsPerToken; diff --git a/src/inet/queueing/meter/SingleRateTwoColorMeter.ned b/src/inet/queueing/meter/SingleRateTwoColorMeter.ned index 569e05bdbae..71405087e21 100644 --- a/src/inet/queueing/meter/SingleRateTwoColorMeter.ned +++ b/src/inet/queueing/meter/SingleRateTwoColorMeter.ned @@ -21,10 +21,10 @@ package inet.queueing.meter; simple SingleRateTwoColorMeter extends TokenBucketMeter { parameters: - double committedInformationRate @unit(bps); // committed information rate - int committedBurstSize @unit(b); // committed burst size - int bitsPerToken = default(8); // how many bits are represented by 1 token - bool colorAware = default(false); // enables color-aware mode where packets can only be demoted + double committedInformationRate @unit(bps); // Committed information rate + int committedBurstSize @unit(b); // Committed burst size + int bitsPerToken = default(8); // How many bits are represented by 1 token + bool colorAware = default(false); // Enables color-aware mode where packets can only be demoted initialNumTokens = default(maxNumTokens); maxNumTokens = dropUnit(committedBurstSize) / bitsPerToken; tokenProductionRate = dropUnit(committedInformationRate) / bitsPerToken; diff --git a/src/inet/queueing/meter/SlidingWindowRateMeter.ned b/src/inet/queueing/meter/SlidingWindowRateMeter.ned index 8f2c53e214c..5c38e7b1bc3 100644 --- a/src/inet/queueing/meter/SlidingWindowRateMeter.ned +++ b/src/inet/queueing/meter/SlidingWindowRateMeter.ned @@ -18,6 +18,6 @@ import inet.queueing.contract.IPacketMeter; simple SlidingWindowRateMeter extends PacketMeterBase like IPacketMeter { parameters: - double timeWindow @unit(s); // amount of time to look back from the current simulation time + double timeWindow @unit(s); // Amount of time to look back from the current simulation time @class(SlidingWindowRateMeter); } diff --git a/src/inet/queueing/meter/TokenBucketMeter.ned b/src/inet/queueing/meter/TokenBucketMeter.ned index 5b3dc0a1a9c..3e542f5098f 100644 --- a/src/inet/queueing/meter/TokenBucketMeter.ned +++ b/src/inet/queueing/meter/TokenBucketMeter.ned @@ -20,15 +20,15 @@ import inet.queueing.contract.IPacketMeter; simple TokenBucketMeter extends PacketMeterBase like IPacketMeter { parameters: - double initialNumTokens = default(0); // initial number of tokens in the bucket - double maxNumTokens = default(inf); // maximum number of tokens in the bucket - double tokenProductionRate; // the rate of internal token production per second - double tokenConsumptionPerPacket = default(0); // how many tokens are consumed per packet - double tokenConsumptionPerBit = default(1); // how many tokens are consumed per bit - string label; // the label that is attached to packets if there are enough tokens in the bucket - string defaultLabel = default(""); // the label that is attached to packets if there are not enouth tokens in the bucket, no label by default - object labelPriority = default([]); // the list of labels in the order of priority, if specified packets can only be promoted in this order - string excessTokenModule = default(""); // specifies the module (~ITokenStorage) that receives the excess tokens that are produced by this module when overflown + double initialNumTokens = default(0); // Initial number of tokens in the bucket + double maxNumTokens = default(inf); // Maximum number of tokens in the bucket + double tokenProductionRate; // The rate of internal token production per second + double tokenConsumptionPerPacket = default(0); // How many tokens are consumed per packet + double tokenConsumptionPerBit = default(1); // How many tokens are consumed per bit + string label; // The label that is attached to packets if there are enough tokens in the bucket + string defaultLabel = default(""); // The label that is attached to packets if there are not enouth tokens in the bucket, no label by default + object labelPriority = default([]); // The list of labels in the order of priority, if specified packets can only be promoted in this order + string excessTokenModule = default(""); // Specifies the module (~ITokenStorage) that receives the excess tokens that are produced by this module when overflown displayStringTextFormat = default("contains %n tk\nmetered %p pk (%l)"); @signal[tokensChanged](type=double); @statistic[numTokens](title="number of tokens"; source=tokensChanged; record=vector; unit=tk; interpolationmode=linear); diff --git a/src/inet/queueing/queue/CompoundPacketQueueBase.ned b/src/inet/queueing/queue/CompoundPacketQueueBase.ned index 5e8872d1e10..4213a10b19b 100644 --- a/src/inet/queueing/queue/CompoundPacketQueueBase.ned +++ b/src/inet/queueing/queue/CompoundPacketQueueBase.ned @@ -17,9 +17,9 @@ import inet.queueing.contract.IPacketQueue; module CompoundPacketQueueBase extends PacketQueueBase like IPacketQueue { parameters: - int packetCapacity = default(-1); // maximum number of packets in the queue, no limit by default - int dataCapacity @unit(b) = default(-1b); // maximum total length of packets in the queue, no limit by default - string dropperClass = default(""); // determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class + int packetCapacity = default(-1); // Maximum number of packets in the queue, no limit by default + int dataCapacity @unit(b) = default(-1b); // Maximum total length of packets in the queue, no limit by default + string dropperClass = default(""); // Determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class displayStringTextFormat = default("contains %p pk (%l) pushed %u created %c\n pulled %o removed %r dropped %d"); @class(CompoundPacketQueueBase); @defaultStatistic(queueLength); diff --git a/src/inet/queueing/queue/GatingPriorityQueue.ned b/src/inet/queueing/queue/GatingPriorityQueue.ned index dd5d354ecf2..bed8ad38df2 100644 --- a/src/inet/queueing/queue/GatingPriorityQueue.ned +++ b/src/inet/queueing/queue/GatingPriorityQueue.ned @@ -23,7 +23,7 @@ module GatingPriorityQueue extends CompoundPacketQueueBase int numQueues; double bitrate @unit(bps); *.bitrate = default(this.bitrate); - *.extraLength = default(64b); // overhead for Ethernet PHY header + *.extraLength = default(64b); // Overhead for Ethernet PHY header submodules: buffer: like IPacketBuffer if typename != "" { parameters: diff --git a/src/inet/queueing/queue/GatingQueue.ned b/src/inet/queueing/queue/GatingQueue.ned index bf50aa1f1f7..8df52b01f7f 100644 --- a/src/inet/queueing/queue/GatingQueue.ned +++ b/src/inet/queueing/queue/GatingQueue.ned @@ -26,7 +26,7 @@ module GatingQueue extends CompoundPacketQueueBase parameters: double bitrate @unit(bps); *.bitrate = default(this.bitrate); - *.extraLength = default(64b); // overhead for Ethernet PHY header + *.extraLength = default(64b); // Overhead for Ethernet PHY header submodules: queue: like IPacketQueue { @display("p=300,100,column,125"); diff --git a/src/inet/queueing/queue/PacketQueue.ned b/src/inet/queueing/queue/PacketQueue.ned index 1d5ce0de50b..eb71ca6838e 100644 --- a/src/inet/queueing/queue/PacketQueue.ned +++ b/src/inet/queueing/queue/PacketQueue.ned @@ -58,12 +58,12 @@ import inet.queueing.contract.IPacketQueue; simple PacketQueue extends PacketQueueBase like IPacketQueue { parameters: - int packetCapacity = default(-1); // maximum number of packets in the queue, no limit by default - int dataCapacity @unit(b) = default(-1b); // maximum total length of packets in the queue, no limit by default - string dropperClass = default(""); // determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class - string comparatorClass = default(""); // determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class - string bufferModule = default(""); // relative module path to the IPacketBuffer module used by this queue, implicit buffer by default - displayStringTextFormat = default("contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"); // see ~PacketQueueBase for available format specifiers + int packetCapacity = default(-1); // Maximum number of packets in the queue, no limit by default + int dataCapacity @unit(b) = default(-1b); // Maximum total length of packets in the queue, no limit by default + string dropperClass = default(""); // Determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class + string comparatorClass = default(""); // Determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class + string bufferModule = default(""); // Relative module path to the IPacketBuffer module used by this queue, implicit buffer by default + displayStringTextFormat = default("contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"); // See ~PacketQueueBase for available format specifiers @class(PacketQueue); @signal[packetPushStarted](type=inet::Packet); @signal[packetPushEnded](type=inet::Packet?); diff --git a/src/inet/queueing/scheduler/ContentBasedScheduler.ned b/src/inet/queueing/scheduler/ContentBasedScheduler.ned index 2274250b02b..ee0b1d15861 100644 --- a/src/inet/queueing/scheduler/ContentBasedScheduler.ned +++ b/src/inet/queueing/scheduler/ContentBasedScheduler.ned @@ -20,7 +20,7 @@ import inet.queueing.contract.IPacketScheduler; simple ContentBasedScheduler extends PacketSchedulerBase like IPacketScheduler { parameters: - int defaultGateIndex = default(0); // default gate index if no matching labels are found - object packetFilters; // array of packet filter expressions + int defaultGateIndex = default(0); // Default gate index if no matching labels are found + object packetFilters; // Array of packet filter expressions @class(ContentBasedScheduler); } diff --git a/src/inet/queueing/scheduler/LabelScheduler.ned b/src/inet/queueing/scheduler/LabelScheduler.ned index 8cc47d0eda7..6de831bce51 100644 --- a/src/inet/queueing/scheduler/LabelScheduler.ned +++ b/src/inet/queueing/scheduler/LabelScheduler.ned @@ -16,7 +16,7 @@ import inet.queueing.contract.IPacketScheduler; simple LabelScheduler extends PacketSchedulerBase like IPacketScheduler { parameters: - int defaultGateIndex = default(0); // default gate index if no matching labels are found - string labels; // space separated list of labels in the order of priority (highest first) + int defaultGateIndex = default(0); // Default gate index if no matching labels are found + string labels; // Space separated list of labels in the order of priority (highest first) @class(LabelScheduler); } diff --git a/src/inet/queueing/scheduler/MarkovScheduler.ned b/src/inet/queueing/scheduler/MarkovScheduler.ned index 3fa90f6b74d..91a1449bb8f 100644 --- a/src/inet/queueing/scheduler/MarkovScheduler.ned +++ b/src/inet/queueing/scheduler/MarkovScheduler.ned @@ -19,9 +19,9 @@ simple MarkovScheduler extends PacketSchedulerBase like IPacketScheduler { parameters: displayStringTextFormat = default("classified %p pk (%l)\ncurrent state: %s"); - string clockModule = default(""); // relative path of a module that implements IClock; optional - int initialState = default(0); // the start state of the Markov process - string transitionProbabilities; // the transition matrix (N x N) of the Markov process, specified as a list of probabilities - string waitIntervals; // the amount of time the Markov process stays in a given state, a list of intervals (N) indexed by the state + string clockModule = default(""); // Relative path of a module that implements IClock; optional + int initialState = default(0); // The start state of the Markov process + string transitionProbabilities; // The transition matrix (N x N) of the Markov process, specified as a list of probabilities + string waitIntervals; // The amount of time the Markov process stays in a given state, a list of intervals (N) indexed by the state @class(MarkovScheduler); } diff --git a/src/inet/queueing/scheduler/PacketScheduler.ned b/src/inet/queueing/scheduler/PacketScheduler.ned index 20daa289bf9..b74528ae38e 100644 --- a/src/inet/queueing/scheduler/PacketScheduler.ned +++ b/src/inet/queueing/scheduler/PacketScheduler.ned @@ -21,6 +21,6 @@ import inet.queueing.contract.IPacketScheduler; simple PacketScheduler extends PacketSchedulerBase like IPacketScheduler { parameters: - string schedulerClass; // determines the input queue of the packet, the parameter must be the name of a C++ class which implements the IPacketSchedulerFunction interface and is registered via Register_Class + string schedulerClass; // Determines the input queue of the packet, the parameter must be the name of a C++ class which implements the IPacketSchedulerFunction interface and is registered via Register_Class @class(PacketScheduler); } diff --git a/src/inet/queueing/server/InstantServer.ned b/src/inet/queueing/server/InstantServer.ned index 6c6a896aca8..81d8e7b0f33 100644 --- a/src/inet/queueing/server/InstantServer.ned +++ b/src/inet/queueing/server/InstantServer.ned @@ -17,6 +17,6 @@ import inet.queueing.contract.IPacketServer; simple InstantServer extends PacketServerBase like IPacketServer { parameters: - int serveSchedulingPriority = default(-1); // specifies the FES scheduling priority for the extra event that is pulling the packet, -1 means no extra event + int serveSchedulingPriority = default(-1); // Specifies the FES scheduling priority for the extra event that is pulling the packet, -1 means no extra event @class(InstantServer); } diff --git a/src/inet/queueing/server/PacketServer.ned b/src/inet/queueing/server/PacketServer.ned index 0c5cd7b9fee..375f7853c22 100644 --- a/src/inet/queueing/server/PacketServer.ned +++ b/src/inet/queueing/server/PacketServer.ned @@ -19,9 +19,9 @@ simple PacketServer extends PacketServerBase like IPacketServer { parameters: displayStringTextFormat = default("served %p pk (%l)\n%s"); - string clockModule = default(""); // relative path of a module that implements IClock; optional - int serveSchedulingPriority = default(-1); // specifies the FES scheduling priority for the extra event that is pulling the packet, -1 means no extra event - volatile double processingTime @unit(s); // determines additional processing time per packet - volatile double processingBitrate @unit(bps) = default(inf bps); // determines additional processing time per bit + string clockModule = default(""); // Relative path of a module that implements IClock; optional + int serveSchedulingPriority = default(-1); // Specifies the FES scheduling priority for the extra event that is pulling the packet, -1 means no extra event + volatile double processingTime @unit(s); // Determines additional processing time per packet + volatile double processingBitrate @unit(bps) = default(inf bps); // Determines additional processing time per bit @class(PacketServer); } diff --git a/src/inet/queueing/server/PreemptingServer.ned b/src/inet/queueing/server/PreemptingServer.ned index 56d6b319203..6023e1c36b6 100644 --- a/src/inet/queueing/server/PreemptingServer.ned +++ b/src/inet/queueing/server/PreemptingServer.ned @@ -13,7 +13,7 @@ import inet.queueing.contract.IPacketServer; simple PreemptingServer extends PacketServerBase like IPacketServer { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional + string clockModule = default(""); // Relative path of a module that implements IClock; optional double datarate @unit(bps); @class(PreemptingServer); } diff --git a/src/inet/queueing/server/TokenBasedServer.ned b/src/inet/queueing/server/TokenBasedServer.ned index cfc1c9fd006..ddb7fb068f6 100644 --- a/src/inet/queueing/server/TokenBasedServer.ned +++ b/src/inet/queueing/server/TokenBasedServer.ned @@ -19,11 +19,11 @@ import inet.queueing.contract.IPacketServer; simple TokenBasedServer extends PacketServerBase like IPacketServer { parameters: - double initialNumTokens = default(0); // initial number of tokens - double maxNumTokens = default(nan); // maximum number of tokens - volatile double tokenConsumptionPerPacket = default(1); // how many tokens are consumed per processed packet - volatile double tokenConsumptionPerBit = default(0); // how many tokens are consumed per processed bit - displayStringTextFormat = default("contains %n tk\nserved %p pk (%l)"); // determines display string text above the submodule + double initialNumTokens = default(0); // Initial number of tokens + double maxNumTokens = default(nan); // Maximum number of tokens + volatile double tokenConsumptionPerPacket = default(1); // How many tokens are consumed per processed packet + volatile double tokenConsumptionPerBit = default(0); // How many tokens are consumed per processed bit + displayStringTextFormat = default("contains %n tk\nserved %p pk (%l)"); // Determines display string text above the submodule @signal[tokensAdded](type=double); @signal[tokensRemoved](type=double); @signal[tokensDepleted](type=double); diff --git a/src/inet/queueing/sink/ActivePacketSink.ned b/src/inet/queueing/sink/ActivePacketSink.ned index c56b03df0a4..8c19e706032 100644 --- a/src/inet/queueing/sink/ActivePacketSink.ned +++ b/src/inet/queueing/sink/ActivePacketSink.ned @@ -28,10 +28,10 @@ import inet.queueing.contract.IActivePacketSink; simple ActivePacketSink extends ActivePacketSinkBase like IActivePacketSink { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - double initialCollectionOffset @unit(s) = default(-1s); // initial duration before which packets are not collected, negative value means: try the first collection in initialize() - volatile double collectionInterval @unit(s); // elapsed time between subsequent packets pulled from the connected packet provider - bool scheduleForAbsoluteTime = default(true); // when a clock is used relative means that setting the clock will not affect the simulation time of the event + string clockModule = default(""); // Relative path of a module that implements IClock; optional + double initialCollectionOffset @unit(s) = default(-1s); // Initial duration before which packets are not collected, negative value means: try the first collection in initialize() + volatile double collectionInterval @unit(s); // Elapsed time between subsequent packets pulled from the connected packet provider + bool scheduleForAbsoluteTime = default(true); // When a clock is used relative means that setting the clock will not affect the simulation time of the event @class(ActivePacketSink); gates: input in @labels(pull); diff --git a/src/inet/queueing/sink/PassivePacketSink.ned b/src/inet/queueing/sink/PassivePacketSink.ned index d43ba3b76ff..6b1f9df9075 100644 --- a/src/inet/queueing/sink/PassivePacketSink.ned +++ b/src/inet/queueing/sink/PassivePacketSink.ned @@ -17,10 +17,10 @@ import inet.queueing.contract.IPassivePacketSink; simple PassivePacketSink extends PassivePacketSinkBase like IPassivePacketSink { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - double initialConsumptionOffset @unit(s) = default(0s); // initial duration before which packets are not consumed - volatile double consumptionInterval @unit(s) = default(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 - bool scheduleForAbsoluteTime = default(true); // when a clock is used relative means that setting the clock will not affect the simulation time of the event + string clockModule = default(""); // Relative path of a module that implements IClock; optional + double initialConsumptionOffset @unit(s) = default(0s); // Initial duration before which packets are not consumed + volatile double consumptionInterval @unit(s) = default(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 + bool scheduleForAbsoluteTime = default(true); // When a clock is used relative means that setting the clock will not affect the simulation time of the event @class(PassivePacketSink); gates: input in @labels(push); diff --git a/src/inet/queueing/sink/PcapFilePacketConsumer.ned b/src/inet/queueing/sink/PcapFilePacketConsumer.ned index 768095bd919..e98d43b08ea 100644 --- a/src/inet/queueing/sink/PcapFilePacketConsumer.ned +++ b/src/inet/queueing/sink/PcapFilePacketConsumer.ned @@ -18,12 +18,12 @@ simple PcapFilePacketConsumer extends PassivePacketSinkBase like IPassivePacketS { parameters: string fileFormat @enum("pcap", "pcapng") = default("pcap"); - string filename; // the PCAP file to be written - int networkType; // the network type header field in the PCAP file, see http://www.tcpdump.org/linktypes.html (1=ethernet, 204=ppp, 105=IEEE 802.11, ...) - int snaplen = default(65535); // maximum number of bytes to record per packet - int timePrecision = default(6); // Time precison in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format). - bool outbound; // direction flag - bool alwaysFlush = default(false); // flush the PCAP file after each write to ensure that all packets are captured in case of a crash + string filename; // The PCAP file to be written + int networkType; // The network type header field in the PCAP file, see http://www.tcpdump.org/linktypes.html (1=ethernet, 204=ppp, 105=IEEE 802.11, ...) + int snaplen = default(65535); // Maximum number of bytes to record per packet + int timePrecision = default(6); // Time precison in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format). + bool outbound; // Direction flag + bool alwaysFlush = default(false); // Flush the PCAP file after each write to ensure that all packets are captured in case of a crash @class(PcapFilePacketConsumer); gates: input in @labels(push); diff --git a/src/inet/queueing/source/ActivePacketSource.ned b/src/inet/queueing/source/ActivePacketSource.ned index e8bfebb970e..f9b9d6aadd9 100644 --- a/src/inet/queueing/source/ActivePacketSource.ned +++ b/src/inet/queueing/source/ActivePacketSource.ned @@ -26,10 +26,10 @@ import inet.queueing.contract.IActivePacketSource; simple ActivePacketSource extends ActivePacketSourceBase like IActivePacketSource { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - double initialProductionOffset @mutable @unit(s) = default(-1s); // initial duration before which packets are not produced. When negative, then produce packet in initialize() - volatile double productionInterval @unit(s); // elapsed time between subsequent packets pushed to the connected packet consumer - bool scheduleForAbsoluteTime = default(true); // when a clock is used relative means that setting the clock will not affect the simulation time of the event + string clockModule = default(""); // Relative path of a module that implements IClock; optional + double initialProductionOffset @mutable @unit(s) = default(-1s); // Initial duration before which packets are not produced. When negative, then produce packet in initialize() + volatile double productionInterval @unit(s); // Elapsed time between subsequent packets pushed to the connected packet consumer + bool scheduleForAbsoluteTime = default(true); // When a clock is used relative means that setting the clock will not affect the simulation time of the event @class(ActivePacketSource); gates: output out @labels(push); diff --git a/src/inet/queueing/source/PassivePacketSource.ned b/src/inet/queueing/source/PassivePacketSource.ned index dad295d970a..26cc7089656 100644 --- a/src/inet/queueing/source/PassivePacketSource.ned +++ b/src/inet/queueing/source/PassivePacketSource.ned @@ -17,10 +17,10 @@ import inet.queueing.contract.IPassivePacketSource; simple PassivePacketSource extends PassivePacketSourceBase like IPassivePacketSource { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - double initialProvidingOffset @unit(s) = default(0s); // initial duration before which packets are not provided - volatile double providingInterval @unit(s) = default(0s); // elapsed time between subsequent packets allowed to be pulled by the connected packet collector, 0 means any number of packets can be pulled at the same simulation time - bool scheduleForAbsoluteTime = default(true); // when a clock is used relative means that setting the clock will not affect the simulation time of the event + string clockModule = default(""); // Relative path of a module that implements IClock; optional + double initialProvidingOffset @unit(s) = default(0s); // Initial duration before which packets are not provided + volatile double providingInterval @unit(s) = default(0s); // Elapsed time between subsequent packets allowed to be pulled by the connected packet collector, 0 means any number of packets can be pulled at the same simulation time + bool scheduleForAbsoluteTime = default(true); // When a clock is used relative means that setting the clock will not affect the simulation time of the event @class(PassivePacketSource); gates: output out @labels(pull); diff --git a/src/inet/queueing/source/PcapFilePacketProducer.ned b/src/inet/queueing/source/PcapFilePacketProducer.ned index 6fcd90e77f6..78e6a23e615 100644 --- a/src/inet/queueing/source/PcapFilePacketProducer.ned +++ b/src/inet/queueing/source/PcapFilePacketProducer.ned @@ -26,8 +26,8 @@ import inet.queueing.contract.IActivePacketSource; simple PcapFilePacketProducer extends ActivePacketSourceBase like IActivePacketSource { parameters: - string filename; // the PCAP file to be read - packetNameFormat = default("Pcap-%p-%t-%n"); // determines the name of the packets read from the PCAP file + string filename; // The PCAP file to be read + packetNameFormat = default("Pcap-%p-%t-%n"); // Determines the name of the packets read from the PCAP file @class(PcapFilePacketProducer); gates: output out @labels(push); diff --git a/src/inet/queueing/tokengenerator/PacketBasedTokenGenerator.ned b/src/inet/queueing/tokengenerator/PacketBasedTokenGenerator.ned index a9083e60cca..62f16205e03 100644 --- a/src/inet/queueing/tokengenerator/PacketBasedTokenGenerator.ned +++ b/src/inet/queueing/tokengenerator/PacketBasedTokenGenerator.ned @@ -17,8 +17,8 @@ import inet.queueing.contract.IPassivePacketSink; simple PacketBasedTokenGenerator extends TokenGeneratorBase like IPassivePacketSink { parameters: - volatile double numTokensPerPacket = default(1); // number of tokens per consumed packet - volatile double numTokensPerBit = default(0); // number of tokens per consumed bit + volatile double numTokensPerPacket = default(1); // Number of tokens per consumed packet + volatile double numTokensPerBit = default(0); // Number of tokens per consumed bit displayStringTextFormat = default("processed %p pk (%l)\ngenerated %t tk\nto %s"); // %p number of packet, %l total length @class(PacketBasedTokenGenerator); gates: diff --git a/src/inet/queueing/tokengenerator/QueueBasedTokenGenerator.ned b/src/inet/queueing/tokengenerator/QueueBasedTokenGenerator.ned index a081469f355..152f8be4a71 100644 --- a/src/inet/queueing/tokengenerator/QueueBasedTokenGenerator.ned +++ b/src/inet/queueing/tokengenerator/QueueBasedTokenGenerator.ned @@ -23,10 +23,10 @@ import inet.queueing.base.TokenGeneratorBase; simple QueueBasedTokenGenerator extends TokenGeneratorBase { parameters: - string queueModule; // module path of the observed packet queue + string queueModule; // Module path of the observed packet queue int minNumPackets = default(1); int minTotalLength @unit(b) = default(0 b); - volatile double numTokens = default(1); // number of tokens generated when the queue becomes empty + volatile double numTokens = default(1); // Number of tokens generated when the queue becomes empty @class(QueueBasedTokenGenerator); @display("i=block/control"); } diff --git a/src/inet/queueing/tokengenerator/SignalBasedTokenGenerator.ned b/src/inet/queueing/tokengenerator/SignalBasedTokenGenerator.ned index 598f96f0751..80d41e8054c 100644 --- a/src/inet/queueing/tokengenerator/SignalBasedTokenGenerator.ned +++ b/src/inet/queueing/tokengenerator/SignalBasedTokenGenerator.ned @@ -17,7 +17,7 @@ simple SignalBasedTokenGenerator extends TokenGeneratorBase parameters: string subscriptionModule = default("^"); string signals; - volatile double numTokens = default(1); // number of tokens generated repeatedly + volatile double numTokens = default(1); // Number of tokens generated repeatedly @class(SignalBasedTokenGenerator); @display("i=block/control"); } diff --git a/src/inet/queueing/tokengenerator/TimeBasedTokenGenerator.ned b/src/inet/queueing/tokengenerator/TimeBasedTokenGenerator.ned index 1787463dbd5..a4513382df2 100644 --- a/src/inet/queueing/tokengenerator/TimeBasedTokenGenerator.ned +++ b/src/inet/queueing/tokengenerator/TimeBasedTokenGenerator.ned @@ -15,9 +15,9 @@ import inet.queueing.base.TokenGeneratorBase; simple TimeBasedTokenGenerator extends TokenGeneratorBase { parameters: - string clockModule = default(""); // relative path of a module that implements IClock; optional - volatile double generationInterval @unit(s); // time interval between two subsequent token generation events - volatile double numTokens = default(1); // number of tokens generated repeatedly + string clockModule = default(""); // Relative path of a module that implements IClock; optional + volatile double generationInterval @unit(s); // Time interval between two subsequent token generation events + volatile double numTokens = default(1); // Number of tokens generated repeatedly @class(TimeBasedTokenGenerator); @display("i=block/control"); } diff --git a/src/inet/routing/aodv/Aodv.ned b/src/inet/routing/aodv/Aodv.ned index a13291f3945..67bdb56fcdd 100644 --- a/src/inet/routing/aodv/Aodv.ned +++ b/src/inet/routing/aodv/Aodv.ned @@ -34,15 +34,15 @@ simple Aodv like IApp string routingTableModule = default("^.ipv4.routingTable"); string interfaceTableModule = default("^.interfaceTable"); string networkProtocolModule = default("^.ipv4.ip"); - bool askGratuitousRREP = default(false); // see RFC 3561: 6.6.3 - bool useHelloMessages = default(false); // see RFC 3561: 6.9 - bool useLocalRepair = default(false); // see RFC 3561: 6.12 *not implemented yet* - bool destinationOnlyFlag = default(false); // see RFC 3561: 5.1 + bool askGratuitousRREP = default(false); // See RFC 3561: 6.6.3 + bool useHelloMessages = default(false); // See RFC 3561: 6.9 + bool useLocalRepair = default(false); // See RFC 3561: 6.12 *not implemented yet* + bool destinationOnlyFlag = default(false); // See RFC 3561: 5.1 int udpPort = default(654); string interface = default("wlan0"); - double maxPeriodicJitter @unit(s) = default(helloInterval / 4); // it MUST NOT be negative; it MUST NOT be greater than MESSAGE_INTERVAL/2; it SHOULD NOT be greater than MESSAGE_INTERVAL/4. - volatile double periodicJitter @unit(s) = default(uniform(0s, maxPeriodicJitter)); // jitter for externally triggered message generation and message forwarding + double maxPeriodicJitter @unit(s) = default(helloInterval / 4); // It MUST NOT be negative; it MUST NOT be greater than MESSAGE_INTERVAL/2; it SHOULD NOT be greater than MESSAGE_INTERVAL/4. + volatile double periodicJitter @unit(s) = default(uniform(0s, maxPeriodicJitter)); // Jitter for externally triggered message generation and message forwarding // RFC 5148: // need more revise: As well as the decision as to whether @@ -50,30 +50,30 @@ simple Aodv like IApp // lower layers, the selection of the MAXJITTER parameter SHOULD // be appropriate to those mechanisms. double maxJitter @unit(s) = default(5ms); - volatile double jitter @unit(s) = default(uniform(0ms, maxJitter)); // jitter for broadcasts + volatile double jitter @unit(s) = default(uniform(0ms, maxJitter)); // Jitter for broadcasts - double helloInterval @unit(s) = default(1s); // every helloInterval seconds a node broadcasts Hello messages (if it is necessary) - int allowedHelloLoss = default(2); // allowedHelloLoss * helloInterval is the lifetime value for Hello messages - double activeRouteTimeout @unit(s) = default(3s); // the timeout value for cached routes If Hello messages are used, then the + double helloInterval @unit(s) = default(1s); // Every helloInterval seconds a node broadcasts Hello messages (if it is necessary) + int allowedHelloLoss = default(2); // AllowedHelloLoss * helloInterval is the lifetime value for Hello messages + double activeRouteTimeout @unit(s) = default(3s); // The timeout value for cached routes If Hello messages are used, then the // ACTIVE_ROUTE_TIMEOUT parameter value MUST be more than the value // (ALLOWED_HELLO_LOSS * HELLO_INTERVAL). - int netDiameter = default(35); // the maximum possible number of hops between two nodes in the network - double nodeTraversalTime @unit(s) = default(0.04s); // an estimation of the average one-hop traversal time - int rerrRatelimit = default(10); // maximum number of RERR messages that the AODV may originate in 1s. - int rreqRetries = default(2); // specifies the number of times AODV will repeat an expanded ring search for a destination - int rreqRatelimit = default(10); // maximum number of RREQ messages that the AODV may originate in 1s. - int timeoutBuffer = default(2); // plus time to wait for a delayed RREP (due to congestion) (to omit this buffer set it to 0) - int ttlStart = default(2); // specifies the TTL value when initiating a route request - int ttlIncrement = default(2); // specifies the value by which the TTL will be incremented each time a RREQ is retransmitted - int ttlThreshold = default(7); // the maximum value of TTL over which NET_DIAMETER value will be used to broadcast any RREQ - int localAddTTL = default(2); // it is used by the formula which calculates the initial TTL of the RREQ for a local repair + int netDiameter = default(35); // The maximum possible number of hops between two nodes in the network + double nodeTraversalTime @unit(s) = default(0.04s); // An estimation of the average one-hop traversal time + int rerrRatelimit = default(10); // Maximum number of RERR messages that the AODV may originate in 1s. + int rreqRetries = default(2); // Specifies the number of times AODV will repeat an expanded ring search for a destination + int rreqRatelimit = default(10); // Maximum number of RREQ messages that the AODV may originate in 1s. + int timeoutBuffer = default(2); // Plus time to wait for a delayed RREP (due to congestion) (to omit this buffer set it to 0) + int ttlStart = default(2); // Specifies the TTL value when initiating a route request + int ttlIncrement = default(2); // Specifies the value by which the TTL will be incremented each time a RREQ is retransmitted + int ttlThreshold = default(7); // The maximum value of TTL over which NET_DIAMETER value will be used to broadcast any RREQ + int localAddTTL = default(2); // It is used by the formula which calculates the initial TTL of the RREQ for a local repair - double myRouteTimeout @unit(s) = default(2 * activeRouteTimeout); // the value of the lifetime field that a destination node places in RREPs - double deletePeriod @unit(s) = default(5 * max(activeRouteTimeout, helloInterval)); // the time after which an expired route is deleted - double blacklistTimeout @unit(s) = default(rreqRetries * netTraversalTime); // the time after which a blacklisted node is removed from the blacklist - double netTraversalTime @unit(s) = default(2 * nodeTraversalTime * netDiameter); // an estimation of the traversal time for the complete network - double nextHopWait @unit(s) = default(nodeTraversalTime + 0.01s); // timeout for a RREP-ACK - double pathDiscoveryTime @unit(s) = default(2 * netTraversalTime); // buffer timeout for each broadcasted RREQ message + double myRouteTimeout @unit(s) = default(2 * activeRouteTimeout); // The value of the lifetime field that a destination node places in RREPs + double deletePeriod @unit(s) = default(5 * max(activeRouteTimeout, helloInterval)); // The time after which an expired route is deleted + double blacklistTimeout @unit(s) = default(rreqRetries * netTraversalTime); // The time after which a blacklisted node is removed from the blacklist + double netTraversalTime @unit(s) = default(2 * nodeTraversalTime * netDiameter); // An estimation of the traversal time for the complete network + double nextHopWait @unit(s) = default(nodeTraversalTime + 0.01s); // Timeout for a RREP-ACK + double pathDiscoveryTime @unit(s) = default(2 * netTraversalTime); // Buffer timeout for each broadcasted RREQ message gates: input socketIn; output socketOut; diff --git a/src/inet/routing/bgpv4/Bgp.ned b/src/inet/routing/bgpv4/Bgp.ned index c88a0552a76..84319843836 100644 --- a/src/inet/routing/bgpv4/Bgp.ned +++ b/src/inet/routing/bgpv4/Bgp.ned @@ -22,12 +22,12 @@ simple Bgp like IBgp string interfaceTableModule; string routingTableModule; string ospfRoutingModule; - volatile double startupTime @unit(s) = default(0s); // delay before starting BGP + volatile double startupTime @unit(s) = default(0s); // Delay before starting BGP xml bgpConfig; double ExternalPeerStartDelayOffset @unit(s) = default(0.5s); - bool redistributeRip = default(false); // redistribute routes learned by RIP into BGP - string redistributeOspf = default(""); // redistribute routes learned by OSPF into BGP (O IA E1 E2) - bool redistributeInternal = default(false); // redistribute BGP routes into OSPF (as external routes) + bool redistributeRip = default(false); // Redistribute routes learned by RIP into BGP + string redistributeOspf = default(""); // Redistribute routes learned by OSPF into BGP (O IA E1 E2) + bool redistributeInternal = default(false); // Redistribute BGP routes into OSPF (as external routes) bool nextHopSelf = default(false); int localPreference = default(100); bool connectedCheck = default(true); diff --git a/src/inet/routing/dsdv/Dsdv.ned b/src/inet/routing/dsdv/Dsdv.ned index 5cfe55b8498..9f57d5ccf3f 100644 --- a/src/inet/routing/dsdv/Dsdv.ned +++ b/src/inet/routing/dsdv/Dsdv.ned @@ -29,10 +29,10 @@ simple Dsdv like IManetRouting @display("i=block/routing"); string interfaceTableModule; // The path to the InterfaceTable module string routingTableModule; - double helloInterval @unit(s) = default(5s); // how often hello messages should be sent out - string netmask = default("255.255.0.0"); // netmask for the ad-hoc network + double helloInterval @unit(s) = default(5s); // How often hello messages should be sent out + string netmask = default("255.255.0.0"); // Netmask for the ad-hoc network double maxVariance = default(1); // This is the maximum of a random value to determine when the first hello message will be sent out - double routeLifetime @unit(s) = default(5s); // the expiry time of the routing entries + double routeLifetime @unit(s) = default(5s); // The expiry time of the routing entries bool manetPurgeRoutingTables = default(true); volatile double broadcastDelay @unit(s) = default(uniform(0s,0.01s)); gates: diff --git a/src/inet/routing/dymo/Dymo.ned b/src/inet/routing/dymo/Dymo.ned index 9946a609fb5..f54b277ad82 100644 --- a/src/inet/routing/dymo/Dymo.ned +++ b/src/inet/routing/dymo/Dymo.ned @@ -56,7 +56,7 @@ simple Dymo like IManetRouting // double CONTROL_TRAFFIC_LIMIT // Dymo extension parameters - double maxJitter @unit(s) = default(10ms); // see IETF RFC5148 (Jitter Considerations in MANET) + double maxJitter @unit(s) = default(10ms); // See IETF RFC5148 (Jitter Considerations in MANET) bool sendIntermediateRREP = default(true); int minHopLimit = default(5); int maxHopLimit = default(10); diff --git a/src/inet/routing/gpsr/Gpsr.ned b/src/inet/routing/gpsr/Gpsr.ned index 21b5e27908d..0612e437c56 100644 --- a/src/inet/routing/gpsr/Gpsr.ned +++ b/src/inet/routing/gpsr/Gpsr.ned @@ -36,7 +36,7 @@ simple Gpsr like IManetRouting int positionByteLength @unit(B) = default(2 * 4B); // visualization parameters - bool displayBubbles = default(false); // display bubble messages about changes in routing state for packets + bool displayBubbles = default(false); // Display bubble messages about changes in routing state for packets gates: input ipIn; output ipOut; diff --git a/src/inet/routing/ospfv2/Ospfv2.ned b/src/inet/routing/ospfv2/Ospfv2.ned index 60a99bf4729..4e3ec0891c6 100644 --- a/src/inet/routing/ospfv2/Ospfv2.ned +++ b/src/inet/routing/ospfv2/Ospfv2.ned @@ -142,7 +142,7 @@ simple Ospfv2 like IOspf string interfaceTableModule; string routingTableModule; string crcMode @enum("declared", "computed") = default("declared"); - volatile double startupTime @unit(s) = default(0s); // delay before starting OSPF + volatile double startupTime @unit(s) = default(0s); // Delay before starting OSPF // xml containing the full OSPF AS configuration xml ospfConfig = default(xml(" \ \ @@ -154,23 +154,23 @@ simple Ospfv2 like IOspf int routerPriority = default(1); // Priority in DR/BDR election (Specify 0 to exclude the router from the election) string areaID = default("0.0.0.0"); - bool RFC1583Compatible = default(false); // if 'false', prune the set of routing table entries for the ASBR (RFC 3101) - bool DistributeDefaultRoute = default(false); // distribute the default route (if exists) using AS-External LSA + bool RFC1583Compatible = default(false); // If 'false', prune the set of routing table entries for the ASBR (RFC 3101) + bool DistributeDefaultRoute = default(false); // Distribute the default route (if exists) using AS-External LSA - int helloInterval @unit(s) = default(10s); // specifies the time in seconds between hello packets that the other router sends on an interface - int pollInterval @unit(s) = default(120s); // specifies the length of time, in seconds, between OSPF packets that the router send before adjacency is established with a neighbor - int routerDeadInterval @unit(s) = default(40s); // the interval during which at least one hello packet must be received from a neighbor before the router declares that neighbor as down + int helloInterval @unit(s) = default(10s); // Specifies the time in seconds between hello packets that the other router sends on an interface + int pollInterval @unit(s) = default(120s); // Specifies the length of time, in seconds, between OSPF packets that the router send before adjacency is established with a neighbor + int routerDeadInterval @unit(s) = default(40s); // The interval during which at least one hello packet must be received from a neighbor before the router declares that neighbor as down int retransmissionInterval @unit(s) = default(5s); // The time between OSPF LSA retransmissions for adjacencies that belongs to the interface int interfaceTransmissionDelay @unit(s) = default(1s); // The number of seconds required to transmit a link state update packet. Valid values are 1 to 65535 string interfaceMode @enum("Active","Passive","NoOSPF") = default("Active"); // NoOSPF: the interface is not advertized by OSPF // Passive: the interface is advertised, but no OSPF message is send out - int referenceBandwidth @unit(bps) = default(1e8bps); // reference bandwidth for cost calculation - int interfaceOutputCost = default(0); // cost of link on the interface (1-1000), 0 means use reference bandwidth - int externalInterfaceOutputCost = default(1); // cost of link (1-1000) + int referenceBandwidth @unit(bps) = default(1e8bps); // Reference bandwidth for cost calculation + int interfaceOutputCost = default(0); // Cost of link on the interface (1-1000), 0 means use reference bandwidth + int externalInterfaceOutputCost = default(1); // Cost of link (1-1000) string externalInterfaceOutputType = default("Type2"); // Type1|Type2 string forwardingAddress = default("0.0.0.0"); - int linkCost = default(1); // cost of link (1-1000) for HostInterface and LoopbackInterface only + int linkCost = default(1); // Cost of link (1-1000) for HostInterface and LoopbackInterface only string authenticationType @enum("SimplePasswordType","CrytographicType","NullType") = default("NullType"); string authenticationKey = default("0x00"); // 0xnn..nn diff --git a/src/inet/routing/pim/modes/PimSm.ned b/src/inet/routing/pim/modes/PimSm.ned index 77a865e1155..188427a54be 100644 --- a/src/inet/routing/pim/modes/PimSm.ned +++ b/src/inet/routing/pim/modes/PimSm.ned @@ -54,7 +54,7 @@ simple PimSm volatile double triggeredHelloDelay @unit(s) = uniform(0s,5s); double helloPeriod @unit(s) = 30s; double holdTime @unit(s) = default(3.5 * helloPeriod); - double joinPrunePeriod @unit(s) = default(60s); // period between Join/Prune messages (called t_periodic in the RFC) + double joinPrunePeriod @unit(s) = default(60s); // Period between Join/Prune messages (called t_periodic in the RFC) double defaultOverrideInterval @unit(s) = 2.5s; double defaultPropagationDelay @unit(s) = 0.5s; double keepAlivePeriod @unit(s) = 210s; diff --git a/src/inet/routing/rip/Rip.ned b/src/inet/routing/rip/Rip.ned index bb05bcfb028..4720d0217ea 100644 --- a/src/inet/routing/rip/Rip.ned +++ b/src/inet/routing/rip/Rip.ned @@ -64,21 +64,21 @@ simple Rip like IApp string mode @enum("RIPv2", "RIPng") = default("RIPv2"); int udpPort = (mode == "RIPng" ? 521 : 520); - volatile double startupTime @unit(s) = default(uniform(0s,5s)); // delay before starting RIP - double shutdownTime @unit(s) = default(1s); // delay before shutting down RIP + volatile double startupTime @unit(s) = default(uniform(0s,5s)); // Delay before starting RIP + double shutdownTime @unit(s) = default(1s); // Delay before shutting down RIP // RIP timers double updateInterval @unit(s) = default(30s); // 30s timer or update timer - double routeExpiryTime @unit(s) = default(180s); // invalid timer - double routePurgeTime @unit(s) = default(120s); // garbage collection timer or flush timer - double holdDownTime @unit(s) = default(0s); // hold-down timer (not defined in RFC). 0s means not active + double routeExpiryTime @unit(s) = default(180s); // Invalid timer + double routePurgeTime @unit(s) = default(120s); // Garbage collection timer or flush timer + double holdDownTime @unit(s) = default(0s); // Hold-down timer (not defined in RFC). 0s means not active - bool triggeredUpdate = default(true); // sending triggered updates on route changes + bool triggeredUpdate = default(true); // Sending triggered updates on route changes volatile double triggeredUpdateDelay @unit(s) = default(uniform(1s,5s)); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @signal[sentRequest](type=cPacket); @signal[sentUpdate](type=cPacket); diff --git a/src/inet/transportlayer/rtp/RtpPayloadReceiver.ned b/src/inet/transportlayer/rtp/RtpPayloadReceiver.ned index c25db2d2077..0ff8af61216 100644 --- a/src/inet/transportlayer/rtp/RtpPayloadReceiver.ned +++ b/src/inet/transportlayer/rtp/RtpPayloadReceiver.ned @@ -16,8 +16,8 @@ package inet.transportlayer.rtp; moduleinterface IRTPPayloadReceiver { parameters: - string outputFileName; // use an empty string to disable this logging - string outputLogFileName; // use an empty string to disable this logging + string outputFileName; // Use an empty string to disable this logging + string outputLogFileName; // Use an empty string to disable this logging gates: input profileIn @labels(RtpInnerPacket); diff --git a/src/inet/transportlayer/sctp/Sctp.ned b/src/inet/transportlayer/sctp/Sctp.ned index df2d85055f8..f64eeef1703 100644 --- a/src/inet/transportlayer/sctp/Sctp.ned +++ b/src/inet/transportlayer/sctp/Sctp.ned @@ -51,7 +51,7 @@ simple Sctp like ISctp int naglePoint = default(1468); //#====== Fragmentation ============================================= - int fragPoint = default(1452); // size of a message that has to be fragmented, i.e. maximum size of a fragment + int fragPoint = default(1452); // Size of a message that has to be fragmented, i.e. maximum size of a fragment //#====== Congestion Control ========================================== bool fastRecoverySupported = default(true); @@ -66,10 +66,10 @@ simple Sctp like ISctp int swsLimit = default(3000); // Limit for SWS bool udpEncapsEnabled = default(false); bool natFriendly = default(false); - int bytesToAddPerRcvdChunk = default(0); // for flowcontrol - int bytesToAddPerPeerChunk = default(0); // for flowcontrol - bool tellArwnd = default(false); // for flowcontrol - int messageAcceptLimit = default(0); // for flowcontrol + int bytesToAddPerRcvdChunk = default(0); // For flowcontrol + int bytesToAddPerPeerChunk = default(0); // For flowcontrol + bool tellArwnd = default(false); // For flowcontrol + int messageAcceptLimit = default(0); // For flowcontrol double fairStart @unit(s) = default(0s); double fairStop @unit(s) = default(0s); string streamsToPaths = default(""); diff --git a/src/inet/transportlayer/tcp/Tcp.ned b/src/inet/transportlayer/tcp/Tcp.ned index 9e489a831ed..33603e481d1 100644 --- a/src/inet/transportlayer/tcp/Tcp.ned +++ b/src/inet/transportlayer/tcp/Tcp.ned @@ -154,8 +154,8 @@ simple Tcp like ITcp { parameters: string crcMode @enum("declared", "computed") = default("declared"); - int advertisedWindow = default(14*this.mss); // in bytes, corresponds with the maximal receiver buffer capacity (Note: normally, NIC queues should be at least this size) - bool delayedAcksEnabled = default(false); // delayed ACK algorithm (RFC 1122) enabled/disabled + int advertisedWindow = default(14*this.mss); // In bytes, corresponds with the maximal receiver buffer capacity (Note: normally, NIC queues should be at least this size) + bool delayedAcksEnabled = default(false); // Delayed ACK algorithm (RFC 1122) enabled/disabled bool nagleEnabled = default(true); // Nagle's algorithm (RFC 896) enabled/disabled bool limitedTransmitEnabled = default(false); // Limited Transmit algorithm (RFC 3042) enabled/disabled (can be used for TcpReno/TcpTahoe/TcpNewReno/TcpNoCongestionControl) bool increasedIWEnabled = default(false); // Increased Initial Window (RFC 3390) enabled/disabled @@ -166,11 +166,11 @@ simple Tcp like ITcp int mss = default(536); // Maximum Segment Size (RFC 793) (header option) int msl @unit(s) = default(120s); // Maximum Segment Lifetime string tcpAlgorithmClass @examples("TcpVegas", "TcpWestwood", "DcTcp", "TcpNewReno", "TcpReno", "TcpTahoe", "TcpNoCongestionControl") = default("TcpReno"); - int dupthresh = default(3); // used for TcpTahoe, TcpReno and SACK (RFC 3517) DO NOT change unless you really know what you are doing - int initialSsthresh = default(0xFFFFFFFF); // initial value for Slow Start threshold used in TahoeRenoFamily. The initial value of ssthresh SHOULD be set arbitrarily high (e.g.,to the size of the largest possible advertised window) Without user interaction there is no limit... - double stopOperationExtraTime @unit(s) = default(0s); // extra time after lifecycle stop operation finished - double stopOperationTimeout @unit(s) = default(2s); // timeout value for lifecycle stop operation - bool ecnWillingness = default(false); // true if willing to use ECN + int dupthresh = default(3); // Used for TcpTahoe, TcpReno and SACK (RFC 3517) DO NOT change unless you really know what you are doing + int initialSsthresh = default(0xFFFFFFFF); // Initial value for Slow Start threshold used in TahoeRenoFamily. The initial value of ssthresh SHOULD be set arbitrarily high (e.g.,to the size of the largest possible advertised window) Without user interaction there is no limit... + double stopOperationExtraTime @unit(s) = default(0s); // Extra time after lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation + bool ecnWillingness = default(false); // True if willing to use ECN double dctcpGamma = default(0.0625); // A fixed estimation gain for calculating dctcp_alpha (RFC 8257 4.2) @display("i=block/wheelbarrow"); @signal[tcpConnectionAdded]; diff --git a/src/inet/transportlayer/tcp/TcpConnection.ned b/src/inet/transportlayer/tcp/TcpConnection.ned index d281adc9809..797570d2145 100644 --- a/src/inet/transportlayer/tcp/TcpConnection.ned +++ b/src/inet/transportlayer/tcp/TcpConnection.ned @@ -11,68 +11,68 @@ package inet.transportlayer.tcp; simple TcpConnection { parameters: @signal[state]; // FSM state - @signal[sndWnd]; // snd_wnd - @signal[rcvWnd]; // rcv_wnd - @signal[rcvAdv]; // current advertised window (=rcv_adv) - @signal[sndNxt]; // sent seqNo - @signal[sndAck]; // sent ackNo - @signal[rcvSeq]; // received seqNo - @signal[rcvAck]; // received ackNo (=snd_una) - @signal[unacked]; // number of bytes unacknowledged - @signal[dupAcks]; // current number of received dupAcks - @signal[pipe]; // current sender's estimate of bytes outstanding in the network - @signal[sndSacks]; // number of sent Sacks - @signal[rcvSacks]; // number of received Sacks - @signal[rcvOooSeg]; // number of received out-of-order segments - @signal[rcvNASeg]; // number of received not acceptable segments - @signal[sackedBytes]; // current number of received sacked bytes - @signal[tcpRcvQueueBytes]; // current amount of used bytes in tcp receive queue - @signal[tcpRcvQueueDrops]; // number of drops in tcp receive queue - @signal[tcpRcvPayloadBytes]; // amount of payload bytes received (including duplicates, out of order etc) for TCP throughput + @signal[sndWnd]; // Snd_wnd + @signal[rcvWnd]; // Rcv_wnd + @signal[rcvAdv]; // Current advertised window (=rcv_adv) + @signal[sndNxt]; // Sent seqNo + @signal[sndAck]; // Sent ackNo + @signal[rcvSeq]; // Received seqNo + @signal[rcvAck]; // Received ackNo (=snd_una) + @signal[unacked]; // Number of bytes unacknowledged + @signal[dupAcks]; // Current number of received dupAcks + @signal[pipe]; // Current sender's estimate of bytes outstanding in the network + @signal[sndSacks]; // Number of sent Sacks + @signal[rcvSacks]; // Number of received Sacks + @signal[rcvOooSeg]; // Number of received out-of-order segments + @signal[rcvNASeg]; // Number of received not acceptable segments + @signal[sackedBytes]; // Current number of received sacked bytes + @signal[tcpRcvQueueBytes]; // Current amount of used bytes in tcp receive queue + @signal[tcpRcvQueueDrops]; // Number of drops in tcp receive queue + @signal[tcpRcvPayloadBytes]; // Amount of payload bytes received (including duplicates, out of order etc) for TCP throughput //TcpAlgorithm signals: - @signal[cwnd]; // will record changes to snd_cwnd - @signal[ssthresh]; // will record changes to ssthresh - @signal[rtt]; // will record measured RTT - @signal[srtt]; // will record smoothed RTT - @signal[rttvar]; // will record RTT variance (rttvar) - @signal[rto]; // will record retransmission timeout - @signal[numRtos]; // will record total number of RTOs + @signal[cwnd]; // Will record changes to snd_cwnd + @signal[ssthresh]; // Will record changes to ssthresh + @signal[rtt]; // Will record measured RTT + @signal[srtt]; // Will record smoothed RTT + @signal[rttvar]; // Will record RTT variance (rttvar) + @signal[rto]; // Will record retransmission timeout + @signal[numRtos]; // Will record total number of RTOs - @signal[load]; // will record load (currently only with DcTcp) - @signal[calcLoad]; // will record calcLoad (currently only with DcTcp) - @signal[markingProb]; // will record marking probability (currently only with DcTcp) + @signal[load]; // Will record load (currently only with DcTcp) + @signal[calcLoad]; // Will record calcLoad (currently only with DcTcp) + @signal[markingProb]; // Will record marking probability (currently only with DcTcp) @statistic[state](record=vector; interpolationmode=sample-hold); - @statistic[sndWnd](record=vector; interpolationmode=sample-hold); // snd_wnd - @statistic[rcvWnd](record=vector; interpolationmode=sample-hold); // rcv_wnd - @statistic[rcvAdv](record=vector; interpolationmode=sample-hold); // current advertised window (=rcv_adv) - @statistic[sndNxt](record=vector; interpolationmode=sample-hold); // sent seqNo - @statistic[sndAck](record=vector; interpolationmode=sample-hold); // sent ackNo - @statistic[rcvSeq](record=vector; interpolationmode=sample-hold); // received seqNo - @statistic[rcvAck](record=vector; interpolationmode=sample-hold); // received ackNo (=snd_una) - @statistic[unacked](record=vector; interpolationmode=sample-hold); // number of bytes unacknowledged - @statistic[dupAcks](record=vector; interpolationmode=sample-hold); // current number of received dupAcks - @statistic[pipe](record=vector; interpolationmode=sample-hold); // current sender's estimate of bytes outstanding in the network - @statistic[sndSacks](record=vector; interpolationmode=sample-hold); // number of sent Sacks - @statistic[rcvSacks](record=vector; interpolationmode=sample-hold); // number of received Sacks - @statistic[rcvOooSeg](record=vector; interpolationmode=sample-hold); // number of received out-of-order segments - @statistic[rcvNASeg](record=vector; interpolationmode=sample-hold); // number of received not acceptable segments - @statistic[sackedBytes](record=vector; interpolationmode=sample-hold); // current number of received sacked bytes - @statistic[tcpRcvQueueBytes](record=vector; interpolationmode=sample-hold); // current amount of used bytes in tcp receive queue - @statistic[tcpRcvQueueDrops](record=vector; interpolationmode=sample-hold); // number of drops in tcp receive queue - @statistic[tcpRcvPayloadBytes](record=vector; interpolationmode=sample-hold); // current amount of payload bytes received (including duplicates, out of order etc) for TCP throughput + @statistic[sndWnd](record=vector; interpolationmode=sample-hold); // Snd_wnd + @statistic[rcvWnd](record=vector; interpolationmode=sample-hold); // Rcv_wnd + @statistic[rcvAdv](record=vector; interpolationmode=sample-hold); // Current advertised window (=rcv_adv) + @statistic[sndNxt](record=vector; interpolationmode=sample-hold); // Sent seqNo + @statistic[sndAck](record=vector; interpolationmode=sample-hold); // Sent ackNo + @statistic[rcvSeq](record=vector; interpolationmode=sample-hold); // Received seqNo + @statistic[rcvAck](record=vector; interpolationmode=sample-hold); // Received ackNo (=snd_una) + @statistic[unacked](record=vector; interpolationmode=sample-hold); // Number of bytes unacknowledged + @statistic[dupAcks](record=vector; interpolationmode=sample-hold); // Current number of received dupAcks + @statistic[pipe](record=vector; interpolationmode=sample-hold); // Current sender's estimate of bytes outstanding in the network + @statistic[sndSacks](record=vector; interpolationmode=sample-hold); // Number of sent Sacks + @statistic[rcvSacks](record=vector; interpolationmode=sample-hold); // Number of received Sacks + @statistic[rcvOooSeg](record=vector; interpolationmode=sample-hold); // Number of received out-of-order segments + @statistic[rcvNASeg](record=vector; interpolationmode=sample-hold); // Number of received not acceptable segments + @statistic[sackedBytes](record=vector; interpolationmode=sample-hold); // Current number of received sacked bytes + @statistic[tcpRcvQueueBytes](record=vector; interpolationmode=sample-hold); // Current amount of used bytes in tcp receive queue + @statistic[tcpRcvQueueDrops](record=vector; interpolationmode=sample-hold); // Number of drops in tcp receive queue + @statistic[tcpRcvPayloadBytes](record=vector; interpolationmode=sample-hold); // Current amount of payload bytes received (including duplicates, out of order etc) for TCP throughput - @statistic[cwnd](record=vector; interpolationmode=sample-hold); // will record changes to snd_cwnd - @statistic[ssthresh](record=vector; interpolationmode=sample-hold); // will record changes to ssthresh - @statistic[rtt](record=vector; interpolationmode=sample-hold); // will record measured RTT - @statistic[srtt](record=vector; interpolationmode=sample-hold); // will record smoothed RTT - @statistic[rttvar](record=vector; interpolationmode=sample-hold); // will record RTT variance (rttvar) - @statistic[rto](record=vector; interpolationmode=sample-hold); // will record retransmission timeout - @statistic[numRtos](record=vector; interpolationmode=sample-hold); // will record total number of RTOs + @statistic[cwnd](record=vector; interpolationmode=sample-hold); // Will record changes to snd_cwnd + @statistic[ssthresh](record=vector; interpolationmode=sample-hold); // Will record changes to ssthresh + @statistic[rtt](record=vector; interpolationmode=sample-hold); // Will record measured RTT + @statistic[srtt](record=vector; interpolationmode=sample-hold); // Will record smoothed RTT + @statistic[rttvar](record=vector; interpolationmode=sample-hold); // Will record RTT variance (rttvar) + @statistic[rto](record=vector; interpolationmode=sample-hold); // Will record retransmission timeout + @statistic[numRtos](record=vector; interpolationmode=sample-hold); // Will record total number of RTOs - @statistic[load](record=vector; interpolationmode=sample-hold); // will record load (currently only with DcTcp) - @statistic[calcLoad](record=vector; interpolationmode=sample-hold); // will record calcLoad (currently only with DcTcp) - @statistic[markingProb](record=vector; interpolationmode=sample-hold); // will record marking probability (currently only with DcTcp) + @statistic[load](record=vector; interpolationmode=sample-hold); // Will record load (currently only with DcTcp) + @statistic[calcLoad](record=vector; interpolationmode=sample-hold); // Will record calcLoad (currently only with DcTcp) + @statistic[markingProb](record=vector; interpolationmode=sample-hold); // Will record marking probability (currently only with DcTcp) } diff --git a/src/inet/transportlayer/tcp_common/TcpSpoof.ned b/src/inet/transportlayer/tcp_common/TcpSpoof.ned index d37f6f3e21e..2098ed8c06c 100644 --- a/src/inet/transportlayer/tcp_common/TcpSpoof.ned +++ b/src/inet/transportlayer/tcp_common/TcpSpoof.ned @@ -19,13 +19,13 @@ import inet.transportlayer.contract.ITcp; simple TcpSpoof like ITcp { parameters: - string srcAddress = default(""); // local address; may be left empty ("") - string destAddress = default(""); // destination address - int srcPort; // local port number - int destPort; // destination port number - int seqNo; // sequence number (-1 for TCP ISS) - bool isSYN = default(true); // whether to set SYN bit on packet - double t @unit(s); // simulation time to send at + string srcAddress = default(""); // Local address; may be left empty ("") + string destAddress = default(""); // Destination address + int srcPort; // Local port number + int destPort; // Destination port number + int seqNo; // Sequence number (-1 for TCP ISS) + bool isSYN = default(true); // Whether to set SYN bit on packet + double t @unit(s); // Simulation time to send at @display("i=block/square"); @signal[packetSent](type=cPacket); @statistic[packetSent](title="packets sent"; source=packetSent; record=count,"sum(packetBytes)","vector(packetBytes)"; interpolationmode=none); diff --git a/src/inet/transportlayer/tcp_lwip/TcpLwipConnection.ned b/src/inet/transportlayer/tcp_lwip/TcpLwipConnection.ned index 1baa41f9183..d0b442d8a9c 100644 --- a/src/inet/transportlayer/tcp_lwip/TcpLwipConnection.ned +++ b/src/inet/transportlayer/tcp_lwip/TcpLwipConnection.ned @@ -11,18 +11,18 @@ package inet.transportlayer.tcp_lwip; simple TcpLwipConnection { parameters: @signal[state]; // FSM state - @signal[sndWnd]; // snd_wnd - @signal[sndNxt]; // sent seqNo - @signal[sndAck]; // sent ackNo - @signal[rcvWnd]; // rcv_wnd - @signal[rcvSeq]; // received seqNo - @signal[rcvAck]; // received ackNo (=snd_una) + @signal[sndWnd]; // Snd_wnd + @signal[sndNxt]; // Sent seqNo + @signal[sndAck]; // Sent ackNo + @signal[rcvWnd]; // Rcv_wnd + @signal[rcvSeq]; // Received seqNo + @signal[rcvAck]; // Received ackNo (=snd_una) - @statistic[sndWnd](record=vector; interpolationmode=sample-hold); // snd_wnd - @statistic[sndNxt](record=vector; interpolationmode=sample-hold); // sent seqNo - @statistic[sndAck](record=vector; interpolationmode=sample-hold); // sent ackNo - @statistic[rcvWnd](record=vector; interpolationmode=sample-hold); // rcv_wnd - @statistic[rcvSeq](record=vector; interpolationmode=sample-hold); // received seqNo - @statistic[rcvAck](record=vector; interpolationmode=sample-hold); // received ackNo (=snd_una) + @statistic[sndWnd](record=vector; interpolationmode=sample-hold); // Snd_wnd + @statistic[sndNxt](record=vector; interpolationmode=sample-hold); // Sent seqNo + @statistic[sndAck](record=vector; interpolationmode=sample-hold); // Sent ackNo + @statistic[rcvWnd](record=vector; interpolationmode=sample-hold); // Rcv_wnd + @statistic[rcvSeq](record=vector; interpolationmode=sample-hold); // Received seqNo + @statistic[rcvAck](record=vector; interpolationmode=sample-hold); // Received ackNo (=snd_una) } diff --git a/src/inet/transportlayer/udp/Udp.ned b/src/inet/transportlayer/udp/Udp.ned index 6e0ef83c6a7..19e235b2471 100644 --- a/src/inet/transportlayer/udp/Udp.ned +++ b/src/inet/transportlayer/udp/Udp.ned @@ -75,8 +75,8 @@ simple Udp like IUdp @statistic[passedUpPk](title="packets passed up"; source=packetSentToUpper; record=count,"vector(count)"; interpolationmode=none); @statistic[droppedPkWrongPort](title="packets dropped (wrong port)"; source=packetDropReasonIsNoPortFound(packetDropped); record=count,"vector(count)"; interpolationmode=none); @statistic[droppedPkBadChecksum](title="packets dropped (checksum error)"; source=packetDropReasonIsIncorrectlyReceived(packetDropped); record=count,"vector(count)"; interpolationmode=none); - @selfMessageKinds(); // kind not used in self messages or model doesn't use any self message - @directSendKinds(); // kind not used in sendDirect() messages or model doesn't use any sendDirect() + @selfMessageKinds(); // Kind not used in self messages or model doesn't use any self message + @directSendKinds(); // Kind not used in sendDirect() messages or model doesn't use any sendDirect() gates: input appIn @labels(UdpControlInfo/down) @messageKinds(inet::UdpCommandCode); diff --git a/src/inet/visualizer/base/ChannelVisualizerBase.ned b/src/inet/visualizer/base/ChannelVisualizerBase.ned index 0d402f4b8ba..20817b9dc17 100644 --- a/src/inet/visualizer/base/ChannelVisualizerBase.ned +++ b/src/inet/visualizer/base/ChannelVisualizerBase.ned @@ -10,30 +10,30 @@ package inet.visualizer.base; simple ChannelVisualizerBase extends VisualizerBase { parameters: - bool displayChannelActivity = default(false); // display arrows for active channels, disabled by default + bool displayChannelActivity = default(false); // Display arrows for active channels, disabled by default - string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default - object packetFilter @mutable = default("*"); // which packets are considered, matches all packets by default + string nodeFilter @mutable = default("*"); // Which nodes are considered, matches all nodes by default + object packetFilter @mutable = default("*"); // Which packets are considered, matches all packets by default string lineColor = default("blue"); // arrow color, black by default - string lineStyle = default("solid"); // arrow style (solid, dashed, dotted) - double lineWidth = default(3); // arrow width + string lineStyle = default("solid"); // Arrow style (solid, dashed, dotted) + double lineWidth = default(3); // Arrow width - double lineShift = default(16); // line shift to avoid overlapping arrows - string lineShiftMode = default("normal"); // determines how overlapping arrows are shifted, possible values are: none, normal, x, y, z; optional prefix + or - + double lineShift = default(16); // Line shift to avoid overlapping arrows + string lineShiftMode = default("normal"); // Determines how overlapping arrows are shifted, possible values are: none, normal, x, y, z; optional prefix + or - - double lineContactSpacing = default(3); // spacing between arrow end and submodule icon - string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // determines how arrows are clipped at the submodules + double lineContactSpacing = default(3); // Spacing between arrow end and submodule icon + string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // Determines how arrows are clipped at the submodules - string labelFormat = default("%n"); // determines what data is displayed - string labelFont = default(", 8px"); // label font, automatic by default - string labelColor = default("blue"); // label color, black by default + string labelFormat = default("%n"); // Determines what data is displayed + string labelFont = default(", 8px"); // Label font, automatic by default + string labelColor = default("blue"); // Label color, black by default - string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // specifies how inactive channels fade out - double fadeOutTime @unit(s) = default(1s); // how quickly inactive channels fade away, 1 second by default - double fadeOutAnimationSpeed = default(0); // animation speed while there are active channels, value must be in the range (0, +inf) + string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // Specifies how inactive channels fade out + double fadeOutTime @unit(s) = default(1s); // How quickly inactive channels fade away, 1 second by default + double fadeOutAnimationSpeed = default(0); // Animation speed while there are active channels, value must be in the range (0, +inf) - double holdAnimationTime @unit(s) = default(0s); // hold simulation (no progress) for the specified amount of animation time when the channel is activated + double holdAnimationTime @unit(s) = default(0s); // Hold simulation (no progress) for the specified amount of animation time when the channel is activated @class(ChannelVisualizerBase); } diff --git a/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned b/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned index 555e563d57a..3d509182ef1 100644 --- a/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned +++ b/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned @@ -15,18 +15,18 @@ package inet.visualizer.base; simple EnergyStorageVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default bool displayEnergyStorages = default(false); - string energyStorageFilter = default("**"); // which energy storages are considered, matches all energy storages by default + string energyStorageFilter = default("**"); // Which energy storages are considered, matches all energy storages by default string color = default("green"); double width = default(8); double height = default(24); double spacing = default(2); - string placementHint = default("right"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string placementHint = default("right"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning @class(EnergyStorageVisualizerBase); } diff --git a/src/inet/visualizer/base/GateScheduleVisualizerBase.ned b/src/inet/visualizer/base/GateScheduleVisualizerBase.ned index a31244224fe..d47561f49b2 100644 --- a/src/inet/visualizer/base/GateScheduleVisualizerBase.ned +++ b/src/inet/visualizer/base/GateScheduleVisualizerBase.ned @@ -21,21 +21,21 @@ package inet.visualizer.base; simple GateScheduleVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default bool displayGateSchedules = default(false); string labelFormat = default("%i %D"); - string gateFilter = default("**"); // which gates are considered, matches all gates by default + string gateFilter = default("**"); // Which gates are considered, matches all gates by default double width = default(100); double height = default(8); double spacing = default(2); - string placementHint = default("right"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string placementHint = default("right"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning - double displayDuration @mutable @unit(s) = default(0s); // gate operation time duration visualized in the amount of space available, use gate period by default - double currentTimePosition = default(width / 2); // position of the current simulation time in the visualization, horizontal center by default + double displayDuration @mutable @unit(s) = default(0s); // Gate operation time duration visualized in the amount of space available, use gate period by default + double currentTimePosition = default(width / 2); // Position of the current simulation time in the visualization, horizontal center by default @class(GateScheduleVisualizerBase); } diff --git a/src/inet/visualizer/base/Ieee80211VisualizerBase.ned b/src/inet/visualizer/base/Ieee80211VisualizerBase.ned index 8bfc629a175..464da225ee7 100644 --- a/src/inet/visualizer/base/Ieee80211VisualizerBase.ned +++ b/src/inet/visualizer/base/Ieee80211VisualizerBase.ned @@ -21,22 +21,22 @@ package inet.visualizer.base; simple Ieee80211VisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default - bool displayAssociations = default(false); // display association icon and SSID, disabled by default + bool displayAssociations = default(false); // Display association icon and SSID, disabled by default - string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default - string interfaceFilter @mutable = default("*"); // which interfaces are considered, matches all interfaces by default + string nodeFilter @mutable = default("*"); // Which nodes are considered, matches all nodes by default + string interfaceFilter @mutable = default("*"); // Which interfaces are considered, matches all interfaces by default - double minPower @unit(dBm) = default(-85dBm); // minimum expected signal power - double maxPower @unit(dBm) = default(-50dBm); // maximum expeceted signal power + double minPower @unit(dBm) = default(-85dBm); // Minimum expected signal power + double maxPower @unit(dBm) = default(-50dBm); // Maximum expeceted signal power - string icons = default("misc/signal_power_0 misc/signal_power_1 misc/signal_power_2 misc/signal_power_3"); // wireless network visualization icon for different signal powers - string iconColor = default("dark"); // wireless network icon color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - string labelFont = default(""); // label font, automatic by default - string labelColor = default("black"); // label color, black by default - string placementHint = default("top"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string icons = default("misc/signal_power_0 misc/signal_power_1 misc/signal_power_2 misc/signal_power_3"); // Wireless network visualization icon for different signal powers + string iconColor = default("dark"); // Wireless network icon color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + string labelFont = default(""); // Label font, automatic by default + string labelColor = default("black"); // Label color, black by default + string placementHint = default("top"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning @class(Ieee80211VisualizerBase); } diff --git a/src/inet/visualizer/base/InfoVisualizerBase.ned b/src/inet/visualizer/base/InfoVisualizerBase.ned index 036f80f5b52..b2bb0ee2b7c 100644 --- a/src/inet/visualizer/base/InfoVisualizerBase.ned +++ b/src/inet/visualizer/base/InfoVisualizerBase.ned @@ -25,21 +25,21 @@ package inet.visualizer.base; simple InfoVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default bool displayInfos = default(true); - string modules @mutable = default(""); // specifies the path of the submodules of network nodes, no submodules by default - string format @mutable = default("%t"); // determines what is displayed on network nodes - - string font = default(""); // info text font, automatic by default - string textColor = default("black"); // info text font color - string textAlignment @enum("left", "right", "center") = default("left"); // alignment of multi-line text - string backgroundColor = default("white"); // text box fill color, specify empty string for no fill - string lineColor = default("black"); // text box outline color, specify empty string for no line - double opacity = default(1.0); // opacity of the visualization - string placementHint = default("top"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string modules @mutable = default(""); // Specifies the path of the submodules of network nodes, no submodules by default + string format @mutable = default("%t"); // Determines what is displayed on network nodes + + string font = default(""); // Info text font, automatic by default + string textColor = default("black"); // Info text font color + string textAlignment @enum("left", "right", "center") = default("left"); // Alignment of multi-line text + string backgroundColor = default("white"); // Text box fill color, specify empty string for no fill + string lineColor = default("black"); // Text box outline color, specify empty string for no line + double opacity = default(1.0); // Opacity of the visualization + string placementHint = default("top"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning @class(InfoVisualizerBase); } diff --git a/src/inet/visualizer/base/InterfaceTableVisualizerBase.ned b/src/inet/visualizer/base/InterfaceTableVisualizerBase.ned index 9d7b596c1c0..a549fec943a 100644 --- a/src/inet/visualizer/base/InterfaceTableVisualizerBase.ned +++ b/src/inet/visualizer/base/InterfaceTableVisualizerBase.ned @@ -37,23 +37,23 @@ package inet.visualizer.base; simple InterfaceTableVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default - bool displayInterfaceTables = default(false); // display interface table data, disabled by default - bool displayWiredInterfacesAtConnections = default(true); // specifies where wired interfaces are displayed - bool displayBackground = default(false); // specifies whether the text should have a background or not + bool displayInterfaceTables = default(false); // Display interface table data, disabled by default + bool displayWiredInterfacesAtConnections = default(true); // Specifies where wired interfaces are displayed + bool displayBackground = default(false); // Specifies whether the text should have a background or not - string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default - string interfaceFilter @mutable = default("not(lo*)"); // which interfaces are considered, matches all non-local interfaces by default + string nodeFilter @mutable = default("*"); // Which nodes are considered, matches all nodes by default + string interfaceFilter @mutable = default("not(lo*)"); // Which interfaces are considered, matches all non-local interfaces by default - string format @mutable = default("%N %\\%a%/%l"); // determines what interface data is displayed - string placementHint = default("top"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string format @mutable = default("%N %\\%a%/%l"); // Determines what interface data is displayed + string placementHint = default("top"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning - string font = default(""); // interface text font, automatic by default - string textColor = default("#005030"); // interface text font color - string backgroundColor = default("white"); // interface text background color - double opacity = default(1.0); // opacity of the visualization + string font = default(""); // Interface text font, automatic by default + string textColor = default("#005030"); // Interface text font color + string backgroundColor = default("white"); // Interface text background color + double opacity = default(1.0); // Opacity of the visualization @class(InterfaceTableVisualizerBase); } diff --git a/src/inet/visualizer/base/LinkBreakVisualizerBase.ned b/src/inet/visualizer/base/LinkBreakVisualizerBase.ned index 197c0d1f909..781613c8b4e 100644 --- a/src/inet/visualizer/base/LinkBreakVisualizerBase.ned +++ b/src/inet/visualizer/base/LinkBreakVisualizerBase.ned @@ -22,19 +22,19 @@ package inet.visualizer.base; simple LinkBreakVisualizerBase extends VisualizerBase { parameters: - bool displayLinkBreaks = default(false); // display icons for link breaks, disabled by default + bool displayLinkBreaks = default(false); // Display icons for link breaks, disabled by default - string nodeFilter @mutable = default("*"); // which network nodes are considered, matches all nodes by default - string interfaceFilter @mutable = default("*"); // which interfaces are considered, matches all interfaces by default - object packetFilter @mutable = default("*"); // which packets are considered, matches all packets by default + string nodeFilter @mutable = default("*"); // Which network nodes are considered, matches all nodes by default + string interfaceFilter @mutable = default("*"); // Which interfaces are considered, matches all interfaces by default + object packetFilter @mutable = default("*"); // Which packets are considered, matches all packets by default string icon = default("status/stop"); double iconTintAmount = default(0); string iconTintColor = default(""); - string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // specifies how inactive link breaks fade out - double fadeOutTime @unit(s) = default(1s); // how quickly link breaks fade away, 1 second by default - double fadeOutAnimationSpeed = default(0); // animation speed while there are link breaks, value must be in the range (0, +inf) + string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // Specifies how inactive link breaks fade out + double fadeOutTime @unit(s) = default(1s); // How quickly link breaks fade away, 1 second by default + double fadeOutAnimationSpeed = default(0); // Animation speed while there are link breaks, value must be in the range (0, +inf) @class(LinkBreakVisualizerBase); } diff --git a/src/inet/visualizer/base/LinkVisualizerBase.ned b/src/inet/visualizer/base/LinkVisualizerBase.ned index 0065e5fe16c..38f470ce649 100644 --- a/src/inet/visualizer/base/LinkVisualizerBase.ned +++ b/src/inet/visualizer/base/LinkVisualizerBase.ned @@ -29,32 +29,32 @@ package inet.visualizer.base; simple LinkVisualizerBase extends VisualizerBase { parameters: - bool displayLinks = default(false); // display arrows for active links, disabled by default - string activityLevel @enum("service", "peer", "protocol") = default("service"); // determines what level of activity is displayed, service level by default + bool displayLinks = default(false); // Display arrows for active links, disabled by default + string activityLevel @enum("service", "peer", "protocol") = default("service"); // Determines what level of activity is displayed, service level by default - string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default - string interfaceFilter @mutable = default("*"); // which interfaces are considered, matches all interfaces by default - object packetFilter @mutable = default("*"); // which packets are considered, matches all packets by default + string nodeFilter @mutable = default("*"); // Which nodes are considered, matches all nodes by default + string interfaceFilter @mutable = default("*"); // Which interfaces are considered, matches all interfaces by default + object packetFilter @mutable = default("*"); // Which packets are considered, matches all packets by default - string lineColor = default("black"); // link arrow color, black by default - string lineStyle = default("solid"); // link arrow style (solid, dashed, dotted) - double lineWidth = default(3); // link arrow width + string lineColor = default("black"); // Link arrow color, black by default + string lineStyle = default("solid"); // Link arrow style (solid, dashed, dotted) + double lineWidth = default(3); // Link arrow width - double lineShift = default(16); // line shift to avoid overlapping arrows - string lineShiftMode = default("normal"); // determines how overlapping arrows are shifted, possible values are: none, normal, x, y, z; optional prefix + or - + double lineShift = default(16); // Line shift to avoid overlapping arrows + string lineShiftMode = default("normal"); // Determines how overlapping arrows are shifted, possible values are: none, normal, x, y, z; optional prefix + or - - double lineContactSpacing = default(3); // spacing between arrow end and submodule icon - string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // determines how arrows are clipped at the submodules + double lineContactSpacing = default(3); // Spacing between arrow end and submodule icon + string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // Determines how arrows are clipped at the submodules - string labelFormat = default("%n"); // determines what link data is displayed - string labelFont = default(", 8px"); // label font, automatic by default - string labelColor = default("black"); // label color, black by default + string labelFormat = default("%n"); // Determines what link data is displayed + string labelFont = default(", 8px"); // Label font, automatic by default + string labelColor = default("black"); // Label color, black by default - string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // specifies how inactive links fade out - double fadeOutTime @unit(s) = default(1s); // how quickly inactive links fade away, 1 second by default - double fadeOutAnimationSpeed = default(0); // animation speed while there are active links, value must be in the range (0, +inf) + string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // Specifies how inactive links fade out + double fadeOutTime @unit(s) = default(1s); // How quickly inactive links fade away, 1 second by default + double fadeOutAnimationSpeed = default(0); // Animation speed while there are active links, value must be in the range (0, +inf) - double holdAnimationTime @unit(s) = default(0s); // hold simulation (no progress) for the specified amount of animation time when the link is activated + double holdAnimationTime @unit(s) = default(0s); // Hold simulation (no progress) for the specified amount of animation time when the link is activated @class(LinkVisualizerBase); } diff --git a/src/inet/visualizer/base/MediumVisualizerBase.ned b/src/inet/visualizer/base/MediumVisualizerBase.ned index 318c4df066d..4e181a57a26 100644 --- a/src/inet/visualizer/base/MediumVisualizerBase.ned +++ b/src/inet/visualizer/base/MediumVisualizerBase.ned @@ -21,105 +21,105 @@ package inet.visualizer.base; simple MediumVisualizerBase extends VisualizerBase { parameters: - string mediumModule = default("radioMedium"); // the medium module that is displayed, refers to a top level submodule by default - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // the network node visualizer module, refers to a sibling submodule by default - - string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default - string interfaceFilter @mutable = default("*"); // which interfaces are considered, matches all interfaces by default - object packetFilter @mutable = default("*"); // which packets are considered, matches all packets by default - - bool displaySignals = default(false); // display signals propagating through the medium, disabled by default - string signalColor = default("dark"); // signal color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - double signalPropagationAnimationSpeed @mutable = default(nan); // animation speed while the very beginning or end of a signal is propagating on the medium, value must be in the range (0, +inf) or NaN, the latter means automatic setting - double signalPropagationAnimationTime @unit(s) = default(1s); // signal propagation animation duration when signalPropagationAnimationSpeed is unspecified - double signalPropagationAdditionalTime @unit(s) = default(0s); // additional simulation time to animate signal propagation after leaving last receiver - double signalTransmissionAnimationSpeed @mutable = default(nan); // animation speed while a signal is being transmitted on the medium, value must be in the range (0, +inf) or NaN, the latter means automatic setting - double signalTransmissionAnimationTime @unit(s) = default(1s); // signal transmission animation duration when signalTransmissionAnimationSpeed is unspecified - string signalAnimationSpeedChangeTimeMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // specifies the time mode for animation speed changes between propagation and transmission animation - double signalAnimationSpeedChangeTime @unit(s) = default(1s); // animation speed changes smoothly from propagationAnimationSpeed to transmissionAnimationSpeed in the specified real time - - bool displaySignalDepartures = default(false); // display an image where a signal departure is currently in progress, disabled by default - string signalDepartureImage = default("misc/signal_departure.png"); // image for ongoing signal departures - string signalDeparturePlacementHint = default("topCenter"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double signalDeparturePlacementPriority = default(1); // determines the order of annotation positioning - - bool displaySignalArrivals = default(false); // display an image where a signal arrival is currently in progress, disabled by default - string signalArrivalImage = default("misc/signal_arrival.png"); // image for ongoing signal arrivals - string signalArrivalPlacementHint = default("topCenter"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double signalArrivalPlacementPriority = default(-1); // determines the order of annotation positioning - - bool displayCommunicationRanges = default(false); // display communication ranges as circles around radios, enabled by default - string communicationRangeLineColor = default("blue"); // communication range circle line color, blue by default - string communicationRangeLineStyle = default("solid"); // communication range circle line style, solid by default - double communicationRangeLineWidth = default(1); // communication range circle line width, 1 by default - - bool displayInterferenceRanges = default(false); // display interference ranges as circles around radios, disabled by default - string interferenceRangeLineColor = default("gray"); // interference range circle color, gray by default - string interferenceRangeLineStyle = default("solid"); // interference range circle line style, solid by default - double interferenceRangeLineWidth = default(1); // interference range circle line width, 1 by default + string mediumModule = default("radioMedium"); // The medium module that is displayed, refers to a top level submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // The network node visualizer module, refers to a sibling submodule by default + + string nodeFilter @mutable = default("*"); // Which nodes are considered, matches all nodes by default + string interfaceFilter @mutable = default("*"); // Which interfaces are considered, matches all interfaces by default + object packetFilter @mutable = default("*"); // Which packets are considered, matches all packets by default + + bool displaySignals = default(false); // Display signals propagating through the medium, disabled by default + string signalColor = default("dark"); // Signal color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + double signalPropagationAnimationSpeed @mutable = default(nan); // Animation speed while the very beginning or end of a signal is propagating on the medium, value must be in the range (0, +inf) or NaN, the latter means automatic setting + double signalPropagationAnimationTime @unit(s) = default(1s); // Signal propagation animation duration when signalPropagationAnimationSpeed is unspecified + double signalPropagationAdditionalTime @unit(s) = default(0s); // Additional simulation time to animate signal propagation after leaving last receiver + double signalTransmissionAnimationSpeed @mutable = default(nan); // Animation speed while a signal is being transmitted on the medium, value must be in the range (0, +inf) or NaN, the latter means automatic setting + double signalTransmissionAnimationTime @unit(s) = default(1s); // Signal transmission animation duration when signalTransmissionAnimationSpeed is unspecified + string signalAnimationSpeedChangeTimeMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // Specifies the time mode for animation speed changes between propagation and transmission animation + double signalAnimationSpeedChangeTime @unit(s) = default(1s); // Animation speed changes smoothly from propagationAnimationSpeed to transmissionAnimationSpeed in the specified real time + + bool displaySignalDepartures = default(false); // Display an image where a signal departure is currently in progress, disabled by default + string signalDepartureImage = default("misc/signal_departure.png"); // Image for ongoing signal departures + string signalDeparturePlacementHint = default("topCenter"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double signalDeparturePlacementPriority = default(1); // Determines the order of annotation positioning + + bool displaySignalArrivals = default(false); // Display an image where a signal arrival is currently in progress, disabled by default + string signalArrivalImage = default("misc/signal_arrival.png"); // Image for ongoing signal arrivals + string signalArrivalPlacementHint = default("topCenter"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double signalArrivalPlacementPriority = default(-1); // Determines the order of annotation positioning + + bool displayCommunicationRanges = default(false); // Display communication ranges as circles around radios, enabled by default + string communicationRangeLineColor = default("blue"); // Communication range circle line color, blue by default + string communicationRangeLineStyle = default("solid"); // Communication range circle line style, solid by default + double communicationRangeLineWidth = default(1); // Communication range circle line width, 1 by default + + bool displayInterferenceRanges = default(false); // Display interference ranges as circles around radios, disabled by default + string interferenceRangeLineColor = default("gray"); // Interference range circle color, gray by default + string interferenceRangeLineStyle = default("solid"); // Interference range circle line style, solid by default + double interferenceRangeLineWidth = default(1); // Interference range circle line width, 1 by default // parameters shared between power density maps, spectrums and spectrograms - bool autoPowerAxis = default(true); // enables automatic power axis configuration - double signalMinPower @unit(dBmW) = default(inf dBmW); // minimum signal power if axis is not automatic - double signalMaxPower @unit(dBmW) = default(0 dBmW); // maximum signal power if axis is not automatic - double signalMinPowerDensity @unit(dBmWpMHz) = default(inf dBmWpMHz); // minimum signal power density if axis is not automatic - double signalMaxPowerDensity @unit(dBmWpMHz) = default(-inf dBmWpMHz); // maxium signal power density if axis is not automatic - bool autoTimeAxis = default(true); // enables automatic time axis configuration - double signalMinTime @unit(s) = default(0 s); // relative to current simulation time - double signalMaxTime @unit(s) = default(0 s); // relative to current simulation time - bool autoFrequencyAxis = default(true); // enables automatic frequency axis configuration - double signalMinFrequency @unit(Hz) = default(inf Hz); // minimum signal frequency if axis is not automatic - double signalMaxFrequency @unit(Hz) = default(-inf Hz); // maximum signal frequency if axis is not automatic + bool autoPowerAxis = default(true); // Enables automatic power axis configuration + double signalMinPower @unit(dBmW) = default(inf dBmW); // Minimum signal power if axis is not automatic + double signalMaxPower @unit(dBmW) = default(0 dBmW); // Maximum signal power if axis is not automatic + double signalMinPowerDensity @unit(dBmWpMHz) = default(inf dBmWpMHz); // Minimum signal power density if axis is not automatic + double signalMaxPowerDensity @unit(dBmWpMHz) = default(-inf dBmWpMHz); // Maxium signal power density if axis is not automatic + bool autoTimeAxis = default(true); // Enables automatic time axis configuration + double signalMinTime @unit(s) = default(0 s); // Relative to current simulation time + double signalMaxTime @unit(s) = default(0 s); // Relative to current simulation time + bool autoFrequencyAxis = default(true); // Enables automatic frequency axis configuration + double signalMinFrequency @unit(Hz) = default(inf Hz); // Minimum signal frequency if axis is not automatic + double signalMaxFrequency @unit(Hz) = default(-inf Hz); // Maximum signal frequency if axis is not automatic // parameters for main power density map - bool displayMainPowerDensityMap = default(false); // display a power density map for the transmission medium, can be enabled with dimensional analog models only - double mainPowerDensityMapPixmapDensity = default(1); // pixmap relative resolution - double mainPowerDensityMapMinX = default(0); // minimum X coordinate - double mainPowerDensityMapMaxX = default(nan); // maximum X coordinate, compound module size by default - double mainPowerDensityMapMinY = default(0); // minimum Y coordinate - double mainPowerDensityMapMaxY = default(nan); // maximum Y coordinate, compound module size by default + bool displayMainPowerDensityMap = default(false); // Display a power density map for the transmission medium, can be enabled with dimensional analog models only + double mainPowerDensityMapPixmapDensity = default(1); // Pixmap relative resolution + double mainPowerDensityMapMinX = default(0); // Minimum X coordinate + double mainPowerDensityMapMaxX = default(nan); // Maximum X coordinate, compound module size by default + double mainPowerDensityMapMinY = default(0); // Minimum Y coordinate + double mainPowerDensityMapMaxY = default(nan); // Maximum Y coordinate, compound module size by default double mainPowerDensityMapZ = default(0); // Z coordinate - int mainPowerDensityMapFigureXTickCount = default(3); // number of ticks along the X axis - int mainPowerDensityMapFigureYTickCount = default(3); // number of ticks along the Y axis + int mainPowerDensityMapFigureXTickCount = default(3); // Number of ticks along the X axis + int mainPowerDensityMapFigureYTickCount = default(3); // Number of ticks along the Y axis // parameters for power density maps - bool displayPowerDensityMaps = default(false); // display power density maps at the nodes, can be enabled with dimensional analog models only - string powerDensityMapMode @enum("total", "signal", "auto") = default("auto"); // total means total transmission medium, signal means transmitted or received signal, auto means total or signal and noise if transmission or reception is in progress - string powerDensityMapPixelMode @enum("sample", "partition", "mean") = default("mean"); // specifices the method used to determine the color of each pixel, sample method is the least accurate but the fastest (sample < partition < mean) - int powerDensityMapApproximationSize = default(10); // medium power density function approximation along X and Y axes - double powerDensityMapCenterFrequency @mutable @unit(Hz) = default(nan Hz); // center frequency of medium power density sampling or integration - double powerDensityMapBandwidth @mutable @unit(Hz) = default(0 Hz); // bandwidth of medium power density integration, 0 means sampling, inf means total integrated power - double powerDensityMapFigureWidth = default(200); // plot figure width in pixels - double powerDensityMapFigureHeight = default(120); // plot figure height in pixels - double powerDensityMapPixmapWidth = default(powerDensityMapFigureWidth); // pixmap resolution width - double powerDensityMapPixmapHeight = default(powerDensityMapFigureHeight); // pixmap resolution height + bool displayPowerDensityMaps = default(false); // Display power density maps at the nodes, can be enabled with dimensional analog models only + string powerDensityMapMode @enum("total", "signal", "auto") = default("auto"); // Total means total transmission medium, signal means transmitted or received signal, auto means total or signal and noise if transmission or reception is in progress + string powerDensityMapPixelMode @enum("sample", "partition", "mean") = default("mean"); // Specifices the method used to determine the color of each pixel, sample method is the least accurate but the fastest (sample < partition < mean) + int powerDensityMapApproximationSize = default(10); // Medium power density function approximation along X and Y axes + double powerDensityMapCenterFrequency @mutable @unit(Hz) = default(nan Hz); // Center frequency of medium power density sampling or integration + double powerDensityMapBandwidth @mutable @unit(Hz) = default(0 Hz); // Bandwidth of medium power density integration, 0 means sampling, inf means total integrated power + double powerDensityMapFigureWidth = default(200); // Plot figure width in pixels + double powerDensityMapFigureHeight = default(120); // Plot figure height in pixels + double powerDensityMapPixmapWidth = default(powerDensityMapFigureWidth); // Pixmap resolution width + double powerDensityMapPixmapHeight = default(powerDensityMapFigureHeight); // Pixmap resolution height double powerDensityMapZ = default(0); // Z coordinate - int powerDensityMapFigureXTickCount = default(3); // number of ticks along the X axis - int powerDensityMapFigureYTickCount = default(3); // number of ticks along the Y axis + int powerDensityMapFigureXTickCount = default(3); // Number of ticks along the X axis + int powerDensityMapFigureYTickCount = default(3); // Number of ticks along the Y axis // parameters for spectrum figures - bool displaySpectrums = default(false); // display power spectral density at the nodes, can be enabled with dimensional analog models only - string spectrumMode @enum("total", "signal", "auto") = default("auto"); // total means total transmission medium, signal means transmitted or received signal, auto means total or signal and noise if transmission or reception is in progress - double spectrumFigureWidth = default(200); // plot figure width in pixels - double spectrumFigureHeight = default(120); // plot figure height in pixels - int spectrumFigureXTickCount = default(3); // number of ticks along the X axis - int spectrumFigureYTickCount = default(5); // number of ticks along the Y axis - double spectrumFigureInterpolationSize = default(5); // power spectrum density interpolation distance along the frequency axis - string spectrumPlacementHint = default("bottomCenter"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double spectrumPlacementPriority = default(-1); // determines the order of annotation positioning + bool displaySpectrums = default(false); // Display power spectral density at the nodes, can be enabled with dimensional analog models only + string spectrumMode @enum("total", "signal", "auto") = default("auto"); // Total means total transmission medium, signal means transmitted or received signal, auto means total or signal and noise if transmission or reception is in progress + double spectrumFigureWidth = default(200); // Plot figure width in pixels + double spectrumFigureHeight = default(120); // Plot figure height in pixels + int spectrumFigureXTickCount = default(3); // Number of ticks along the X axis + int spectrumFigureYTickCount = default(5); // Number of ticks along the Y axis + double spectrumFigureInterpolationSize = default(5); // Power spectrum density interpolation distance along the frequency axis + string spectrumPlacementHint = default("bottomCenter"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double spectrumPlacementPriority = default(-1); // Determines the order of annotation positioning // parameters for spectrogram figures - bool displaySpectrograms = default(false); // display power density spectrograms at the nodes, can be enabled with dimensional analog models only - string spectrogramMode @enum("total", "signal", "auto") = default("auto"); // total means total transmission medium, signal means transmitted or received signal, auto means total or signal and noise if transmission or reception is in progress - string spectrogramPixelMode @enum("sample", "partition", "mean") = default("mean"); // specifices the method used to determine the color of each pixel, sample method is the least accurate but the fastest (sample < partition < mean) - double spectrogramFigureWidth = default(200); // plot figure width in pixels - double spectrogramFigureHeight = default(120); // plot figure height in pixels - double spectrogramPixmapWidth = default(spectrogramFigureWidth); // pixmap resolution width - double spectrogramPixmapHeight = default(spectrogramFigureHeight); // pixmap resolution height - int spectrogramFigureXTickCount = default(3); // number of ticks along the X axis - int spectrogramFigureYTickCount = default(5); // number of ticks along the Y axis - string spectrogramPlacementHint = default("bottomCenter"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double spectrogramPlacementPriority = default(-1); // determines the order of annotation positioning + bool displaySpectrograms = default(false); // Display power density spectrograms at the nodes, can be enabled with dimensional analog models only + string spectrogramMode @enum("total", "signal", "auto") = default("auto"); // Total means total transmission medium, signal means transmitted or received signal, auto means total or signal and noise if transmission or reception is in progress + string spectrogramPixelMode @enum("sample", "partition", "mean") = default("mean"); // Specifices the method used to determine the color of each pixel, sample method is the least accurate but the fastest (sample < partition < mean) + double spectrogramFigureWidth = default(200); // Plot figure width in pixels + double spectrogramFigureHeight = default(120); // Plot figure height in pixels + double spectrogramPixmapWidth = default(spectrogramFigureWidth); // Pixmap resolution width + double spectrogramPixmapHeight = default(spectrogramFigureHeight); // Pixmap resolution height + int spectrogramFigureXTickCount = default(3); // Number of ticks along the X axis + int spectrogramFigureYTickCount = default(5); // Number of ticks along the Y axis + string spectrogramPlacementHint = default("bottomCenter"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double spectrogramPlacementPriority = default(-1); // Determines the order of annotation positioning @class(MediumVisualizerBase); } diff --git a/src/inet/visualizer/base/MobilityVisualizerBase.ned b/src/inet/visualizer/base/MobilityVisualizerBase.ned index 1d18f8c4be9..cade226e90c 100644 --- a/src/inet/visualizer/base/MobilityVisualizerBase.ned +++ b/src/inet/visualizer/base/MobilityVisualizerBase.ned @@ -18,39 +18,39 @@ package inet.visualizer.base; simple MobilityVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // the network node visualizer module, refers to a sibling submodule by default - - bool displayMobility = default(true); // display mobility, enabled by default - double animationSpeed = default(0); // animation speed while objects are moving around, value must be in the range (0, +inf) - - string moduleFilter @mutable = default("**.mobility"); // which mobilities are considered, matches all mobilities by default - - bool displayPositions = default(false); // display a circle indicating the current position, disabled by default - double positionCircleRadius = default(4); // radius of the circle - double positionCircleLineWidth = default(1); // line width of the circle - string positionCircleLineColor = default("dark"); // position circle line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - string positionCircleFillColor = default("dark"); // position circle fill color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - - bool displayOrientations = default(false); // display a pie indicating the current orientation, disabled by default - double orientationPieRadius = default(32); // radius of the pie - double orientationPieSize = default(0.2); // relative size of the pie compared to the full circle - double orientationPieOpacity = default(0.25); // opacity of the pie - string orientationLineColor = default("black"); // orientation line color, black by default - string orientationLineStyle = default("solid"); // orientation line style (solid, dashed, dotted) - double orientationLineWidth = default(1); // orientation line width - string orientationFillColor = default("blue"); // orientation fill color, blue by default - - bool displayVelocities = default(false); // display an arrow indicating the current velocity, disabled by default - double velocityArrowScale = default(1); // velocity scaling factor to pixels - string velocityLineColor = default("black"); // velocity line color, black by default - string velocityLineStyle = default("solid"); // velocity line style (solid, dashed, dotted) - double velocityLineWidth = default(1); // velocity line width - - bool displayMovementTrails = default(false); // display a line along the recent path of mobilities, disabled by default - string movementTrailLineColor = default("dark"); // movement trail line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - string movementTrailLineStyle = default("solid"); // movement trail line style (solid, dashed, dotted) - double movementTrailLineWidth = default(1); // movement trail line width - int trailLength = default(100); // number of sections in the trail + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // The network node visualizer module, refers to a sibling submodule by default + + bool displayMobility = default(true); // Display mobility, enabled by default + double animationSpeed = default(0); // Animation speed while objects are moving around, value must be in the range (0, +inf) + + string moduleFilter @mutable = default("**.mobility"); // Which mobilities are considered, matches all mobilities by default + + bool displayPositions = default(false); // Display a circle indicating the current position, disabled by default + double positionCircleRadius = default(4); // Radius of the circle + double positionCircleLineWidth = default(1); // Line width of the circle + string positionCircleLineColor = default("dark"); // Position circle line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + string positionCircleFillColor = default("dark"); // Position circle fill color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + + bool displayOrientations = default(false); // Display a pie indicating the current orientation, disabled by default + double orientationPieRadius = default(32); // Radius of the pie + double orientationPieSize = default(0.2); // Relative size of the pie compared to the full circle + double orientationPieOpacity = default(0.25); // Opacity of the pie + string orientationLineColor = default("black"); // Orientation line color, black by default + string orientationLineStyle = default("solid"); // Orientation line style (solid, dashed, dotted) + double orientationLineWidth = default(1); // Orientation line width + string orientationFillColor = default("blue"); // Orientation fill color, blue by default + + bool displayVelocities = default(false); // Display an arrow indicating the current velocity, disabled by default + double velocityArrowScale = default(1); // Velocity scaling factor to pixels + string velocityLineColor = default("black"); // Velocity line color, black by default + string velocityLineStyle = default("solid"); // Velocity line style (solid, dashed, dotted) + double velocityLineWidth = default(1); // Velocity line width + + bool displayMovementTrails = default(false); // Display a line along the recent path of mobilities, disabled by default + string movementTrailLineColor = default("dark"); // Movement trail line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + string movementTrailLineStyle = default("solid"); // Movement trail line style (solid, dashed, dotted) + double movementTrailLineWidth = default(1); // Movement trail line width + int trailLength = default(100); // Number of sections in the trail @class(MobilityVisualizerBase); } diff --git a/src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned b/src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned index 1ea58601763..10d666b8e35 100644 --- a/src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned +++ b/src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned @@ -18,11 +18,11 @@ simple NetworkConnectionVisualizerBase extends VisualizerBase parameters: bool displayNetworkConnections = default(true); - string nodeFilter @mutable = default("*"); // determines which network connections are displayed, all connections by default + string nodeFilter @mutable = default("*"); // Determines which network connections are displayed, all connections by default - string lineColor = default("black"); // connection line color - string lineStyle = default("solid"); // connection line style (solid, dashed, dotted) - double lineWidth = default(1); // connection line width + string lineColor = default("black"); // Connection line color + string lineStyle = default("solid"); // Connection line style (solid, dashed, dotted) + double lineWidth = default(1); // Connection line width @class(NetworkConnectionVisualizerBase); } diff --git a/src/inet/visualizer/base/NetworkNodeVisualizerBase.ned b/src/inet/visualizer/base/NetworkNodeVisualizerBase.ned index 307258eae4c..0c965f544bc 100644 --- a/src/inet/visualizer/base/NetworkNodeVisualizerBase.ned +++ b/src/inet/visualizer/base/NetworkNodeVisualizerBase.ned @@ -16,7 +16,7 @@ package inet.visualizer.base; simple NetworkNodeVisualizerBase extends VisualizerBase { parameters: - string nodeFilter @mutable = default("*"); // determines which network nodes are displayed, all nodes by default + string nodeFilter @mutable = default("*"); // Determines which network nodes are displayed, all nodes by default double annotationSpacing = default(4); double placementPenalty = default(10); diff --git a/src/inet/visualizer/base/PacketDropVisualizerBase.ned b/src/inet/visualizer/base/PacketDropVisualizerBase.ned index 1375b98d618..81c215eb5e1 100644 --- a/src/inet/visualizer/base/PacketDropVisualizerBase.ned +++ b/src/inet/visualizer/base/PacketDropVisualizerBase.ned @@ -28,24 +28,24 @@ package inet.visualizer.base; simple PacketDropVisualizerBase extends VisualizerBase { parameters: - bool displayPacketDrops = default(false); // display packet drops, disabled by default + bool displayPacketDrops = default(false); // Display packet drops, disabled by default - string nodeFilter @mutable = default("*"); // which network nodes are considered, matches all network nodes by default - string interfaceFilter @mutable = default("*"); // which network interfaces are considered, matches all network interfaces by default - object packetFilter @mutable = default("*"); // which packets are considered, matches all packets by default - string detailsFilter @mutable = default("*"); // which packet drops are considered, matches all packet drops by default + string nodeFilter @mutable = default("*"); // Which network nodes are considered, matches all network nodes by default + string interfaceFilter @mutable = default("*"); // Which network interfaces are considered, matches all network interfaces by default + object packetFilter @mutable = default("*"); // Which packets are considered, matches all packets by default + string detailsFilter @mutable = default("*"); // Which packet drops are considered, matches all packet drops by default - string icon = default("msg/packet_s"); // packet drop visualization icon - double iconTintAmount = default(1); // colorization amount between 0 and 1, enabled by default - string iconTintColor = default("dark"); // icon tint color is a list of colors, a set of dark colors by default + string icon = default("msg/packet_s"); // Packet drop visualization icon + double iconTintAmount = default(1); // Colorization amount between 0 and 1, enabled by default + string iconTintColor = default("dark"); // Icon tint color is a list of colors, a set of dark colors by default - string labelFormat @mutable = default("%n"); // determines what data is displayed in the label, packet name by default - string labelFont = default(""); // label font, automatic by default - string labelColor = default("black"); // label color, black by default + string labelFormat @mutable = default("%n"); // Determines what data is displayed in the label, packet name by default + string labelFont = default(""); // Label font, automatic by default + string labelColor = default("black"); // Label color, black by default - string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // specifies how inactive packet drops fade out, real time by default - double fadeOutTime @unit(s) = default(1s); // how quickly packet drops fade away, 1 second by default - double fadeOutAnimationSpeed = default(0); // animation speed while there are packet drops, value must be in the range (0, +inf), disabled by default + string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // Specifies how inactive packet drops fade out, real time by default + double fadeOutTime @unit(s) = default(1s); // How quickly packet drops fade away, 1 second by default + double fadeOutAnimationSpeed = default(0); // Animation speed while there are packet drops, value must be in the range (0, +inf), disabled by default @class(PacketDropVisualizerBase); } diff --git a/src/inet/visualizer/base/PathVisualizerBase.ned b/src/inet/visualizer/base/PathVisualizerBase.ned index bb9cf1fcd3b..317f7182530 100644 --- a/src/inet/visualizer/base/PathVisualizerBase.ned +++ b/src/inet/visualizer/base/PathVisualizerBase.ned @@ -37,33 +37,33 @@ package inet.visualizer.base; simple PathVisualizerBase extends VisualizerBase { parameters: - bool displayRoutes = default(false); // display polyline arrow for active routes, disabled by default + bool displayRoutes = default(false); // Display polyline arrow for active routes, disabled by default string startPathSignal = default("packetReceivedFromUpper"); string extendPathSignal = default("packetReceivedFromLower"); string endPathSignal = default("packetSentToUpper"); - string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default - object packetFilter @mutable = default("*"); // which packets are considered, matches all packets by default + string nodeFilter @mutable = default("*"); // Which nodes are considered, matches all nodes by default + object packetFilter @mutable = default("*"); // Which packets are considered, matches all packets by default - string lineColor = default("dark"); // route color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - string lineStyle = default("solid"); // route line style (solid, dashed, dotted) - double lineWidth = default(3); // route line width - bool lineSmooth = default(false); // when true polylines are displayed as curves + string lineColor = default("dark"); // Route color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + string lineStyle = default("solid"); // Route line style (solid, dashed, dotted) + double lineWidth = default(3); // Route line width + bool lineSmooth = default(false); // When true polylines are displayed as curves - double lineShift = default(16); // route line shift to avoid overlapping routes - string lineShiftMode = default("normal"); // determines how overlapping lines are shifted, possible values are: normal, x, y, z; optional prefix + or - + double lineShift = default(16); // Route line shift to avoid overlapping routes + string lineShiftMode = default("normal"); // Determines how overlapping lines are shifted, possible values are: normal, x, y, z; optional prefix + or - - double lineContactSpacing = default(3); // spacing between arrow end and submodule icon - string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // determines how arrows are clipped at the submodules + double lineContactSpacing = default(3); // Spacing between arrow end and submodule icon + string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // Determines how arrows are clipped at the submodules - string labelFormat = default("%n"); // determines what path data is displayed - string labelFont = default(", 8px"); // label font, automatic by default - string labelColor = default(""); // label color, same as line by default + string labelFormat = default("%n"); // Determines what path data is displayed + string labelFont = default(", 8px"); // Label font, automatic by default + string labelColor = default(""); // Label color, same as line by default - string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // specifies how inactive routes fade out - double fadeOutTime @unit(s) = default(1s); // how quickly inactive routes fade away, 1 second by default - double fadeOutAnimationSpeed = default(0); // animation speed while there are active routes, value must be in the range (0, +inf) + string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // Specifies how inactive routes fade out + double fadeOutTime @unit(s) = default(1s); // How quickly inactive routes fade away, 1 second by default + double fadeOutAnimationSpeed = default(0); // Animation speed while there are active routes, value must be in the range (0, +inf) @class(PathVisualizerBase); } diff --git a/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned b/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned index d958a394661..fea6d616527 100644 --- a/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned +++ b/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned @@ -18,7 +18,7 @@ package inet.visualizer.base; simple PhysicalEnvironmentVisualizerBase extends VisualizerBase { parameters: - string physicalEnvironmentModule = default("physicalEnvironment"); // the physical environment module that is displayed, refers to a top level submodule by default + string physicalEnvironmentModule = default("physicalEnvironment"); // The physical environment module that is displayed, refers to a top level submodule by default bool displayObjects = default(true); diff --git a/src/inet/visualizer/base/QueueVisualizerBase.ned b/src/inet/visualizer/base/QueueVisualizerBase.ned index 7a247bffbc7..2183fa3300b 100644 --- a/src/inet/visualizer/base/QueueVisualizerBase.ned +++ b/src/inet/visualizer/base/QueueVisualizerBase.ned @@ -15,18 +15,18 @@ package inet.visualizer.base; simple QueueVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default bool displayQueues = default(false); - string queueFilter = default("**"); // which queues are considered, matches all queues by default + string queueFilter = default("**"); // Which queues are considered, matches all queues by default string color = default("blue"); double width = default(8); double height = default(24); double spacing = default(2); - string placementHint = default("right"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string placementHint = default("right"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning @class(QueueVisualizerBase); } diff --git a/src/inet/visualizer/base/RadioVisualizerBase.ned b/src/inet/visualizer/base/RadioVisualizerBase.ned index ef41eb116b8..58dc454b0ab 100644 --- a/src/inet/visualizer/base/RadioVisualizerBase.ned +++ b/src/inet/visualizer/base/RadioVisualizerBase.ned @@ -15,7 +15,7 @@ package inet.visualizer.base; simple RadioVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // module path to the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // Module path to the network node visualizer module, refers to a sibling submodule by default bool displayRadios = default(false); bool displayRadioMode = default(true); @@ -23,31 +23,31 @@ simple RadioVisualizerBase extends VisualizerBase bool displayTransmissionState = default(true); bool displayAntennaLobes = default(false); - string radioFilter @mutable = default("**"); // which radios are considered, matches all radios by default + string radioFilter @mutable = default("**"); // Which radios are considered, matches all radios by default string radioModeImages = default("block/process_vs block/timer_vs block/wrx_vs block/wtx_vs block/wrxtx_vs block/cogwheel_vs"); string receptionStateImages = default("- - misc/receiving misc/receiving"); string transmissionStateImages = default("- - misc/transmitting"); double width = default(16); double height = default(16); - string placementHint = default("bottomRight"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string placementHint = default("bottomRight"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning - bool antennaLobeNormalize = default(false); // true means maximum gain, false means 0dB is displayed at the given antennaLobeRadius - bool antennaLobeRelativeLabels = default(false); // determines whether gain labels are relative or absolute (if true, maximum gain label is 0dB) - bool antennaLobePlaneGlobal = default(true); // compute antenna lobe relative to the global or antenna local coordinate systems, global by default - string antennaLobePlane @enum("view", "xy", "xz", "yz") = default("view"); // compute antenna lobe in this plane, view by default + bool antennaLobeNormalize = default(false); // True means maximum gain, false means 0dB is displayed at the given antennaLobeRadius + bool antennaLobeRelativeLabels = default(false); // Determines whether gain labels are relative or absolute (if true, maximum gain label is 0dB) + bool antennaLobePlaneGlobal = default(true); // Compute antenna lobe relative to the global or antenna local coordinate systems, global by default + string antennaLobePlane @enum("view", "xy", "xz", "yz") = default("view"); // Compute antenna lobe in this plane, view by default string antennaLobeMode @enum("logarithmic", "linear") = default("logarithmic"); double antennaLobeLogarithmicBase = default(10); - double antennaLobeLogarithmicScale = default(100); // distance change in pixels for 10dB - double antennaLobeRadius = default(100); // distance in pixels for 0dB (1 gain) or maximum gain depending on antennaLobeNormalize parameter + double antennaLobeLogarithmicScale = default(100); // Distance change in pixels for 10dB + double antennaLobeRadius = default(100); // Distance in pixels for 0dB (1 gain) or maximum gain depending on antennaLobeNormalize parameter double antennaLobeStep @unit(deg) = default(10deg); - double antennaLobeOpacity = default(0.25); // opacity of the antenna lobe + double antennaLobeOpacity = default(0.25); // Opacity of the antenna lobe bool antennaLobeLineSmooth = default(true); - string antennaLobeLineColor = default("black"); // antenna lobe line color, black by default - string antennaLobeLineStyle = default("solid"); // antenna lobe line style (solid, dashed, dotted) - double antennaLobeLineWidth = default(1); // antenna lobe line width - string antennaLobeFillColor = default("white"); // antenna lobe fill color, white by default + string antennaLobeLineColor = default("black"); // Antenna lobe line color, black by default + string antennaLobeLineStyle = default("solid"); // Antenna lobe line style (solid, dashed, dotted) + double antennaLobeLineWidth = default(1); // Antenna lobe line width + string antennaLobeFillColor = default("white"); // Antenna lobe fill color, white by default @class(RadioVisualizerBase); } diff --git a/src/inet/visualizer/base/RoutingTableVisualizerBase.ned b/src/inet/visualizer/base/RoutingTableVisualizerBase.ned index e76a8bc7d6c..3f4bf6eb232 100644 --- a/src/inet/visualizer/base/RoutingTableVisualizerBase.ned +++ b/src/inet/visualizer/base/RoutingTableVisualizerBase.ned @@ -31,29 +31,29 @@ package inet.visualizer.base; simple RoutingTableVisualizerBase extends VisualizerBase { parameters: - bool displayRoutingTables = default(false); // display routing table data, disabled by default - bool displayRoutesIndividually = default(true); // display routes between the same network nodes individually, enabled by default - bool displayLabels = default(true); // display labels on arrows, enabled by default + bool displayRoutingTables = default(false); // Display routing table data, disabled by default + bool displayRoutesIndividually = default(true); // Display routes between the same network nodes individually, enabled by default + bool displayLabels = default(true); // Display labels on arrows, enabled by default - string destinationFilter @mutable = default("*"); // which destinations are considered, matches all destinations by default - string nodeFilter @mutable = default("*"); // which nodes are considered, matches all nodes by default - string multicastSourceNodeFilter @mutable = default("*"); // which multicast source nodes are considered, matches all nodes by default - string multicastSourceAddressFilter @mutable = default("*"); // which multicast source addresses are considered, matches all addresses by default - string multicastGroupFilter @mutable = default("*"); // which multicast group addresses are considered, matches all group addresses by default + string destinationFilter @mutable = default("*"); // Which destinations are considered, matches all destinations by default + string nodeFilter @mutable = default("*"); // Which nodes are considered, matches all nodes by default + string multicastSourceNodeFilter @mutable = default("*"); // Which multicast source nodes are considered, matches all nodes by default + string multicastSourceAddressFilter @mutable = default("*"); // Which multicast source addresses are considered, matches all addresses by default + string multicastGroupFilter @mutable = default("*"); // Which multicast group addresses are considered, matches all group addresses by default - string lineColor = default("black"); // route line color, black by default - string lineStyle = default("solid"); // route line style (solid, dashed, dotted) - double lineWidth = default(2); // route line width + string lineColor = default("black"); // Route line color, black by default + string lineStyle = default("solid"); // Route line style (solid, dashed, dotted) + double lineWidth = default(2); // Route line width - double lineShift = default(16); // line shift to avoid overlapping lines - string lineShiftMode = default("normal"); // determines how overlapping lines are shifted, possible values are: none, normal, x, y, z; optional prefix + or - + double lineShift = default(16); // Line shift to avoid overlapping lines + string lineShiftMode = default("normal"); // Determines how overlapping lines are shifted, possible values are: none, normal, x, y, z; optional prefix + or - - double lineContactSpacing = default(3); // spacing between arrow end and submodule icon - string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // determines how arrows are clipped at the submodules + double lineContactSpacing = default(3); // Spacing between arrow end and submodule icon + string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // Determines how arrows are clipped at the submodules - string labelFormat @mutable = default("%d/%m -> %g (%n)"); // determines what route data is displayed - string labelFont = default(", 8px"); // label font, automatic by default - string labelColor = default("black"); // label color, black by default + string labelFormat @mutable = default("%d/%m -> %g (%n)"); // Determines what route data is displayed + string labelFont = default(", 8px"); // Label font, automatic by default + string labelColor = default("black"); // Label color, black by default @class(RoutingTableVisualizerBase); } diff --git a/src/inet/visualizer/base/SceneVisualizerBase.ned b/src/inet/visualizer/base/SceneVisualizerBase.ned index 7b49ac545d7..f0a7d24b304 100644 --- a/src/inet/visualizer/base/SceneVisualizerBase.ned +++ b/src/inet/visualizer/base/SceneVisualizerBase.ned @@ -20,15 +20,15 @@ package inet.visualizer.base; simple SceneVisualizerBase extends VisualizerBase { parameters: - string physicalEnvironmentModule = default("physicalEnvironment"); // the physical environment module, refers to a top level submodule by default - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // the network node visualizer, refers to a sibling submodule by default - double axisLength @mutable @unit(m) = default(nan m); // length of x, y, and z axes, no axis by default - double animationSpeed = default(0); // always active animation speed independent of any visualization, value must be in the range (0, +inf) - double sceneMinX @unit(m) = default(nan m); // lower bound of x coordinates in scene - double sceneMinY @unit(m) = default(nan m); // lower bound of y coordinates in scene - double sceneMinZ @unit(m) = default(nan m); // lower bound of z coordinates in scene - double sceneMaxX @unit(m) = default(nan m); // upper bound of x coordinates in scene - double sceneMaxY @unit(m) = default(nan m); // upper bound of y coordinates in scene - double sceneMaxZ @unit(m) = default(nan m); // upper bound of z coordinates in scene + string physicalEnvironmentModule = default("physicalEnvironment"); // The physical environment module, refers to a top level submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // The network node visualizer, refers to a sibling submodule by default + double axisLength @mutable @unit(m) = default(nan m); // Length of x, y, and z axes, no axis by default + double animationSpeed = default(0); // Always active animation speed independent of any visualization, value must be in the range (0, +inf) + double sceneMinX @unit(m) = default(nan m); // Lower bound of x coordinates in scene + double sceneMinY @unit(m) = default(nan m); // Lower bound of y coordinates in scene + double sceneMinZ @unit(m) = default(nan m); // Lower bound of z coordinates in scene + double sceneMaxX @unit(m) = default(nan m); // Upper bound of x coordinates in scene + double sceneMaxY @unit(m) = default(nan m); // Upper bound of y coordinates in scene + double sceneMaxZ @unit(m) = default(nan m); // Upper bound of z coordinates in scene @class(SceneVisualizerBase); } diff --git a/src/inet/visualizer/base/StatisticVisualizerBase.ned b/src/inet/visualizer/base/StatisticVisualizerBase.ned index a439f0c791d..2aff2f4b65a 100644 --- a/src/inet/visualizer/base/StatisticVisualizerBase.ned +++ b/src/inet/visualizer/base/StatisticVisualizerBase.ned @@ -28,25 +28,25 @@ package inet.visualizer.base; simple StatisticVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // The network node visualizer module, refers to a sibling submodule by default bool displayStatistics = default(false); - string signalName = default(""); // signal name to subscribe, no signal name by default - string statisticName = default(signalName); // statistic name to get the value, signal name by default - string statisticUnit = default(""); // statistic unit, undefined by default - string statisticExpression = default(""); // statistic expression, received value by default - string sourceFilter @mutable = default("**"); // pattern that must match the signal source, no source filter by default - - string format @mutable = default("%n: %v %u"); // determines what is displayed, info by default - string unit = default(""); // display the value in one of the specified units, statistic unit by default - - string font = default(""); // statistic value font, automatic by default - string textColor = default("black"); // statistic value font color, black by default - string backgroundColor = default("white"); // statistic value background color, white by default - double opacity = default(1.0); // opacity of the visualization - string placementHint = default("top"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string signalName = default(""); // Signal name to subscribe, no signal name by default + string statisticName = default(signalName); // Statistic name to get the value, signal name by default + string statisticUnit = default(""); // Statistic unit, undefined by default + string statisticExpression = default(""); // Statistic expression, received value by default + string sourceFilter @mutable = default("**"); // Pattern that must match the signal source, no source filter by default + + string format @mutable = default("%n: %v %u"); // Determines what is displayed, info by default + string unit = default(""); // Display the value in one of the specified units, statistic unit by default + + string font = default(""); // Statistic value font, automatic by default + string textColor = default("black"); // Statistic value font color, black by default + string backgroundColor = default("white"); // Statistic value background color, white by default + double opacity = default(1.0); // Opacity of the visualization + string placementHint = default("top"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning @class(StatisticVisualizerBase); } diff --git a/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned b/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned index 4b5f1f6e32d..7f24c9c7409 100644 --- a/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned +++ b/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned @@ -17,19 +17,19 @@ package inet.visualizer.base; simple TracingObstacleLossVisualizerBase extends VisualizerBase { parameters: - bool displayIntersections = default(false); // display instersections of transmissions and physical objects, disabled by default + bool displayIntersections = default(false); // Display instersections of transmissions and physical objects, disabled by default string intersectionLineColor = default("red"); string intersectionLineStyle = default("solid"); double intersectionLineWidth = default(1); - bool displayFaceNormalVectors = default(false); // display face normal vectors of instersections, disabled by default + bool displayFaceNormalVectors = default(false); // Display face normal vectors of instersections, disabled by default string faceNormalLineColor = default("grey"); string faceNormalLineStyle = default("solid"); double faceNormalLineWidth = default(1); - string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // specifies how inactive obstacle losses fade out - double fadeOutTime @unit(s) = default(1s); // how quickly link breaks fade away, 1 second by default - double fadeOutAnimationSpeed = default(0); // animation speed while there are obstacle losses, value must be in the range (0, +inf) + string fadeOutMode @enum("realTime", "animationTime", "simulationTime") = default("realTime"); // Specifies how inactive obstacle losses fade out + double fadeOutTime @unit(s) = default(1s); // How quickly link breaks fade away, 1 second by default + double fadeOutAnimationSpeed = default(0); // Animation speed while there are obstacle losses, value must be in the range (0, +inf) @class(TracingObstacleLossVisualizerBase); } diff --git a/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned b/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned index 12eabf1636f..6d343df92f8 100644 --- a/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned +++ b/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned @@ -22,21 +22,21 @@ package inet.visualizer.base; simple TransportConnectionVisualizerBase extends VisualizerBase { parameters: - string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // the network node visualizer module, refers to a sibling submodule by default + string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // The network node visualizer module, refers to a sibling submodule by default bool displayTransportConnections = default(false);// display transport connection end points, disabled by default - string sourceNodeFilter @mutable = default("*"); // which source network nodes are considered to display connections, matches no nodes by default - string sourcePortFilter @mutable = default("*"); // which source ports are considered to display connections, matches all ports by default - string destinationNodeFilter @mutable = default("*"); // which destination network nodes are considered to display connections, matches no nodes by default - string destinationPortFilter @mutable = default("*"); // which destination ports are considered to display connections, matches all ports by default - - string icon = default("misc/marker_s"); // transport connection visualization icon - string iconColor = default("dark"); // transport connection icon color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - string labelFont = default(""); // label font, automatic by default - string labelColor = default("black"); // label color, black by default - string placementHint = default("top"); // annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. - double placementPriority = default(0); // determines the order of annotation positioning + string sourceNodeFilter @mutable = default("*"); // Which source network nodes are considered to display connections, matches no nodes by default + string sourcePortFilter @mutable = default("*"); // Which source ports are considered to display connections, matches all ports by default + string destinationNodeFilter @mutable = default("*"); // Which destination network nodes are considered to display connections, matches no nodes by default + string destinationPortFilter @mutable = default("*"); // Which destination ports are considered to display connections, matches all ports by default + + string icon = default("misc/marker_s"); // Transport connection visualization icon + string iconColor = default("dark"); // Transport connection icon color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + string labelFont = default(""); // Label font, automatic by default + string labelColor = default("black"); // Label color, black by default + string placementHint = default("top"); // Annotation placement hint, space separated list of any, top, bottom, left, right, topLeft, topCenter, topRight, etc. + double placementPriority = default(0); // Determines the order of annotation positioning @class(TransportConnectionVisualizerBase); } diff --git a/src/inet/visualizer/base/TreeVisualizerBase.ned b/src/inet/visualizer/base/TreeVisualizerBase.ned index a730a3df917..922a2fc8fc4 100644 --- a/src/inet/visualizer/base/TreeVisualizerBase.ned +++ b/src/inet/visualizer/base/TreeVisualizerBase.ned @@ -10,18 +10,18 @@ package inet.visualizer.base; simple TreeVisualizerBase extends VisualizerBase { parameters: - bool displayTrees = default(false); // display a set of polyline arrows for trees, disabled by default + bool displayTrees = default(false); // Display a set of polyline arrows for trees, disabled by default - string lineColor = default("dark"); // line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default - string lineStyle = default("solid"); // line style (solid, dashed, dotted) - double lineWidth = default(3); // line width - bool lineSmooth = default(false); // when true polylines are displayed as curves + string lineColor = default("dark"); // Line color is a list of colors or a color group name (e.g. dark, light), a set of dark colors by default + string lineStyle = default("solid"); // Line style (solid, dashed, dotted) + double lineWidth = default(3); // Line width + bool lineSmooth = default(false); // When true polylines are displayed as curves - double lineShift = default(16); // line shift to avoid overlapping lines - string lineShiftMode = default("normal"); // determines how overlapping lines are shifted, possible values are: normal, x, y, z; optional prefix + or - + double lineShift = default(16); // Line shift to avoid overlapping lines + string lineShiftMode = default("normal"); // Determines how overlapping lines are shifted, possible values are: normal, x, y, z; optional prefix + or - - double lineContactSpacing = default(3); // spacing between arrow end and submodule icon - string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // determines how arrows are clipped at the submodules + double lineContactSpacing = default(3); // Spacing between arrow end and submodule icon + string lineContactMode @enum("circular", "rectangular") = default("rectangular"); // Determines how arrows are clipped at the submodules @class(TreeVisualizerBase); } diff --git a/src/inet/visualizer/base/VisualizerBase.ned b/src/inet/visualizer/base/VisualizerBase.ned index c6359099f3a..424a125c40c 100644 --- a/src/inet/visualizer/base/VisualizerBase.ned +++ b/src/inet/visualizer/base/VisualizerBase.ned @@ -14,9 +14,9 @@ package inet.visualizer.base; simple VisualizerBase { parameters: - string visualizationTargetModule = default("^"); // module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default - string visualizationSubjectModule = default("^"); // 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 - string tags = default(""); // tag added to each visualization for disambiguation in the runtime environment + string visualizationTargetModule = default("^"); // Module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default + string visualizationSubjectModule = default("^"); // 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 + string tags = default(""); // Tag added to each visualization for disambiguation in the runtime environment @class(VisualizerBase); @display("i=block/app"); } diff --git a/src/inet/visualizer/canvas/common/GateScheduleCanvasVisualizer.ned b/src/inet/visualizer/canvas/common/GateScheduleCanvasVisualizer.ned index 36ab68022d0..f14ad9f6b8f 100644 --- a/src/inet/visualizer/canvas/common/GateScheduleCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/common/GateScheduleCanvasVisualizer.ned @@ -18,7 +18,7 @@ import inet.visualizer.contract.IGateScheduleVisualizer; simple GateScheduleCanvasVisualizer extends GateScheduleVisualizerBase like IGateScheduleVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers @class(GateScheduleCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/common/InfoCanvasVisualizer.ned b/src/inet/visualizer/canvas/common/InfoCanvasVisualizer.ned index b34f414b99f..88200aff7a2 100644 --- a/src/inet/visualizer/canvas/common/InfoCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/common/InfoCanvasVisualizer.ned @@ -19,7 +19,7 @@ import inet.visualizer.contract.IInfoVisualizer; simple InfoCanvasVisualizer extends InfoVisualizerBase like IInfoVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers @class(InfoCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/common/PacketDropCanvasVisualizer.ned b/src/inet/visualizer/canvas/common/PacketDropCanvasVisualizer.ned index e7545ff2126..78bdfdd35ee 100644 --- a/src/inet/visualizer/canvas/common/PacketDropCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/common/PacketDropCanvasVisualizer.ned @@ -20,9 +20,9 @@ import inet.visualizer.contract.IPacketDropVisualizer; simple PacketDropCanvasVisualizer extends PacketDropVisualizerBase like IPacketDropVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers - double dx = default(32); // specifies how far the animation turns over along the X axis - double dy = default(64); // specifies how far the animation turns over along the Y axis + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers + double dx = default(32); // Specifies how far the animation turns over along the X axis + double dy = default(64); // Specifies how far the animation turns over along the Y axis @class(PacketDropCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/common/QueueCanvasVisualizer.ned b/src/inet/visualizer/canvas/common/QueueCanvasVisualizer.ned index 6a429feff54..b60af4b5756 100644 --- a/src/inet/visualizer/canvas/common/QueueCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/common/QueueCanvasVisualizer.ned @@ -18,7 +18,7 @@ import inet.visualizer.contract.IQueueVisualizer; simple QueueCanvasVisualizer extends QueueVisualizerBase like IQueueVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers @class(QueueCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/common/StatisticCanvasVisualizer.ned b/src/inet/visualizer/canvas/common/StatisticCanvasVisualizer.ned index e7127f7c3fa..7afc08b7ca8 100644 --- a/src/inet/visualizer/canvas/common/StatisticCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/common/StatisticCanvasVisualizer.ned @@ -26,9 +26,9 @@ import inet.visualizer.contract.IStatisticVisualizer; simple StatisticCanvasVisualizer extends StatisticVisualizerBase like IStatisticVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers - string propertyName = default(""); // optional property name of a figure template along the module path of the visualizer - string propertyIndex = default(""); // optional property index of a figure template along the module path of the visualizer + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers + string propertyName = default(""); // Optional property name of a figure template along the module path of the visualizer + string propertyIndex = default(""); // Optional property index of a figure template along the module path of the visualizer @class(StatisticCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/configurator/FailureProtectionConfigurationCanvasVisualizer.ned b/src/inet/visualizer/canvas/configurator/FailureProtectionConfigurationCanvasVisualizer.ned index 58e027671ff..ca655bec812 100644 --- a/src/inet/visualizer/canvas/configurator/FailureProtectionConfigurationCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/configurator/FailureProtectionConfigurationCanvasVisualizer.ned @@ -15,7 +15,7 @@ simple FailureProtectionConfigurationCanvasVisualizer extends TreeVisualizerBase parameters: string failureProtectionConfiguratorModule = default("failureProtectionConfigurator"); string streamFilter = default("*"); - double zIndex = default(3); // determines the drawing order of figures relative to other visualizers + double zIndex = default(3); // Determines the drawing order of figures relative to other visualizers @class(FailureProtectionConfigurationCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/configurator/StreamRedundancyConfigurationCanvasVisualizer.ned b/src/inet/visualizer/canvas/configurator/StreamRedundancyConfigurationCanvasVisualizer.ned index f4103d182ec..1d42cd4d67d 100644 --- a/src/inet/visualizer/canvas/configurator/StreamRedundancyConfigurationCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/configurator/StreamRedundancyConfigurationCanvasVisualizer.ned @@ -15,7 +15,7 @@ simple StreamRedundancyConfigurationCanvasVisualizer extends TreeVisualizerBase parameters: string streamRedundancyConfiguratorModule = default("streamRedundancyConfigurator"); string streamFilter = default("*"); - double zIndex = default(3); // determines the drawing order of figures relative to other visualizers + double zIndex = default(3); // Determines the drawing order of figures relative to other visualizers @class(StreamRedundancyConfigurationCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/environment/PhysicalEnvironmentCanvasVisualizer.ned b/src/inet/visualizer/canvas/environment/PhysicalEnvironmentCanvasVisualizer.ned index ebba72ebc7b..3463391916f 100644 --- a/src/inet/visualizer/canvas/environment/PhysicalEnvironmentCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/environment/PhysicalEnvironmentCanvasVisualizer.ned @@ -23,7 +23,7 @@ import inet.visualizer.contract.IPhysicalEnvironmentVisualizer; simple PhysicalEnvironmentCanvasVisualizer extends PhysicalEnvironmentVisualizerBase like IPhysicalEnvironmentVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers @class(PhysicalEnvironmentCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/flow/PacketFlowCanvasVisualizer.ned b/src/inet/visualizer/canvas/flow/PacketFlowCanvasVisualizer.ned index 4979f492ec0..6fd52373e41 100644 --- a/src/inet/visualizer/canvas/flow/PacketFlowCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/flow/PacketFlowCanvasVisualizer.ned @@ -18,7 +18,7 @@ simple PacketFlowCanvasVisualizer extends PathVisualizerBase like IPacketFlowVis labelFormat = default("%L %p pk (%l)"); lineStyle = default("dashed"); fadeOutTime = default(0s); - double zIndex = default(4); // determines the drawing order of figures relative to other visualizers + double zIndex = default(4); // Determines the drawing order of figures relative to other visualizers @class(PacketFlowCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/linklayer/DataLinkCanvasVisualizer.ned b/src/inet/visualizer/canvas/linklayer/DataLinkCanvasVisualizer.ned index 6973eeae77a..5a38f9f35e9 100644 --- a/src/inet/visualizer/canvas/linklayer/DataLinkCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/linklayer/DataLinkCanvasVisualizer.ned @@ -24,7 +24,7 @@ import inet.visualizer.contract.IDataLinkVisualizer; simple DataLinkCanvasVisualizer extends DataLinkVisualizerBase like IDataLinkVisualizer { parameters: - double zIndex = default(2); // determines the drawing order of figures relative to other visualizers + double zIndex = default(2); // Determines the drawing order of figures relative to other visualizers @class(DataLinkCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/linklayer/Ieee80211CanvasVisualizer.ned b/src/inet/visualizer/canvas/linklayer/Ieee80211CanvasVisualizer.ned index d9ad4d486f0..8fdce0c9e37 100644 --- a/src/inet/visualizer/canvas/linklayer/Ieee80211CanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/linklayer/Ieee80211CanvasVisualizer.ned @@ -19,7 +19,7 @@ import inet.visualizer.contract.IIeee80211Visualizer; simple Ieee80211CanvasVisualizer extends Ieee80211VisualizerBase like IIeee80211Visualizer { parameters: - double zIndex = default(2); // determines the drawing order of figures relative to other visualizers + double zIndex = default(2); // Determines the drawing order of figures relative to other visualizers @class(Ieee80211CanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned b/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned index 4a15c902ea8..0d520019637 100644 --- a/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned @@ -19,8 +19,8 @@ import inet.visualizer.contract.IInterfaceTableVisualizer; simple InterfaceTableCanvasVisualizer extends InterfaceTableVisualizerBase like IInterfaceTableVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers - string anchor @enum("l","r","t") = default("l"); // specifies beginning/end/middle + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers + string anchor @enum("l","r","t") = default("l"); // Specifies beginning/end/middle @class(InterfaceTableCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/linklayer/LinkBreakCanvasVisualizer.ned b/src/inet/visualizer/canvas/linklayer/LinkBreakCanvasVisualizer.ned index e132dde0538..fa57621c289 100644 --- a/src/inet/visualizer/canvas/linklayer/LinkBreakCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/linklayer/LinkBreakCanvasVisualizer.ned @@ -21,7 +21,7 @@ import inet.visualizer.contract.ILinkBreakVisualizer; simple LinkBreakCanvasVisualizer extends LinkBreakVisualizerBase like ILinkBreakVisualizer { parameters: - double zIndex = default(2); // determines the drawing order of figures relative to other visualizers + double zIndex = default(2); // Determines the drawing order of figures relative to other visualizers @class(LinkBreakCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/mobility/MobilityCanvasVisualizer.ned b/src/inet/visualizer/canvas/mobility/MobilityCanvasVisualizer.ned index 338cf277900..cd424570030 100644 --- a/src/inet/visualizer/canvas/mobility/MobilityCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/mobility/MobilityCanvasVisualizer.ned @@ -20,7 +20,7 @@ import inet.visualizer.contract.IMobilityVisualizer; simple MobilityCanvasVisualizer extends MobilityVisualizerBase like IMobilityVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers @class(MobilityCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/networklayer/NetworkRouteCanvasVisualizer.ned b/src/inet/visualizer/canvas/networklayer/NetworkRouteCanvasVisualizer.ned index 2b344c46b07..89f8e0bb475 100644 --- a/src/inet/visualizer/canvas/networklayer/NetworkRouteCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/networklayer/NetworkRouteCanvasVisualizer.ned @@ -24,7 +24,7 @@ import inet.visualizer.contract.INetworkRouteVisualizer; simple NetworkRouteCanvasVisualizer extends PathVisualizerBase like INetworkRouteVisualizer { parameters: - double zIndex = default(3); // determines the drawing order of figures relative to other visualizers + double zIndex = default(3); // Determines the drawing order of figures relative to other visualizers @class(NetworkRouteCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/networklayer/RoutingTableCanvasVisualizer.ned b/src/inet/visualizer/canvas/networklayer/RoutingTableCanvasVisualizer.ned index 8827fd73e20..5a1f5eb0134 100644 --- a/src/inet/visualizer/canvas/networklayer/RoutingTableCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/networklayer/RoutingTableCanvasVisualizer.ned @@ -21,7 +21,7 @@ import inet.visualizer.contract.IRoutingTableVisualizer; simple RoutingTableCanvasVisualizer extends RoutingTableVisualizerBase like IRoutingTableVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers @class(RoutingTableCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/physicallayer/ChannelCanvasVisualizer.ned b/src/inet/visualizer/canvas/physicallayer/ChannelCanvasVisualizer.ned index c311b28fb38..045503aa6cd 100644 --- a/src/inet/visualizer/canvas/physicallayer/ChannelCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/physicallayer/ChannelCanvasVisualizer.ned @@ -13,7 +13,7 @@ import inet.visualizer.contract.IChannelVisualizer; simple ChannelCanvasVisualizer extends ChannelVisualizerBase like IChannelVisualizer { parameters: - double zIndex = default(1); // determines the drawing order of figures relative to other visualizers + double zIndex = default(1); // Determines the drawing order of figures relative to other visualizers @class(ChannelCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/physicallayer/MediumCanvasVisualizer.ned b/src/inet/visualizer/canvas/physicallayer/MediumCanvasVisualizer.ned index cdec166f1b5..d4e6167edc4 100644 --- a/src/inet/visualizer/canvas/physicallayer/MediumCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/physicallayer/MediumCanvasVisualizer.ned @@ -23,20 +23,20 @@ import inet.visualizer.contract.IMediumVisualizer; simple MediumCanvasVisualizer extends MediumVisualizerBase like IMediumVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers - - string signalShape @enum("ring", "sphere") = default("ring"); // shape for displaying signals - double signalOpacity = default(0.5); // signal opacity, value must be in the range [0, 1] - int signalRingCount = default(20); // number of stationary rings around the transmitter, value must be in the range [0, +inf) - double signalRingSize @unit(m) = default(50m); // width of stationary rings, value must be in the range (0, +inf) - double signalFadingDistance @unit(m) = default(50m); // distance parameter for exponential opacity decreasing, value must be in the range (0, +inf) - double signalFadingFactor = default(1.2); // factor parameter for exponential opacity decreasing, value must be in the range (1, +inf) - int signalWaveCount = default(20); // number of moving circles representing waves around the transmitter, value must be in the range [0, +inf) - double signalWaveLength @unit(m) = default(50m); // distance between moving circles representing waves, value must be in the range (0, +inf) - double signalWaveWidth @unit(m) = default(10m); // width of moving circles representing waves, value must be in the range (0, +inf) - double signalWaveFadingAnimationSpeedFactor = default(1); // value must be in the range [0, 1] - - bool displayCommunicationHeat = default(false); // when enabled the radio medium displays recent successful receptions as a heat map overlay + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers + + string signalShape @enum("ring", "sphere") = default("ring"); // Shape for displaying signals + double signalOpacity = default(0.5); // Signal opacity, value must be in the range [0, 1] + int signalRingCount = default(20); // Number of stationary rings around the transmitter, value must be in the range [0, +inf) + double signalRingSize @unit(m) = default(50m); // Width of stationary rings, value must be in the range (0, +inf) + double signalFadingDistance @unit(m) = default(50m); // Distance parameter for exponential opacity decreasing, value must be in the range (0, +inf) + double signalFadingFactor = default(1.2); // Factor parameter for exponential opacity decreasing, value must be in the range (1, +inf) + int signalWaveCount = default(20); // Number of moving circles representing waves around the transmitter, value must be in the range [0, +inf) + double signalWaveLength @unit(m) = default(50m); // Distance between moving circles representing waves, value must be in the range (0, +inf) + double signalWaveWidth @unit(m) = default(10m); // Width of moving circles representing waves, value must be in the range (0, +inf) + double signalWaveFadingAnimationSpeedFactor = default(1); // Value must be in the range [0, 1] + + bool displayCommunicationHeat = default(false); // When enabled the radio medium displays recent successful receptions as a heat map overlay @class(MediumCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/physicallayer/PhysicalLinkCanvasVisualizer.ned b/src/inet/visualizer/canvas/physicallayer/PhysicalLinkCanvasVisualizer.ned index 90506b20995..f6b553cb907 100644 --- a/src/inet/visualizer/canvas/physicallayer/PhysicalLinkCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/physicallayer/PhysicalLinkCanvasVisualizer.ned @@ -24,7 +24,7 @@ import inet.visualizer.contract.IPhysicalLinkVisualizer; simple PhysicalLinkCanvasVisualizer extends PhysicalLinkVisualizerBase like IPhysicalLinkVisualizer { parameters: - double zIndex = default(1); // determines the drawing order of figures relative to other visualizers + double zIndex = default(1); // Determines the drawing order of figures relative to other visualizers @class(PhysicalLinkCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/physicallayer/RadioCanvasVisualizer.ned b/src/inet/visualizer/canvas/physicallayer/RadioCanvasVisualizer.ned index b446207d611..b78ebc160b1 100644 --- a/src/inet/visualizer/canvas/physicallayer/RadioCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/physicallayer/RadioCanvasVisualizer.ned @@ -18,7 +18,7 @@ import inet.visualizer.contract.IRadioVisualizer; simple RadioCanvasVisualizer extends RadioVisualizerBase like IRadioVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers @class(RadioCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/physicallayer/TracingObstacleLossCanvasVisualizer.ned b/src/inet/visualizer/canvas/physicallayer/TracingObstacleLossCanvasVisualizer.ned index cfce826a2ee..a3a9d96a397 100644 --- a/src/inet/visualizer/canvas/physicallayer/TracingObstacleLossCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/physicallayer/TracingObstacleLossCanvasVisualizer.ned @@ -20,7 +20,7 @@ import inet.visualizer.contract.ITracingObstacleLossVisualizer; simple TracingObstacleLossCanvasVisualizer extends TracingObstacleLossVisualizerBase like ITracingObstacleLossVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers @class(TracingObstacleLossCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.ned b/src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.ned index 6a02f5de3cd..aa809562872 100644 --- a/src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/power/EnergyStorageCanvasVisualizer.ned @@ -18,7 +18,7 @@ import inet.visualizer.contract.IEnergyStorageVisualizer; simple EnergyStorageCanvasVisualizer extends EnergyStorageVisualizerBase like IEnergyStorageVisualizer { parameters: - double zIndex = default(10); // determines the drawing order of figures relative to other visualizers + double zIndex = default(10); // Determines the drawing order of figures relative to other visualizers @class(EnergyStorageCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/scene/NetworkConnectionCanvasVisualizer.ned b/src/inet/visualizer/canvas/scene/NetworkConnectionCanvasVisualizer.ned index c041fbe8123..1db49947cb7 100644 --- a/src/inet/visualizer/canvas/scene/NetworkConnectionCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/scene/NetworkConnectionCanvasVisualizer.ned @@ -18,8 +18,8 @@ import inet.visualizer.contract.INetworkConnectionVisualizer; simple NetworkConnectionCanvasVisualizer extends NetworkConnectionVisualizerBase like INetworkConnectionVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers - nodeFilter = default(""); // disabled because omnetpp displays network connections by default + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers + nodeFilter = default(""); // Disabled because omnetpp displays network connections by default @class(NetworkConnectionCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/scene/NetworkNodeCanvasVisualizer.ned b/src/inet/visualizer/canvas/scene/NetworkNodeCanvasVisualizer.ned index 3e6148afabe..84be2ce2f4a 100644 --- a/src/inet/visualizer/canvas/scene/NetworkNodeCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/scene/NetworkNodeCanvasVisualizer.ned @@ -20,7 +20,7 @@ import inet.visualizer.contract.INetworkNodeVisualizer; simple NetworkNodeCanvasVisualizer extends NetworkNodeVisualizerBase like INetworkNodeVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers @class(NetworkNodeCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/scene/OpenStreetMapSceneCanvasVisualizer.ned b/src/inet/visualizer/canvas/scene/OpenStreetMapSceneCanvasVisualizer.ned index d3bc352c611..70227412616 100644 --- a/src/inet/visualizer/canvas/scene/OpenStreetMapSceneCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/scene/OpenStreetMapSceneCanvasVisualizer.ned @@ -21,11 +21,11 @@ simple OpenStreetMapSceneCanvasVisualizer extends SceneVisualizerBase like IScen { parameters: @class(OpenStreetMapSceneCanvasVisualizer); - string coordinateSystemModule = default("coordinateSystem"); // the geographic coordinate system, refers to a top level module by default + string coordinateSystemModule = default("coordinateSystem"); // The geographic coordinate system, refers to a top level module by default xml mapFile; // OpenStreetMap map file, e.g. one exported from openstreetmap.org - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers - bool adjustBackgroundBox = default(true); // if true, sets background box (bgb tag) to match map bounds + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers + bool adjustBackgroundBox = default(true); // If true, sets background box (bgb tag) to match map bounds } diff --git a/src/inet/visualizer/canvas/scene/SceneCanvasVisualizer.ned b/src/inet/visualizer/canvas/scene/SceneCanvasVisualizer.ned index c524632dd34..c996a66297d 100644 --- a/src/inet/visualizer/canvas/scene/SceneCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/scene/SceneCanvasVisualizer.ned @@ -21,14 +21,14 @@ import inet.visualizer.contract.ISceneVisualizer; simple SceneCanvasVisualizer extends SceneVisualizerBase like ISceneVisualizer { parameters: - double zIndex = default(0); // determines the drawing order of figures relative to other visualizers - string viewAngle @mutable = default("x right y down z out"); // view angle is either () + double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers + string viewAngle @mutable = default("x right y down z out"); // View angle is either () // - a valid combination of the words: x, y, z, left/right, up/down, in/out or // - one of isometric, isometricN (where 0 <= N < 48) // - 3 rotation angles and leftHanded/rightHanded - string viewScale @mutable = default("1 1"); // the 2D scale is applied after the view projection - string viewTranslation @mutable = default("0 0"); // the 2D translation is applied after the view projection - string descriptionFigure = default(""); // if not empty, it should be the name of a text figure; it will display the active configuration's description + string viewScale @mutable = default("1 1"); // The 2D scale is applied after the view projection + string viewTranslation @mutable = default("0 0"); // The 2D translation is applied after the view projection + string descriptionFigure = default(""); // If not empty, it should be the name of a text figure; it will display the active configuration's description @class(SceneCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/transportlayer/TransportConnectionCanvasVisualizer.ned b/src/inet/visualizer/canvas/transportlayer/TransportConnectionCanvasVisualizer.ned index 78f9f42654c..cad2210cd93 100644 --- a/src/inet/visualizer/canvas/transportlayer/TransportConnectionCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/transportlayer/TransportConnectionCanvasVisualizer.ned @@ -20,7 +20,7 @@ import inet.visualizer.contract.ITransportConnectionVisualizer; simple TransportConnectionCanvasVisualizer extends TransportConnectionVisualizerBase like ITransportConnectionVisualizer { parameters: - double zIndex = default(4); // determines the drawing order of figures relative to other visualizers + double zIndex = default(4); // Determines the drawing order of figures relative to other visualizers @class(TransportConnectionCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/transportlayer/TransportRouteCanvasVisualizer.ned b/src/inet/visualizer/canvas/transportlayer/TransportRouteCanvasVisualizer.ned index 4a1789a672e..01676dcf8af 100644 --- a/src/inet/visualizer/canvas/transportlayer/TransportRouteCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/transportlayer/TransportRouteCanvasVisualizer.ned @@ -24,7 +24,7 @@ import inet.visualizer.contract.ITransportRouteVisualizer; simple TransportRouteCanvasVisualizer extends PathVisualizerBase like ITransportRouteVisualizer { parameters: - double zIndex = default(4); // determines the drawing order of figures relative to other visualizers + double zIndex = default(4); // Determines the drawing order of figures relative to other visualizers @class(TransportRouteCanvasVisualizer); } diff --git a/src/inet/visualizer/osg/base/SceneOsgVisualizerBase.ned b/src/inet/visualizer/osg/base/SceneOsgVisualizerBase.ned index c861f0d986d..cd044bc4f41 100644 --- a/src/inet/visualizer/osg/base/SceneOsgVisualizerBase.ned +++ b/src/inet/visualizer/osg/base/SceneOsgVisualizerBase.ned @@ -18,19 +18,19 @@ import inet.visualizer.base.SceneVisualizerBase; simple SceneOsgVisualizerBase extends SceneVisualizerBase { parameters: - string cameraManipulator @enum("auto","trackball","overview","terrain","earth") = default("auto"); // type of camera manipulator - double cameraDistanceFactor = default(5); // camera distance relative to the network bounding sphere radius - double zNear @unit(m) = default(1m); // near distance for Z buffer optimization - double zFar @unit(m) = default(100000m); // far distance for Z buffer optimization - double fieldOfView @unit(deg) = default(30deg); // camera field of view - string clearColor = default(""); // scene background color, not set by default + string cameraManipulator @enum("auto","trackball","overview","terrain","earth") = default("auto"); // Type of camera manipulator + double cameraDistanceFactor = default(5); // Camera distance relative to the network bounding sphere radius + double zNear @unit(m) = default(1m); // Near distance for Z buffer optimization + double zFar @unit(m) = default(100000m); // Far distance for Z buffer optimization + double fieldOfView @unit(deg) = default(30deg); // Camera field of view + string clearColor = default(""); // Scene background color, not set by default - bool displayScene = default(true); // display the scene, enabled by default - string sceneColor = default("#A0E0A0"); // scene solid color if scene texture is not provided, gray by default - double sceneOpacity = default(1.0); // scene opacity, opaque by default (not recommended to change) - string sceneImage = default(""); // scene texture (repeated), no image by default - double sceneImageSize @unit(m) = default(1m); // scene texture size - bool sceneShading = default(true); // exponential shading for scene color, enabled by default + bool displayScene = default(true); // Display the scene, enabled by default + string sceneColor = default("#A0E0A0"); // Scene solid color if scene texture is not provided, gray by default + double sceneOpacity = default(1.0); // Scene opacity, opaque by default (not recommended to change) + string sceneImage = default(""); // Scene texture (repeated), no image by default + double sceneImageSize @unit(m) = default(1m); // Scene texture size + bool sceneShading = default(true); // Exponential shading for scene color, enabled by default @class(SceneOsgVisualizerBase); } diff --git a/src/inet/visualizer/osg/environment/PhysicalEnvironmentOsgVisualizer.ned b/src/inet/visualizer/osg/environment/PhysicalEnvironmentOsgVisualizer.ned index f88d6500418..ba573ede2dd 100644 --- a/src/inet/visualizer/osg/environment/PhysicalEnvironmentOsgVisualizer.ned +++ b/src/inet/visualizer/osg/environment/PhysicalEnvironmentOsgVisualizer.ned @@ -22,6 +22,6 @@ simple PhysicalEnvironmentOsgVisualizer extends PhysicalEnvironmentVisualizerBas { parameters: @class(PhysicalEnvironmentOsgVisualizer); - bool enableObjectOpacity = default(true); // display physical objects potentially transparently as specified in the opacitiy attribute (might cause z-fighting for transparent objects) + bool enableObjectOpacity = default(true); // Display physical objects potentially transparently as specified in the opacitiy attribute (might cause z-fighting for transparent objects) } diff --git a/src/inet/visualizer/osg/physicallayer/MediumOsgVisualizer.ned b/src/inet/visualizer/osg/physicallayer/MediumOsgVisualizer.ned index f25c4eec683..4ce8a799ded 100644 --- a/src/inet/visualizer/osg/physicallayer/MediumOsgVisualizer.ned +++ b/src/inet/visualizer/osg/physicallayer/MediumOsgVisualizer.ned @@ -25,19 +25,19 @@ import inet.visualizer.contract.IMediumVisualizer; simple MediumOsgVisualizer extends MediumVisualizerBase like IMediumVisualizer { parameters: - string signalShape @enum("ring", "sphere", "both") = default("ring"); // shape for displaying signals - string signalPlane @enum("camera","xy","xz","yz") = default("xy"); // plane for 2 dimensional signal shapes - double signalFadingDistance @unit(m) = default(100m); // distance parameter for exponential opacity decreasing - double signalFadingFactor = default(1.5); // factor parameter for exponential opacity decreasing, value must be in the range (1.0, +inf) - double signalWaveLength @unit(m) = default(100m); // distance between signal waves, value must be in the range (0, +inf) - double signalWaveAmplitude = default(0.5); // relative opacity amplitude of signal waves, value must be in the range [0, 1] - double signalWaveFadingAnimationSpeedFactor = default(1.0); // value must be in the range [0, 1] - - string transmissionPlane @enum("camera","xy","xz","yz") = default("camera"); // plane for transmission image - string receptionPlane @enum("camera","xy","xz","yz") = default("camera"); // plane for reception image - - string communicationRangePlane @enum("camera","xy","xz","yz") = default("xy"); // plane for the transmission range circle - string interferenceRangePlane @enum("camera","xy","xz","yz") = default("xy"); // plane for the interference range circle + string signalShape @enum("ring", "sphere", "both") = default("ring"); // Shape for displaying signals + string signalPlane @enum("camera","xy","xz","yz") = default("xy"); // Plane for 2 dimensional signal shapes + double signalFadingDistance @unit(m) = default(100m); // Distance parameter for exponential opacity decreasing + double signalFadingFactor = default(1.5); // Factor parameter for exponential opacity decreasing, value must be in the range (1.0, +inf) + double signalWaveLength @unit(m) = default(100m); // Distance between signal waves, value must be in the range (0, +inf) + double signalWaveAmplitude = default(0.5); // Relative opacity amplitude of signal waves, value must be in the range [0, 1] + double signalWaveFadingAnimationSpeedFactor = default(1.0); // Value must be in the range [0, 1] + + string transmissionPlane @enum("camera","xy","xz","yz") = default("camera"); // Plane for transmission image + string receptionPlane @enum("camera","xy","xz","yz") = default("camera"); // Plane for reception image + + string communicationRangePlane @enum("camera","xy","xz","yz") = default("xy"); // Plane for the transmission range circle + string interferenceRangePlane @enum("camera","xy","xz","yz") = default("xy"); // Plane for the interference range circle @class(MediumOsgVisualizer); } diff --git a/src/inet/visualizer/osg/scene/NetworkNodeOsgVisualizer.ned b/src/inet/visualizer/osg/scene/NetworkNodeOsgVisualizer.ned index 4f5ab27d248..5a7a8082e4c 100644 --- a/src/inet/visualizer/osg/scene/NetworkNodeOsgVisualizer.ned +++ b/src/inet/visualizer/osg/scene/NetworkNodeOsgVisualizer.ned @@ -25,6 +25,6 @@ simple NetworkNodeOsgVisualizer extends NetworkNodeVisualizerBase like INetworkN { parameters: @class(NetworkNodeOsgVisualizer); - bool displayModuleName = default(true); // display network node name, enabled by default + bool displayModuleName = default(true); // Display network node name, enabled by default } diff --git a/src/inet/visualizer/osg/scene/SceneOsgEarthVisualizer.ned b/src/inet/visualizer/osg/scene/SceneOsgEarthVisualizer.ned index cefcf7ff06a..ec0b39289db 100644 --- a/src/inet/visualizer/osg/scene/SceneOsgEarthVisualizer.ned +++ b/src/inet/visualizer/osg/scene/SceneOsgEarthVisualizer.ned @@ -24,7 +24,7 @@ simple SceneOsgEarthVisualizer extends SceneOsgVisualizerBase like ISceneVisuali { parameters: @class(SceneOsgEarthVisualizer); - string coordinateSystemModule = default("coordinateSystem"); // the geographic coordinate system, refers to a top level module by default - string mapFile; // map file, e.g. some part of the earth, mandatory parameter + string coordinateSystemModule = default("coordinateSystem"); // The geographic coordinate system, refers to a top level module by default + string mapFile; // Map file, e.g. some part of the earth, mandatory parameter } diff --git a/src/inet/visualizer/osg/scene/SceneOsgVisualizer.ned b/src/inet/visualizer/osg/scene/SceneOsgVisualizer.ned index 03c15745b2a..413bc60d1d2 100644 --- a/src/inet/visualizer/osg/scene/SceneOsgVisualizer.ned +++ b/src/inet/visualizer/osg/scene/SceneOsgVisualizer.ned @@ -23,6 +23,6 @@ simple SceneOsgVisualizer extends SceneOsgVisualizerBase like ISceneVisualizer { parameters: @class(SceneOsgVisualizer); - clearColor = default("#FFFFFF"); // scene background color, white by default + clearColor = default("#FFFFFF"); // Scene background color, white by default }