diff --git a/src/inet/applications/ethernet/EtherAppServer.ned b/src/inet/applications/ethernet/EtherAppServer.ned index 13869feae5e..ffa1f7f7fbb 100644 --- a/src/inet/applications/ethernet/EtherAppServer.ned +++ b/src/inet/applications/ethernet/EtherAppServer.ned @@ -17,7 +17,7 @@ simple EtherAppServer parameters: int localSAP = default(0xf1); @lifecycleSupport; - double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finished + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation is finished double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @display("i=block/app"); @signal[packetSent](type=inet::Packet); diff --git a/src/inet/applications/ethernet/EthernetSocketIo.ned b/src/inet/applications/ethernet/EthernetSocketIo.ned index 88fd9b1f4c0..0ff69b4115b 100644 --- a/src/inet/applications/ethernet/EthernetSocketIo.ned +++ b/src/inet/applications/ethernet/EthernetSocketIo.ned @@ -17,7 +17,7 @@ simple EthernetSocketIo 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 + string remoteAddress = default(""); // Remote 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 diff --git a/src/inet/applications/generic/IpvxTrafSink.ned b/src/inet/applications/generic/IpvxTrafSink.ned index d44824307e9..0a7b6d8abc2 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 values 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 aee462cfaaf..213103a47a5 100644 --- a/src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned +++ b/src/inet/applications/ieee8022/Ieee8022LlcSocketIo.ned @@ -19,7 +19,7 @@ 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 stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finishes double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @lifecycleSupport(); @display("i=block/socket"); diff --git a/src/inet/applications/ipapp/IpSocketIo.ned b/src/inet/applications/ipapp/IpSocketIo.ned index d4860e58d13..dd2358f4755 100644 --- a/src/inet/applications/ipapp/IpSocketIo.ned +++ b/src/inet/applications/ipapp/IpSocketIo.ned @@ -17,7 +17,7 @@ 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 stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finishes double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @lifecycleSupport(); @display("i=block/socket"); diff --git a/src/inet/applications/pingapp/PingApp.ned b/src/inet/applications/pingapp/PingApp.ned index 590f6f973f2..b3b2b7e9ca3 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 destAddr = default(""); // Destination address(es), separated by spaces, "*" means all IPv4/IPv6 interfaces in the entire simulation string srcAddr = default(""); // Source address (useful with multi-homing) - int packetSize @unit(B) = default(56B); // Of ping payload, in bytes + int packetSize @unit(B) = default(56B); // Size 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 + int count = default(-1); // Number of ping 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 the 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 the 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 the lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the lifecycle stop operation @signal[rtt](type=simtime_t); @signal[numLost](type=long); @signal[numOutOfOrderArrivals](type=long); diff --git a/src/inet/applications/rtpapp/RtpApplication.ned b/src/inet/applications/rtpapp/RtpApplication.ned index 06a9afff31d..7bcf301b603 100644 --- a/src/inet/applications/rtpapp/RtpApplication.ned +++ b/src/inet/applications/rtpapp/RtpApplication.ned @@ -21,12 +21,12 @@ simple RtpApplication 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 + 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 "") + double sessionEnterDelay @unit(s); // Delay before starting a new session + double transmissionStartDelay @unit(s); // Delay before starting transmission (related to "sender module created") + double transmissionStopDelay @unit(s); // Delay before stopping transmission (related to "start transmission") + double sessionLeaveDelay @unit(s); // Delay before leaving session (related to "file transmission finished/stopped" or "session entered" when fileName is "") @selfMessageKinds(inet::RtpAppSelfMsgKinds); // Kind used in self messages gates: diff --git a/src/inet/applications/sctpapp/SctpClient.ned b/src/inet/applications/sctpapp/SctpClient.ned index 6237d6ba34c..4c0c3c81011 100644 --- a/src/inet/applications/sctpapp/SctpClient.ned +++ b/src/inet/applications/sctpapp/SctpClient.ned @@ -17,27 +17,27 @@ import inet.applications.contract.IApp; simple SctpClient like IApp { parameters: - string localAddress = default(""); // Comma separated list of addresses + 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 + double startTime @unit(s) = default(1s); // Time the 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 - 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 waitToClose @unit(s) = default(0s); // Time to wait between the last message sent and abort + double reconnectInterval @unit(s) = default(0s); // If the 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 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 - double prValue = default(0); //for PR-SCTP + 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); 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 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 primaryTime @unit(s) = default(0s); diff --git a/src/inet/applications/sctpapp/SctpNatPeer.ned b/src/inet/applications/sctpapp/SctpNatPeer.ned index b8586ad1ac5..6ef3644da2c 100644 --- a/src/inet/applications/sctpapp/SctpNatPeer.ned +++ b/src/inet/applications/sctpapp/SctpNatPeer.ned @@ -12,7 +12,7 @@ import inet.applications.contract.IApp; simple SctpNatPeer like IApp { parameters: - string localAddress = default(""); // Comma separated list of addresses + 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 @@ -21,8 +21,8 @@ simple SctpNatPeer like IApp int numPacketsToReceive = default(0); 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 waitToClose @unit(s) = default(0s); // Time to wait between last message sent and abort + //# double reconnectInterval @unit(s) = default(0); // If the connection breaks, wait this much before trying to reconnect int outboundStreams = default(1); int inboundStreams = default(1); bool echo = default(false); // Echoes received packages when true diff --git a/src/inet/applications/sctpapp/SctpNatServer.ned b/src/inet/applications/sctpapp/SctpNatServer.ned index ba336ea4318..3c4606e3c12 100644 --- a/src/inet/applications/sctpapp/SctpNatServer.ned +++ b/src/inet/applications/sctpapp/SctpNatServer.ned @@ -17,7 +17,7 @@ simple SctpNatServer like IApp int numPacketsToSendPerClient = default(0); // Number of requests sent per session int numPacketsToReceivePerClient = default(1); int requestLength = default(1452); // Length of a request (bytes) - double waitToClose @unit(s) = default(0s); //time to wait between last message sent and abort + double waitToClose @unit(s) = default(0s); // Time to wait between last message sent and abort int outboundStreams = default(1); int inboundStreams = default(1); bool ordered = default(true); diff --git a/src/inet/applications/sctpapp/SctpPeer.ned b/src/inet/applications/sctpapp/SctpPeer.ned index f25ebf43a4c..44b5e409238 100644 --- a/src/inet/applications/sctpapp/SctpPeer.ned +++ b/src/inet/applications/sctpapp/SctpPeer.ned @@ -12,7 +12,7 @@ import inet.applications.contract.IApp; simple SctpPeer like IApp { parameters: - string localAddress = default(""); // Comma separated list of addresses + 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); @@ -21,17 +21,17 @@ simple SctpPeer like IApp int numPacketsToReceivePerClient = default(1); 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 waitToClose @unit(s) = default(0s); // Time to wait between the last message sent and abort bool ordered = default(true); int outboundStreams = default(1); int inboundStreams = default(17); int queueSize = default(0); - 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 + 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 + double startTime @unit(s) = default(1s); // Time the 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 31263104670..2bdc068fd9c 100644 --- a/src/inet/applications/sctpapp/SctpServer.ned +++ b/src/inet/applications/sctpapp/SctpServer.ned @@ -17,7 +17,7 @@ import inet.applications.contract.IApp; simple SctpServer like IApp { parameters: - string localAddress = default(""); // Comma separated list of addresses + 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); @@ -28,14 +28,14 @@ simple SctpServer like IApp int numPacketsToReceivePerClient = default(1); 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 + double waitToClose @unit(s) = default(0s); // Time to wait between last message sent and abort bool finishEndsSimulation = default(false); bool ordered = default(true); int inboundStreams = default(17); int outboundStreams = default(1); int queueSize = default(0); - 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 + 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); double streamRequestTime @unit(s) = default(0s); int streamToReset = default(0); diff --git a/src/inet/applications/tcpapp/TcpBasicClientApp.ned b/src/inet/applications/tcpapp/TcpBasicClientApp.ned index 4376869e1e6..f9591d52de2 100644 --- a/src/inet/applications/tcpapp/TcpBasicClientApp.ned +++ b/src/inet/applications/tcpapp/TcpBasicClientApp.ned @@ -46,22 +46,22 @@ simple TcpBasicClientApp like IApp 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 + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after the previous READ was satisfied; -1 means immediately, 0 means zero delay + double startTime @unit(s) = default(1s); // Time the 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 + volatile double reconnectInterval @unit(s) = default(30s); // If the connection breaks, wait this long 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 the lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the 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 59e1043daa3..5dc6569f1a2 100644 --- a/src/inet/applications/tcpapp/TcpClientSocketIo.ned +++ b/src/inet/applications/tcpapp/TcpClientSocketIo.ned @@ -31,7 +31,7 @@ simple TcpClientSocketIo 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 + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after the 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 8d675de9c2a..8708477a4a3 100644 --- a/src/inet/applications/tcpapp/TcpEchoApp.ned +++ b/src/inet/applications/tcpapp/TcpEchoApp.ned @@ -29,10 +29,10 @@ simple TcpEchoApp extends TcpServerHostApp @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 + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after the 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 the "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 b0e901904cc..a8e05f739f4 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 ("") + string localAddress = default(""); // Local address; it 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 + volatile double readDelay @unit(s) = default(-1s); // Used only with autoRead==false; delay for issuing a READ command after the 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 stopOperationTimeout @unit(s) = default(2s); // Timeout value for the 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/TelnetApp.ned b/src/inet/applications/tcpapp/TelnetApp.ned index 34e52feedba..cc878d85912 100644 --- a/src/inet/applications/tcpapp/TelnetApp.ned +++ b/src/inet/applications/tcpapp/TelnetApp.ned @@ -34,22 +34,22 @@ simple TelnetApp like IApp 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 startTime @unit(s) = default(1s); // Time the 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 thinkTime @unit(s) = default(exponential(10s)); // User waits this much before starting to type a 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 + volatile double reconnectInterval @unit(s) = default(30s); // If the connection breaks, the 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 the lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the 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/tunapp/TunnelApp.ned b/src/inet/applications/tunapp/TunnelApp.ned index 46dcde6610a..3c56e8db72a 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 the lifecycle stop operation finishes + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the lifecycle stop operation @display("i=block/app"); gates: input socketIn; diff --git a/src/inet/applications/udpapp/UdpBasicBurst.ned b/src/inet/applications/udpapp/UdpBasicBurst.ned index 03c839df32e..af295351e0e 100644 --- a/src/inet/applications/udpapp/UdpBasicBurst.ned +++ b/src/inet/applications/udpapp/UdpBasicBurst.ned @@ -104,7 +104,7 @@ simple UdpBasicBurst like IApp 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 + 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 diff --git a/src/inet/applications/udpapp/UdpSink.ned b/src/inet/applications/udpapp/UdpSink.ned index 18e1bd5b7b4..856c8853074 100644 --- a/src/inet/applications/udpapp/UdpSink.ned +++ b/src/inet/applications/udpapp/UdpSink.ned @@ -21,7 +21,7 @@ simple UdpSink like IApp 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 + string multicastSources = default(""); // If non-empty, then the socket receives multicast packets from those sources only @display("i=block/sink"); @lifecycleSupport; diff --git a/src/inet/applications/udpapp/UdpSocketIo.ned b/src/inet/applications/udpapp/UdpSocketIo.ned index ef7a24c3169..d5cc509d019 100644 --- a/src/inet/applications/udpapp/UdpSocketIo.ned +++ b/src/inet/applications/udpapp/UdpSocketIo.ned @@ -19,14 +19,14 @@ simple UdpSocketIo 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 + bool dontFragment = default(false); // If true, ask 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 + bool receiveBroadcast = default(false); // If true, make the socket receive broadcast packets + bool joinLocalMulticastGroups = default(false); // If true, make the socket receive packets from all multicast groups set on local interfaces + double stopOperationExtraTime @unit(s) = default(-1s); // Extra time after lifecycle stop operation finishes double stopOperationTimeout @unit(s) = default(2s); // Timeout value for lifecycle stop operation @lifecycleSupport(); @display("i=block/socket"); diff --git a/src/inet/applications/udpapp/UdpVideoStreamClient.ned b/src/inet/applications/udpapp/UdpVideoStreamClient.ned index bcfd5c2c641..17a1ac1028f 100644 --- a/src/inet/applications/udpapp/UdpVideoStreamClient.ned +++ b/src/inet/applications/udpapp/UdpVideoStreamClient.ned @@ -26,8 +26,8 @@ simple UdpVideoStreamClient like IApp 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 the lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the 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 ccb4eba463b..21fe135c8f7 100644 --- a/src/inet/applications/udpapp/UdpVideoStreamServer.ned +++ b/src/inet/applications/udpapp/UdpVideoStreamServer.ned @@ -31,14 +31,14 @@ simple UdpVideoStreamServer like IApp 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 + volatile int videoSize @unit(B); // Length of the full 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 the lifecycle stop operation is finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the 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/clock/base/ClockBase.ned b/src/inet/clock/base/ClockBase.ned index a90c6f62ab4..cb11052b878 100644 --- a/src/inet/clock/base/ClockBase.ned +++ b/src/inet/clock/base/ClockBase.ned @@ -14,8 +14,8 @@ module ClockBase { parameters: 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 + string referenceClock = default(""); // Full path of the reference clock + double emitClockTimeInterval @unit(s) = default(0s); // A 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/common/ResidenceTimeMeasurer.ned b/src/inet/common/ResidenceTimeMeasurer.ned index e3951c29a45..ca8741d2f20 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 the subscription happens + string measurementStartSignal = default("receptionEnded"); // Subscribed signal for the measurement start + string measurementEndSignal = default("transmissionStarted"); // Subscribed signal for the 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/packet/recorder/PcapRecorder.ned b/src/inet/common/packet/recorder/PcapRecorder.ned index 49df48b951d..ac02ec6026a 100644 --- a/src/inet/common/packet/recorder/PcapRecorder.ned +++ b/src/inet/common/packet/recorder/PcapRecorder.ned @@ -36,7 +36,7 @@ simple PcapRecorder 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). + int timePrecision = default(6); // Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format). 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 diff --git a/src/inet/emulation/common/ExtInterface.ned b/src/inet/emulation/common/ExtInterface.ned index b94d0b751da..f82698739fe 100644 --- a/src/inet/emulation/common/ExtInterface.ned +++ b/src/inet/emulation/common/ExtInterface.ned @@ -50,7 +50,7 @@ module ExtInterface extends NetworkInterface like IExternalInterface string interfaceTableModule; // Module path of the interface table module string device; // Name of the attached OS device (e.g. tap0, veth0, etc.) string namespace = default(""); // Name of the OS network namespace (optional) - string copyConfiguration @enum("","copyToExt","copyFromExt") = default(""); // Copy interface configuration such as MAC address, IP address and MTU from/to the external interface. + string copyConfiguration @enum("","copyToExt","copyFromExt") = default(""); // Copy interface configuration such as MAC address, IP address, and MTU from/to the external interface. string address @mutable = default("auto"); bool broadcast = default(true); bool multicast = default(true); diff --git a/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned b/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned index 0666f147a51..a74499d887b 100644 --- a/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned +++ b/src/inet/emulation/linklayer/ethernet/ExtEthernetSocket.ned @@ -31,7 +31,7 @@ package inet.emulation.linklayer.ethernet; simple ExtEthernetSocket { parameters: - string device; // Name of existing real ethernet device + string device; // Name of an existing real Ethernet device string namespace = default(""); string packetNameFormat = default("Ext-%p-%t-%n"); // Name of received packets @display("i=block/rxtx"); diff --git a/src/inet/emulation/linklayer/ethernet/ExtEthernetTapDevice.ned b/src/inet/emulation/linklayer/ethernet/ExtEthernetTapDevice.ned index f3b236de7ba..526208663c5 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 the 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 a3a035a1988..be33fff5040 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/environment/objectcache/BvhObjectCache.ned b/src/inet/environment/objectcache/BvhObjectCache.ned index 277a4e1cdda..19d5d764a87 100644 --- a/src/inet/environment/objectcache/BvhObjectCache.ned +++ b/src/inet/environment/objectcache/BvhObjectCache.ned @@ -18,7 +18,7 @@ module BvhObjectCache like IObjectCache parameters: string physicalEnvironmentModule = default("^"); 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 + 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 a856b62b328..3f2954791a7 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 into so many cells + int cellCountY = default(10); // Divide space into so many cells + int cellCountZ = default(10); // Divide space into 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 b9ab1a4c544..81c8daa9c69 100644 --- a/src/inet/linklayer/acking/AckingMac.ned +++ b/src/inet/linklayer/acking/AckingMac.ned @@ -25,7 +25,7 @@ import inet.linklayer.contract.IMacProtocol; module AckingMac extends MacProtocolBase like ILinkLayer, IMacProtocol { parameters: - string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or + string address @mutable = default("auto"); // MAC address as a hex string (12 hex digits), or // "auto". "auto" values will be replaced by // a generated MAC address in init stage 0. double bitrate @unit(bps); diff --git a/src/inet/linklayer/bmac/BMac.ned b/src/inet/linklayer/bmac/BMac.ned index 092a5acb34e..931b7379cbe 100644 --- a/src/inet/linklayer/bmac/BMac.ned +++ b/src/inet/linklayer/bmac/BMac.ned @@ -20,9 +20,9 @@ import inet.linklayer.contract.IMacProtocol; module BMac extends MacProtocolBase like IMacProtocol { parameters: - 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. + string address @mutable = default("auto"); // MAC address as a hex string (12 hex digits), or + // "auto". "auto" values will be replaced + // by a generated MAC address in init stage 0. // BMAC specific parameters // how long is one slot? double slotDuration @unit(s) = default(0.1s); @@ -41,12 +41,12 @@ module BMac extends MacProtocolBase like IMacProtocol // bit rate double bitrate @unit(bps) = default(19200 bps); - //should mac send and expect acknowledgments? + // should the MAC send and expect acknowledgments? bool useMACAcks = default(false); - string radioModule = default("^.radio"); // The path to the Radio module //FIXME remove default value + string radioModule = default("^.radio"); // The path to the Radio module // FIXME remove default value - int maxTxAttempts = default(2); // Maximum transmission attempts per data packet, when ACKs are used + int maxTxAttempts = default(2); // Maximum transmission attempts per data packet, when ACKs are used @class(BMac); @signal[linkBroken](type=inet::Packet); diff --git a/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned b/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned index 3d765a78656..6888f1b5cbb 100644 --- a/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned +++ b/src/inet/linklayer/configurator/common/StreamRedundancyConfigurator.ned @@ -22,7 +22,6 @@ simple StreamRedundancyConfigurator like INetworkConfigurator 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"]]]}] + // 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 a3f174caf89..fd7b2769e8f 100644 --- a/src/inet/linklayer/configurator/gatescheduling/base/GateScheduleConfiguratorBase.ned +++ b/src/inet/linklayer/configurator/gatescheduling/base/GateScheduleConfiguratorBase.ned @@ -34,7 +34,7 @@ package inet.linklayer.configurator.gatescheduling.base; simple GateScheduleConfiguratorBase { parameters: - double gateCycleDuration @unit(s); // The globally used gate scheduling period in each PeriodicGate modules + double gateCycleDuration @unit(s); // The globally used gate scheduling period in each PeriodicGate module 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/csmaca/CsmaCaMac.ned b/src/inet/linklayer/csmaca/CsmaCaMac.ned index 93b435a6cbc..12da7002a47 100644 --- a/src/inet/linklayer/csmaca/CsmaCaMac.ned +++ b/src/inet/linklayer/csmaca/CsmaCaMac.ned @@ -49,19 +49,19 @@ import inet.linklayer.contract.IMacProtocol; module CsmaCaMac extends MacProtocolBase like IMacProtocol { parameters: - string radioModule = default("^.radio"); // The path to the Radio module //FIXME remove default value - string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or + string radioModule = default("^.radio"); // The path to the Radio module //FIXME remove the default value + string address @mutable = default("auto"); // MAC address as a hex string (12 hex digits) or // "auto". "auto" values will be replaced by // a generated MAC address in init stage 0. - string fcsMode @enum("declared","computed") = default("declared"); + 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 bytes, minimum 17B for serializing, see CsmaCaMacDataHeader + int ackLength @unit(B) = default(14B); // Maximum 255 bytes, 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 diff --git a/src/inet/linklayer/ethernet/basic/EthernetCsmaMac.ned b/src/inet/linklayer/ethernet/basic/EthernetCsmaMac.ned index 1ef92cf8369..75ceeaecabc 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 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 allowNonstandardBitrate = default(false); // Allows any bitrate and uses the 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 the lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the lifecycle stop operation @class(EthernetCsmaMac); @display("i=block/rxtx"); diff --git a/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned b/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned index 221604f3fcf..27bfa1b6902 100644 --- a/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned +++ b/src/inet/linklayer/ethernet/basic/EthernetEncapsulation.ned @@ -37,8 +37,8 @@ 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 the lifecycle stop operation has finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the lifecycle stop operation @class(EthernetEncapsulation); @display("i=block/layer"); @signal[encapPk](type=cPacket); diff --git a/src/inet/linklayer/ethernet/basic/EthernetInterface.ned b/src/inet/linklayer/ethernet/basic/EthernetInterface.ned index 5360ae6b7b6..566ff9267f9 100644 --- a/src/inet/linklayer/ethernet/basic/EthernetInterface.ned +++ b/src/inet/linklayer/ethernet/basic/EthernetInterface.ned @@ -22,11 +22,11 @@ module EthernetInterface extends NetworkInterface like IEthernetInterface parameters: string interfaceTableModule; string protocol = default("ethernetmac"); - string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or + string address @mutable = default("auto"); // MAC address as a 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 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 4edca67c370..2ac148da069 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 - // ones with matching destination MAC address + 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 a matching destination MAC address 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 the first larger bitrate specified parameters int mtu @unit(B) = default(1500B); - string fcsMode @enum("declared","computed"); + 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 the lifecycle stop operation finished + double stopOperationTimeout @unit(s) = default(2s); // Timeout value for the lifecycle stop operation @class(EthernetMac); @display("i=block/rxtx"); diff --git a/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned b/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned index b3917f1d05a..3a48f154078 100644 --- a/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned +++ b/src/inet/linklayer/ethernet/common/RelayInterfaceLearner.ned @@ -19,7 +19,7 @@ simple RelayInterfaceLearner extends PacketFlowBase like IPacketFlow { parameters: string macTableModule; // Relative module path of MAC table - string interfaceTableModule; // Relative module path of interface table + string interfaceTableModule; // Relative module path of the interface table @class(RelayInterfaceLearner); @display("i=block/blackboard"); } diff --git a/src/inet/linklayer/ieee80211/mac/channelaccess/Edcaf.ned b/src/inet/linklayer/ieee80211/mac/channelaccess/Edcaf.ned index c09f3e4196c..79bf7a72cf9 100644 --- a/src/inet/linklayer/ieee80211/mac/channelaccess/Edcaf.ned +++ b/src/inet/linklayer/ieee80211/mac/channelaccess/Edcaf.ned @@ -55,7 +55,7 @@ module Edcaf parameters: @display("p=100,300"); } - // TODO consider moving QosRecoveryProcedure and QosAckHandler from Edcaf to Hcf, because they seem to be prepared to handle all ACs? + // TODO consider moving QosRecoveryProcedure and QosAckHandler from Edcaf to Hcf, as they seem to be prepared to handle all ACs? ackHandler: QosAckHandler { parameters: @display("p=100,400"); @@ -64,7 +64,7 @@ module Edcaf parameters: @display("p=100,500"); } - // TODO consider moving QosRecoveryProcedure and QosAckHandler from Edcaf to Hcf, because they seem to be prepared to handle all ACs? + // TODO consider moving QosRecoveryProcedure and QosAckHandler from Edcaf to Hcf, as they seem to be prepared to handle all ACs? recoveryProcedure: QosRecoveryProcedure { parameters: cwCalculatorModule = "^"; diff --git a/src/inet/linklayer/ieee80211/mac/contention/Contention.ned b/src/inet/linklayer/ieee80211/mac/contention/Contention.ned index b9bb37cb525..e2c02f43fd1 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 the 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 maybe 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/coordinationfunction/Dcf.ned b/src/inet/linklayer/ieee80211/mac/coordinationfunction/Dcf.ned index 0e7703f0cf6..c235ea0d332 100644 --- a/src/inet/linklayer/ieee80211/mac/coordinationfunction/Dcf.ned +++ b/src/inet/linklayer/ieee80211/mac/coordinationfunction/Dcf.ned @@ -67,7 +67,7 @@ module Dcf like IDcf @statistic[datarateSelected](title="datarates selected"; record=vector; interpolationmode=none); submodules: - // TODO consider merging Dcaf into Dcf, because its not like the relationship between Hcf and Edcaf or + // TODO consider merging Dcaf into Dcf because it's not like the relationship between Hcf and Edcaf or // TODO maybe move PendingQueue and InProgressFrames in Edcaf? channelAccess: Dcaf { parameters: diff --git a/src/inet/linklayer/ieee80211/mac/ratecontrol/AarfRateControl.ned b/src/inet/linklayer/ieee80211/mac/ratecontrol/AarfRateControl.ned index ac18970ddaf..95f1850b4ac 100644 --- a/src/inet/linklayer/ieee80211/mac/ratecontrol/AarfRateControl.ned +++ b/src/inet/linklayer/ieee80211/mac/ratecontrol/AarfRateControl.ned @@ -17,12 +17,12 @@ import inet.linklayer.ieee80211.mac.contract.IRateControl; simple AarfRateControl like IRateControl { parameters: - double initialRate @unit(bps) = default(-1bps); // -1 means fastest mandatory rate + double initialRate @unit(bps) = default(-1bps); // -1 means the fastest mandatory rate double interval @unit(s) = default(50ms); // The rate (unconditionally) increases after each time interval. int increaseThreshold = default(10); // Number of successful transmissions needed to increase the rate - int decreaseThreshold = default(2); // Number of consecutive unsuccessful transmissions (in the sense that ACK does not arrive within timeout) + int decreaseThreshold = default(2); // Number of consecutive unsuccessful transmissions (in the sense that the ACK does not arrive within the timeout) // needed to increase the rate - double increaseThresholdFactor = default(2); // When the transmission of probing packet fails, we multiply by "increaseThresholdFactor" the increaseThreshold. + double increaseThresholdFactor = default(2); // When the transmission of the probing packet fails, increaseThreshold is multiplied by increaseThresholdFactor. int maxIncreaseThreshold = default(50); // Upper bound for increaseThreshold. @display("i=block/cogwheel"); @signal[datarateChanged]; diff --git a/src/inet/linklayer/ieee80211/mac/ratecontrol/OnoeRateControl.ned b/src/inet/linklayer/ieee80211/mac/ratecontrol/OnoeRateControl.ned index 5efe743c004..9cce56b1ee4 100644 --- a/src/inet/linklayer/ieee80211/mac/ratecontrol/OnoeRateControl.ned +++ b/src/inet/linklayer/ieee80211/mac/ratecontrol/OnoeRateControl.ned @@ -16,7 +16,7 @@ import inet.linklayer.ieee80211.mac.contract.IRateControl; simple OnoeRateControl like IRateControl { parameters: - double initialRate @unit(bps) = default(-1bps); // -1 means fastest mandatory rate + double initialRate @unit(bps) = default(-1bps); // -1 means the fastest mandatory rate double interval @unit(s) = default(1s); @display("i=block/cogwheel"); @signal[datarateChanged]; diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned index ee671475830..ebbfc1e9702 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211AgentSta.ned @@ -25,7 +25,7 @@ simple Ieee80211AgentSta like IIeee80211Agent 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 + 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 84055a828ec..3fd72fd1580 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAdhoc.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAdhoc.ned @@ -22,7 +22,6 @@ 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 satisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to satisfy the IIeee80211Mgmt interface } - diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned index 3d58ebe2b0c..dfae67e4380 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtAp.ned @@ -34,7 +34,6 @@ simple Ieee80211MgmtAp like IIeee80211Mgmt 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 agentIn @loose; // Unused dummy to satisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to satisfy the IIeee80211Mgmt interface } - diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned index 7fee9ebcc92..611241e347f 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtApSimplified.ned @@ -24,7 +24,6 @@ simple Ieee80211MgmtApSimplified like IIeee80211Mgmt 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 agentIn @loose; // Unused dummy to satisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to satisfy the IIeee80211Mgmt interface } - diff --git a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned index 03e9d0fd710..1fdb842fcc7 100644 --- a/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned +++ b/src/inet/linklayer/ieee80211/mgmt/Ieee80211MgmtStaSimplified.ned @@ -17,7 +17,7 @@ package inet.linklayer.ieee80211.mgmt; simple Ieee80211MgmtStaSimplified like IIeee80211Mgmt { parameters: - string accessPointAddress; // MAC address of associate AP + string accessPointAddress; // MAC address of associated AP string interfaceTableModule; string mibModule; string macModule; // The path to the MAC module @@ -25,7 +25,6 @@ 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 satisfy the IIeee80211Mgmt interface + output agentOut @loose; // Unused dummy to satisfy the IIeee80211Mgmt interface } - diff --git a/src/inet/linklayer/ieee802154/Ieee802154Mac.ned b/src/inet/linklayer/ieee802154/Ieee802154Mac.ned index 76f3a615d58..2cc5afe255e 100644 --- a/src/inet/linklayer/ieee802154/Ieee802154Mac.ned +++ b/src/inet/linklayer/ieee802154/Ieee802154Mac.ned @@ -31,58 +31,58 @@ import inet.linklayer.contract.IMacProtocol; module Ieee802154Mac extends MacProtocolBase like IMacProtocol { parameters: - string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or + string address @mutable = default("auto"); // MAC address as a hex string (12 hex digits), or // "auto". "auto" values will be replaced by // a generated MAC address in init stage 0. - // length of MAC header + // Length of MAC header int headerLength @unit(b) = default(72 b); int mtu @unit(B) = default(0B); - // bit rate + // Bit rate double bitrate @unit(bps) = default(250000 bps); // Clear Channel Assessment detection time double ccaDetectionTime @unit(s) = default(0.000128 s); // 8 symbols - // Time to setup radio to reception state + // Time to set up the radio to the reception state double rxSetupTime @unit(s) = default(0 s); - // Time to switch radio from Rx to Tx state + // Time to switch the radio from Rx to Tx state double aTurnaroundTime @unit(s) = default(0.000192 s); // 12 symbols // Send/Expect MAC acks for unicast traffic? bool useMACAcks; - // Maximum number of frame retransmission, - // only used when usage of MAC acks is enabled. + // Maximum number of frame retransmissions, + // only used when the usage of MAC acks is enabled. int macMaxFrameRetries = default(3); // Time to wait for an acknowledgement after transmitting a unicast frame. - // Only used when usage of MAC acks is enabled. - // Value is calculated from 1+12+10+12 symbols, which is defined for nonbeacon-enabled PAN. + // Only used when the usage of MAC acks is enabled. + // The value is calculated from 1+12+10+12 symbols, which is defined for nonbeacon-enabled PAN. // In the non-beacon-enabled case, the receiver responds at aTurnaroundTime // (i.e. the time for the sender and receiver to both be guaranteed to have - // switched from Tx to Rx and vice verse). This gives the value 192us + - // 352us = 544us (there's been some discussion about the "extra" 1 symbol == 16us) + // switched from Tx to Rx and vice versa). This gives the value 192us + + // 352us = 544us (there has been some discussion about the "extra" 1 symbol == 16us) // [section 7.5.6.4.2 of the specification]. double macAckWaitDuration @unit(s) = default(0.00056 s); // Complete MAC ack message length (in bits) // (! headerLength is not added to this), - // only used when usage of MAC acks is enabled. + // only used when the usage of MAC acks is enabled. int ackLength @unit(b) = default(40 b); // Simple interframe space (12 symbols). Time to wait between receiving a frame and acknowledging it. // Should be bigger than the maximum time for switching between Tx and Rx at the receiver. - // Only used when usage of MAC acks is enabled. + // Only used when the usage of MAC acks is enabled. double sifs @unit(s) = default(0.000192 s); - //Backoff method to use: constant, linear or exponential + // Backoff method to use: constant, linear, or exponential string backoffMethod = default("linear"); - // maximum number of extra backoffs (excluding the first unconditional one) before frame drop + // Maximum number of extra backoffs (excluding the first unconditional one) before frame drop int macMaxCSMABackoffs = default(5); - // base unit for all backoff calculations + // Base unit for all backoff calculations double aUnitBackoffPeriod @unit(s) = default(0.00032 s); - // # of backoff periods of the initial contention window + // Number of backoff periods of the initial contention window // (for linear and constant backoff method only) int contentionWindow = default(2); - // minimum backoff exponent (for exponential backoff method only) + // Minimum backoff exponent (for exponential backoff method only) int macMinBE = default(3); - // maximum backoff exponent (for exponential backoff method only) + // Maximum backoff exponent (for exponential backoff method only) int macMaxBE = default(8); string radioModule = default("^.radio"); // The path to the Radio module //FIXME remove default value diff --git a/src/inet/linklayer/ieee802154/Ieee802154NarrowbandMac.ned b/src/inet/linklayer/ieee802154/Ieee802154NarrowbandMac.ned index 18be73a2d4b..4db3fd420ba 100644 --- a/src/inet/linklayer/ieee802154/Ieee802154NarrowbandMac.ned +++ b/src/inet/linklayer/ieee802154/Ieee802154NarrowbandMac.ned @@ -13,7 +13,7 @@ module Ieee802154NarrowbandMac extends Ieee802154Mac useMACAcks = true; // Time needed to switch from sleep to rx. - // TODO This is probabily wrong, since it is used to compute + // TODO This is probably wrong, since it is used to compute // the time for the CCA (and that might follow an RX state) rxSetupTime = 0s; diff --git a/src/inet/linklayer/ieee8021as/Gptp.ned b/src/inet/linklayer/ieee8021as/Gptp.ned index a55e862ed00..617046e1273 100644 --- a/src/inet/linklayer/ieee8021as/Gptp.ned +++ b/src/inet/linklayer/ieee8021as/Gptp.ned @@ -32,9 +32,9 @@ simple Gptp like IGptp 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 + // These numbers must be large enough to prevent creating a queue in the MAC layer. + // It means they should be larger than the transmission time of the message sent before + double pDelayReqProcessingTime @unit(s) = default(8us); // Processing time between the arrival of PDelayReq and the sending of PDelayResp double followUpInterval @unit(s) = default(7us); @display("i=block/timer"); diff --git a/src/inet/linklayer/ieee8021d/rstp/Rstp.ned b/src/inet/linklayer/ieee8021d/rstp/Rstp.ned index 91e9589f7d7..1ca5025e3ee 100644 --- a/src/inet/linklayer/ieee8021d/rstp/Rstp.ned +++ b/src/inet/linklayer/ieee8021d/rstp/Rstp.ned @@ -64,7 +64,7 @@ simple Rstp like ISpanningTree // Label ethernet interface with port role and status. Mark root switch bool visualize = default(false); - // If true, edge ports immediately become designated/forwarding, else it will have to wait to get designated. + // If true, edge ports immediately become designated/forwarding, else they will have to wait to get designated. bool autoEdge = default(true); @display("i=block/network2"); diff --git a/src/inet/linklayer/ieee8021q/Ieee8021qFilter.ned b/src/inet/linklayer/ieee8021q/Ieee8021qFilter.ned index f99c2302056..56b3d03da99 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; // The number of different streams to filter for + int numGates; // The number of gates + int numMeters; // The 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/PcpClassifier.ned b/src/inet/linklayer/ieee8021q/PcpClassifier.ned index 7c53934593a..b8e1a5c9a9b 100644 --- a/src/inet/linklayer/ieee8021q/PcpClassifier.ned +++ b/src/inet/linklayer/ieee8021q/PcpClassifier.ned @@ -20,6 +20,6 @@ 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 + int defaultGateIndex = default(0); // Default gate index if no PCP is found @class(PcpClassifier); } diff --git a/src/inet/linklayer/ieee8022/Ieee8022Llc.ned b/src/inet/linklayer/ieee8022/Ieee8022Llc.ned index 31b2daa9066..e7a1e5fb286 100644 --- a/src/inet/linklayer/ieee8022/Ieee8022Llc.ned +++ b/src/inet/linklayer/ieee8022/Ieee8022Llc.ned @@ -12,12 +12,12 @@ import inet.linklayer.contract.IIeee8022Llc; simple Ieee8022Llc like IIeee8022Llc { parameters: - bool registerProtocol = default(false); //FIXME //KLUDGE should redesign place of EthernetEncapsulation and LLC modules + bool registerProtocol = default(false); //FIXME //KLUDGE should redesign the placement of EthernetEncapsulation and LLC modules @display("i=block/layer"); @signal[packetDropped](type=inet::Packet); gates: - input upperLayerIn; // TODO accepts packets and socket commands with @messageKinds(inet::SocketCommandCode), too - output upperLayerOut; // TODO sends packets and socket indications with @messageKinds(inet::SocketStatusInd), too + input upperLayerIn; // TODO accepts packets and socket commands with @messageKinds(inet::SocketCommandCode) as well + output upperLayerOut; // TODO sends packets and socket indications with @messageKinds(inet::SocketStatusInd) as well input lowerLayerIn; output lowerLayerOut; } diff --git a/src/inet/linklayer/shortcut/ShortcutMac.ned b/src/inet/linklayer/shortcut/ShortcutMac.ned index daf02859328..3f408f31bff 100644 --- a/src/inet/linklayer/shortcut/ShortcutMac.ned +++ b/src/inet/linklayer/shortcut/ShortcutMac.ned @@ -22,7 +22,7 @@ import inet.linklayer.contract.IMacProtocol; simple ShortcutMac extends MacProtocolBase like ILinkLayer, IMacProtocol { parameters: - string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or + string address @mutable = default("auto"); // MAC address as a hex string (12 hex digits), or // "auto". "auto" values will be replaced by // a generated MAC address in init stage 0. double bitrate @unit(bps); diff --git a/src/inet/linklayer/xmac/XMac.ned b/src/inet/linklayer/xmac/XMac.ned index 1346429792a..1fb414e5b61 100644 --- a/src/inet/linklayer/xmac/XMac.ned +++ b/src/inet/linklayer/xmac/XMac.ned @@ -18,13 +18,13 @@ import inet.linklayer.contract.IMacProtocol; module XMac extends MacProtocolBase like IMacProtocol { parameters: - string address @mutable = default("auto"); // MAC address as hex string (12 hex digits), or + string address @mutable = default("auto"); // MAC address as a hex string (12 hex digits), or // "auto". "auto" values will be replaced by // a generated MAC address in init stage 0. // debug switch bool debug = default(false); - //collect statistics? + // collect statistics? bool stats = default(true); // BMAC specific parameters @@ -41,14 +41,14 @@ module XMac extends MacProtocolBase like IMacProtocol // bit rate double bitrate @unit(bps) = default(19200 bps); - //tx power + // tx power double txPower @unit(W) = default(50 mW); - //should mac send and expect acknowledgments? + // should mac send and expect acknowledgments? bool useMACAcks = default(false); // maximum number of frame retransmission - // only used when usage of MAC acks is enabled + // only used when the usage of MAC acks is enabled int macMaxFrameRetries = default(3); // length of MAC headers @@ -61,7 +61,7 @@ module XMac extends MacProtocolBase like IMacProtocol // Maximum transmission attempts per data packet, when ACKs are used int maxTxAttempts = default(2); - string radioModule = default("^.radio"); // The path to the Radio module //FIXME remove default value + string radioModule = default("^.radio"); // The path to the Radio module // FIXME remove the default value @class(XMac); @signal[packetDropped](type=inet::Packet); diff --git a/src/inet/mobility/base/MobilityBase.ned b/src/inet/mobility/base/MobilityBase.ned index 330bf0da846..017a78b70db 100644 --- a/src/inet/mobility/base/MobilityBase.ned +++ b/src/inet/mobility/base/MobilityBase.ned @@ -25,17 +25,16 @@ 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 works in inet, but not in the extended module in another 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("^"); // The module path that determines the subject module, the motion of which this mobility model describes. The default value is the parent module + string coordinateSystemModule = default(""); // The module path of the geographic coordinate system module + string displayStringTextFormat @mutable = default("p: %p\nv: %v"); // The format string for the mobility module's display string text + bool updateDisplayString = default(true); // Enables continuous update of the subject module's position by modifying its display string + double constraintAreaMinX @unit(m) = default(-inf m); // The minimum x position of the constraint area. It is unconstrained by default (negative infinity) + double constraintAreaMinY @unit(m) = default(-inf m); // The minimum y position of the constraint area. It is unconstrained by default (negative infinity) + double constraintAreaMinZ @unit(m) = default(-inf m); // The minimum z position of the constraint area. It is unconstrained by default (negative infinity) + double constraintAreaMaxX @unit(m) = default(inf m); // The maximum x position of the constraint area. It is unconstrained by default (positive infinity) + double constraintAreaMaxY @unit(m) = default(inf m); // The maximum y position of the constraint area. It is unconstrained by default (positive infinity) + double constraintAreaMaxZ @unit(m) = default(inf m); // The maximum z position of the constraint area. It is unconstrained by default (positive infinity) } - diff --git a/src/inet/mobility/base/MovingMobilityBase.ned b/src/inet/mobility/base/MovingMobilityBase.ned index ab2b8fd9374..482564aa7d8 100644 --- a/src/inet/mobility/base/MovingMobilityBase.ned +++ b/src/inet/mobility/base/MovingMobilityBase.ned @@ -16,4 +16,3 @@ simple MovingMobilityBase extends MobilityBase 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/group/MoBanCoordinator.ned b/src/inet/mobility/group/MoBanCoordinator.ned index b764e2e727c..7efb5a8614a 100644 --- a/src/inet/mobility/group/MoBanCoordinator.ned +++ b/src/inet/mobility/group/MoBanCoordinator.ned @@ -54,9 +54,8 @@ simple MoBanCoordinator extends MovingMobilityBase { parameters: xml postureSpecFile; // The input file that includes the specification of all postures - xml configFile; // The configuration file for setting probability vectors, distributions and correlations + xml configFile; // The configuration file for setting probability vectors, distributions, and correlations bool useMobilityPattern; // Set if the logged mobility pattern is used. - string mobilityPatternFile; // The input file for mobility pattern if it is going to be used. + string mobilityPatternFile; // The input file for the mobility pattern if it is going to be used. @class(MoBanCoordinator); } - diff --git a/src/inet/mobility/single/AnsimMobility.ned b/src/inet/mobility/single/AnsimMobility.ned index e2feb420d87..a0885fef3ef 100644 --- a/src/inet/mobility/single/AnsimMobility.ned +++ b/src/inet/mobility/single/AnsimMobility.ned @@ -17,7 +17,7 @@ simple AnsimMobility extends MovingMobilityBase { parameters: xml ansimTrace; // The ANSim trace file in XML - int nodeId; // elements to match; -1 gets substituted to parent module's index + int nodeId; // elements to match; -1 gets substituted with the parent module's index @class(AnsimMobility); } diff --git a/src/inet/mobility/single/BonnMotionMobility.ned b/src/inet/mobility/single/BonnMotionMobility.ned index 6a5de3e5a27..e92d701f770 100644 --- a/src/inet/mobility/single/BonnMotionMobility.ned +++ b/src/inet/mobility/single/BonnMotionMobility.ned @@ -1,3 +1,4 @@ + // // Copyright (C) 2005 OpenSim Ltd. // @@ -30,7 +31,6 @@ 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 + int nodeId; // Selects line in the trace file; -1 gets substituted with the parent module's index @class(BonnMotionMobility); } - diff --git a/src/inet/mobility/single/CircleMobility.ned b/src/inet/mobility/single/CircleMobility.ned index 7e9fa79e609..f86d8434ccc 100644 --- a/src/inet/mobility/single/CircleMobility.ned +++ b/src/inet/mobility/single/CircleMobility.ned @@ -15,9 +15,9 @@ 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 cx @unit(m); // X coordinate of the center of the circle + double cy @unit(m); // Y coordinate of the center of the circle + double cz @unit(m) = default(0m); // Z coordinate 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 diff --git a/src/inet/mobility/single/FacingMobility.ned b/src/inet/mobility/single/FacingMobility.ned index 9abb1cbd1e5..c735345aedd 100644 --- a/src/inet/mobility/single/FacingMobility.ned +++ b/src/inet/mobility/single/FacingMobility.ned @@ -19,7 +19,7 @@ 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 + 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 4ae74230fa3..6b5a899c195 100644 --- a/src/inet/mobility/single/GaussMarkovMobility.ned +++ b/src/inet/mobility/single/GaussMarkovMobility.ned @@ -26,7 +26,7 @@ simple GaussMarkovMobility extends MovingMobilityBase { parameters: @class(GaussMarkovMobility); - double alpha = default(0.5); // [0;1], 0 - brown motion, 1 - linear motion + double alpha = default(0.5); // [0;1], 0 - brownian motion, 1 - linear motion double speed @unit(mps); double speedStdDev @unit(mps); // Speed standard deviation double angle @unit(deg) = default(uniform(0deg, 360deg)); diff --git a/src/inet/mobility/single/LinearMobility.ned b/src/inet/mobility/single/LinearMobility.ned index 2d0d02778d2..df050d32b54 100644 --- a/src/inet/mobility/single/LinearMobility.ned +++ b/src/inet/mobility/single/LinearMobility.ned @@ -24,7 +24,7 @@ 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 + 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); diff --git a/src/inet/mobility/single/MassMobility.ned b/src/inet/mobility/single/MassMobility.ned index 0ff095541e7..9ee48c16e74 100644 --- a/src/inet/mobility/single/MassMobility.ned +++ b/src/inet/mobility/single/MassMobility.ned @@ -50,7 +50,7 @@ simple MassMobility extends MovingMobilityBase 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 + 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) diff --git a/src/inet/mobility/single/RandomWaypointMobility.ned b/src/inet/mobility/single/RandomWaypointMobility.ned index 19aaad36af0..a1f1b0ee482 100644 --- a/src/inet/mobility/single/RandomWaypointMobility.ned +++ b/src/inet/mobility/single/RandomWaypointMobility.ned @@ -34,7 +34,7 @@ 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 + 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 3292acb7a92..d1e53a45410 100644 --- a/src/inet/mobility/single/RectangleMobility.ned +++ b/src/inet/mobility/single/RectangleMobility.ned @@ -15,7 +15,7 @@ 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 startPos; // In range [0.0, 4.0): top left=0, top right=1, bottom right=2, bottom left=3 double speed @unit(mps); // Speed of the host @class(RectangleMobility); } diff --git a/src/inet/mobility/single/VehicleMobility.ned b/src/inet/mobility/single/VehicleMobility.ned index 1b4b21a51eb..2f81f503176 100644 --- a/src/inet/mobility/single/VehicleMobility.ned +++ b/src/inet/mobility/single/VehicleMobility.ned @@ -27,6 +27,5 @@ simple VehicleMobility 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))); - 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 9e9195fbf7c..626e74c5877 100644 --- a/src/inet/mobility/static/StationaryMobility.ned +++ b/src/inet/mobility/static/StationaryMobility.ned @@ -24,8 +24,7 @@ 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 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 789f20cc474..4dd3d60cd9e 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 + double retryTimeout @unit(s) = default(1s); // Number of 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 cacheTimeout @unit(s) = default(120s); // Number of seconds unused entries in the cache will time out + string proxyArpInterfaces = default("*"); // List of interfaces that proxy ARP is enabled on (all interfaces by default) @display("i=block/layer"); @signal[arpRequestSent](type=inet::Packet); @signal[arpReplySent](type=inet::Packet); diff --git a/src/inet/networklayer/configurator/ipv4/HostAutoConfigurator.ned b/src/inet/networklayer/configurator/ipv4/HostAutoConfigurator.ned index 7a32098e65d..6ea80c6bb2c 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 character + string addressBase = default("10.0.0.0"); // Start of the address range from which to automatically assign an address to the autoassignInterfaces + string netmask = default("255.0.0.0"); // Subnet netmask 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 character @display("i=block/cogwheel"); } diff --git a/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned b/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned index 6fc0fa6fd6c..6c531ae9dfc 100644 --- a/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned +++ b/src/inet/networklayer/configurator/ipv4/Ipv4NodeConfigurator.ned @@ -32,7 +32,7 @@ simple Ipv4NodeConfigurator like IIpv4NodeConfigurator 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) + bool configureRoutingTable = default(true); // Add routing entries to the 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 cadc845d2a0..068e175e829 100644 --- a/src/inet/networklayer/configurator/nexthop/NextHopNetworkConfigurator.ned +++ b/src/inet/networklayer/configurator/nexthop/NextHopNetworkConfigurator.ned @@ -20,7 +20,6 @@ simple NextHopNetworkConfigurator extends L3NetworkConfiguratorBase @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 dumpTopology = default(false); // Print the extracted network topology to the module output + bool dumpRoutes = default(false); // Print the 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 b1997422c05..7d5da7f4bc8 100644 --- a/src/inet/networklayer/diffserv/AFxyQueue.ned +++ b/src/inet/networklayer/diffserv/AFxyQueue.ned @@ -31,7 +31,7 @@ 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 diff --git a/src/inet/networklayer/diffserv/BehaviorAggregateClassifier.ned b/src/inet/networklayer/diffserv/BehaviorAggregateClassifier.ned index 078f3a39902..df926ed01c6 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 a4265a47881..03d4ce1fa14 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 bandwidth as a percentage of the 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 0d40fa2386a..ae5aa4a705d 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; // A space-separated list of 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 ca47caec8ff..7ffd286f19a 100644 --- a/src/inet/networklayer/diffserv/SingleRateThreeColorMeter.ned +++ b/src/inet/networklayer/diffserv/SingleRateThreeColorMeter.ned @@ -32,7 +32,7 @@ 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%") + 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 diff --git a/src/inet/networklayer/diffserv/TokenBucketMeter.ned b/src/inet/networklayer/diffserv/TokenBucketMeter.ned index 7dd293b55f2..450fc53d296 100644 --- a/src/inet/networklayer/diffserv/TokenBucketMeter.ned +++ b/src/inet/networklayer/diffserv/TokenBucketMeter.ned @@ -29,7 +29,7 @@ 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%") + 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: diff --git a/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned b/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned index 34e49a2df85..71c814c2c5c 100644 --- a/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned +++ b/src/inet/networklayer/diffserv/TwoRateThreeColorMeter.ned @@ -33,9 +33,9 @@ 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%") + 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 + string cir; // Committed information rate, either absolute or relative bitrate; must be smaller than the PIR int cbs @unit(B); // Committed burst size bool colorAwareMode = default(false); // Enables color-aware mode gates: diff --git a/src/inet/networklayer/flooding/Flooding.ned b/src/inet/networklayer/flooding/Flooding.ned index 757757b71cd..02ebcc9e401 100644 --- a/src/inet/networklayer/flooding/Flooding.ned +++ b/src/inet/networklayer/flooding/Flooding.ned @@ -49,7 +49,6 @@ simple Flooding extends NetworkProtocolBase like INetworkProtocol int bcMaxEntries = default(100); // Time after which an entry for an already broadcasted msg can be deleted double bcDelTime @unit(s) = default(100 s); - int defaultTtl = default(10); // Default time-to-live (ttl) used for this module expressed in number of hops. + int defaultTtl = default(10); // Default time-to-live (ttl) used for this module expressed in number of hops. @class(Flooding); } - diff --git a/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned b/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned index ff779c9d21e..d0a6efaad8d 100644 --- a/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned +++ b/src/inet/networklayer/icmpv6/Ipv6NeighbourDiscovery.ned @@ -23,8 +23,8 @@ simple Ipv6NeighbourDiscovery string icmpv6Module; string xmipv6Module; string routingTableModule; - 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) + double minIntervalBetweenRAs @unit(s) = default(30ms); // MinRtrAdvInterval: 0.03 sec for MIPv6 + double maxIntervalBetweenRAs @unit(s) = default(70ms); // MaxrtrAdvInterval: 0.07 sec for MIPv6 @display("i=block/network"); @signal[startDad](type=long); // Emits value=1 @statistic[startDad](title="DAD started";record=count,vector); diff --git a/src/inet/networklayer/ipv4/Icmp.ned b/src/inet/networklayer/ipv4/Icmp.ned index ef2a027acea..9551998ffef 100644 --- a/src/inet/networklayer/ipv4/Icmp.ned +++ b/src/inet/networklayer/ipv4/Icmp.ned @@ -22,7 +22,6 @@ 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); // Deliver ICMP packets + output ipOut @labels(Ipv4ControlInfo/down); // Towards the network } - diff --git a/src/inet/networklayer/ipv4/Igmpv2.ned b/src/inet/networklayer/ipv4/Igmpv2.ned index 082c3d38ae6..68cdba2bea7 100644 --- a/src/inet/networklayer/ipv4/Igmpv2.ned +++ b/src/inet/networklayer/ipv4/Igmpv2.ned @@ -96,7 +96,7 @@ simple Igmpv2 like IIgmp string routingTableModule; string crcMode @enum("declared","computed") = default("declared"); bool enabled = default(true); - int robustnessVariable = default(2); // IGMP is roboust to (roboustnessVariable-1) packet loss + int robustnessVariable = default(2); // IGMP is robust to (robustnessVariable-1) packet loss double queryInterval @unit(s) = default(125s); double queryResponseInterval @unit(s) = default(10s); double groupMembershipInterval @unit(s) = default((robustnessVariable * queryInterval) + queryResponseInterval); diff --git a/src/inet/networklayer/ipv4/Igmpv3.ned b/src/inet/networklayer/ipv4/Igmpv3.ned index 7698dbfc08c..c8da2c8487b 100644 --- a/src/inet/networklayer/ipv4/Igmpv3.ned +++ b/src/inet/networklayer/ipv4/Igmpv3.ned @@ -14,7 +14,7 @@ simple Igmpv3 like IIgmp string interfaceTableModule; string routingTableModule; string crcMode @enum("declared","computed") = default("declared"); - int robustnessVariable = default(2); // IGMP is roboust to (roboustnessVariable-1) packet loss + int robustnessVariable = default(2); // IGMP is robust to (robustnessVariable-1) packet loss double queryInterval @unit(s) = default(125s); double queryResponseInterval @unit(s) = default(10s); double groupMembershipInterval @unit(s) = default((robustnessVariable * queryInterval) + queryResponseInterval); diff --git a/src/inet/networklayer/ipv4/Ipv4.ned b/src/inet/networklayer/ipv4/Ipv4.ned index 2d3aac6d856..52553ac0c6d 100644 --- a/src/inet/networklayer/ipv4/Ipv4.ned +++ b/src/inet/networklayer/ipv4/Ipv4.ned @@ -89,10 +89,10 @@ 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 limitedBroadcast = default(false); // Send out limited broadcast packets coming from the higher layer + string directBroadcastInterfaces = default(""); // List of interfaces where 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 + 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); diff --git a/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned b/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned index 17e1f020a27..5354c47fec7 100644 --- a/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned +++ b/src/inet/networklayer/ipv4/Ipv4RoutingTable.ned @@ -46,7 +46,7 @@ simple Ipv4RoutingTable like IRoutingTable 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 + bool useAdminDist = default(false); // Use Cisco-like administrative distances string routingFile = default(""); // Routing table file name @display("i=block/table"); @signal[routeAdded](type=inet::Ipv4Route); diff --git a/src/inet/networklayer/ipv4/ipsec/IPsec.ned b/src/inet/networklayer/ipv4/ipsec/IPsec.ned index b21c0023316..a2226ee0c73 100644 --- a/src/inet/networklayer/ipv4/ipsec/IPsec.ned +++ b/src/inet/networklayer/ipv4/ipsec/IPsec.ned @@ -182,15 +182,15 @@ simple IPsec string networkProtocolModule = default("^.ip"); string interfaceTableModule; - string spdModule = default("^.spd"); - string sadModule = default("^.sad"); - xml spdConfig; + 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); diff --git a/src/inet/networklayer/ipv6/Ipv6.ned b/src/inet/networklayer/ipv6/Ipv6.ned index cc4445a6e9c..705200cfd95 100644 --- a/src/inet/networklayer/ipv6/Ipv6.ned +++ b/src/inet/networklayer/ipv6/Ipv6.ned @@ -75,7 +75,6 @@ simple Ipv6 output upperTunnelingOut; input lowerTunnelingIn; output lowerTunnelingOut; - //the following gates are added by Zarrar Yousaf on 19.06.07 input xMIPv6In; output xMIPv6Out; } diff --git a/src/inet/networklayer/ipv6/Ipv6RoutingTable.ned b/src/inet/networklayer/ipv6/Ipv6RoutingTable.ned index f70658ec984..c07a0657ed7 100644 --- a/src/inet/networklayer/ipv6/Ipv6RoutingTable.ned +++ b/src/inet/networklayer/ipv6/Ipv6RoutingTable.ned @@ -27,7 +27,7 @@ simple Ipv6RoutingTable like IRoutingTable bool forwarding = default(false); bool isRouter = default(this.forwarding); bool multicastForwarding = default(false); - bool useAdminDist = default(false); // Use Cisco like administrative distances + bool useAdminDist = default(false); // Use Cisco-like administrative distances @signal[routeAdded](type=inet::Ipv6Route); @signal[routeChanged](type=inet::Ipv6Route); @signal[routeDeleted](type=inet::Ipv6Route); diff --git a/src/inet/networklayer/ipv6tunneling/Ipv6Tunneling.ned b/src/inet/networklayer/ipv6tunneling/Ipv6Tunneling.ned index 1d6a0713ecb..d9f7feb6239 100644 --- a/src/inet/networklayer/ipv6tunneling/Ipv6Tunneling.ned +++ b/src/inet/networklayer/ipv6tunneling/Ipv6Tunneling.ned @@ -20,8 +20,8 @@ simple Ipv6Tunneling like IIpv6Tunneling { parameters: string interfaceTableModule; // The path to the InterfaceTable module - string routingTableModule; - string xmipv6Module; + string routingTableModule; // The path to the RoutingTable module + string xmipv6Module; // The path to the XMipv6 module @display("i=block/tunnel"); gates: input upperLayerIn; diff --git a/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned b/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned index b96d2f07821..b8ad0dab6f8 100644 --- a/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned +++ b/src/inet/networklayer/probabilistic/ProbabilisticBroadcast.ned @@ -44,16 +44,15 @@ simple ProbabilisticBroadcast extends NetworkProtocolBase like INetworkProtocol double beta = default(0.8); // maximal number of broadcast attempts for each packet. int maxNbBcast = default(1); - // maximal back-off before first broadcast attempt [seconds]. - // if don't want to use this parameter, simply set it + // maximal back-off before the first broadcast attempt [seconds]. + // If you don't want to use this parameter, simply set it // to a value that is greater than bcperiod. double maxFirstBcastBackoff @unit(s) = default(1 s); double timeToLive @unit(s) = default(10 s); - // How many seconds the message should be kept in queue after its died. + // How many seconds the message should be kept in the queue after it dies. // That way the message is known if the node receives one of its - // copy that isn't dead because of TTL de-synchronization due to - // MAC backoff, propagation delay and clock drift. + // copies that isn't dead because of TTL de-synchronization due to + // MAC backoff, propagation delay, and clock drift. double timeInQueueAfterDeath @unit(s) = default(60 s); } - diff --git a/src/inet/networklayer/rsvpte/RsvpTe.ned b/src/inet/networklayer/rsvpte/RsvpTe.ned index 80a6f88b6d5..6afdfde1159 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; diff --git a/src/inet/networklayer/ted/Ted.ned b/src/inet/networklayer/ted/Ted.ned index 399067e13b1..11337dfd9e5 100644 --- a/src/inet/networklayer/ted/Ted.ned +++ b/src/inet/networklayer/ted/Ted.ned @@ -21,7 +21,6 @@ simple Ted { parameters: string interfaceTableModule; // The path to the InterfaceTable module - string routingTableModule; + string routingTableModule; // The path to the RoutingTable module @display("i=block/table"); } - diff --git a/src/inet/networklayer/wiseroute/WiseRoute.ned b/src/inet/networklayer/wiseroute/WiseRoute.ned index 880a4b0a32c..ac525167b29 100644 --- a/src/inet/networklayer/wiseroute/WiseRoute.ned +++ b/src/inet/networklayer/wiseroute/WiseRoute.ned @@ -59,8 +59,8 @@ simple WiseRoute extends NetworkProtocolBase like INetworkProtocol // RSSI threshold for route selection double rssiThreshold @unit(dBm) = default(-50 dBm); - // If set to zero, this node does not initiates route tree building. - // If set to a value larger than zero, this nodes periodically initiates route tree building. + // If set to zero, this node does not initiate route tree building. + // If set to a value larger than zero, this node periodically initiates route tree building. double routeFloodsInterval @unit(s) = default(0 s); string arpModule; // The path to the ARP module diff --git a/src/inet/networks/ethernet/DumbbellNetwork.ned b/src/inet/networks/ethernet/DumbbellNetwork.ned index 442d572f3e9..9f8bca1e7c9 100644 --- a/src/inet/networks/ethernet/DumbbellNetwork.ned +++ b/src/inet/networks/ethernet/DumbbellNetwork.ned @@ -39,4 +39,3 @@ network DumbbellNetwork extends WiredNetworkBase switch2.ethg++ <--> EthernetLink <--> server2.ethg++; switch1.ethg++ <--> EthernetLink <--> switch2.ethg++; } - diff --git a/src/inet/node/base/LinkLayerNodeBase.ned b/src/inet/node/base/LinkLayerNodeBase.ned index 3d452d0f4c4..579c05c8d9a 100644 --- a/src/inet/node/base/LinkLayerNodeBase.ned +++ b/src/inet/node/base/LinkLayerNodeBase.ned @@ -30,7 +30,7 @@ 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 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); @@ -83,7 +83,7 @@ module LinkLayerNodeBase extends NodeBase like IEthernetNetworkNode lo[numLoInterfaces]: like ILoopbackInterface { @display("p=750,975,row,150"); } - // TODO move wlan interfaces after eth interfaces, but it changes IP address assignment and breaks examples/inet/configurator/complex.ini + // TODO move WLAN interfaces after Ethernet interfaces, but it changes IP address assignment and breaks examples/inet/configurator/complex.ini wlan[numWlanInterfaces]: like IWirelessInterface { @display("p=375,1000,row,150;q=queue"); } diff --git a/src/inet/node/base/NodeBase.ned b/src/inet/node/base/NodeBase.ned index 005160df1f5..707d0fd0e22 100644 --- a/src/inet/node/base/NodeBase.ned +++ b/src/inet/node/base/NodeBase.ned @@ -57,7 +57,7 @@ module NodeBase like INetworkNode energyGenerator: like IEnergyGenerator if typename != "" { @display("p=125,560;is=s"); } - // TODO move mobility right after status to have it in the same order as in their positions, changes fingerprints + // TODO move mobility right after the status to have it in the same order as their positions, change fingerprints mobility: like IMobility if typename != "" { @display("p=125,160;is=s"); } diff --git a/src/inet/node/ethernet/EthernetHost.ned b/src/inet/node/ethernet/EthernetHost.ned index b0903617ad4..5af1676880f 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/inet/ManetRouter.ned b/src/inet/node/inet/ManetRouter.ned index a5ceee5813d..1eb6a3abdeb 100644 --- a/src/inet/node/inet/ManetRouter.ned +++ b/src/inet/node/inet/ManetRouter.ned @@ -7,7 +7,7 @@ import inet.routing.contract.IManetRouting; module ManetRouter extends AdhocHost { submodules: - routingApp: like IApp if typename != "" { // Aodv or other manet routing over UDP/TCP protocol + routingApp: like IApp if typename != "" { // AODV or other MANET routing over UDP/TCP protocol @display("p=913,75"); } routing: like IManetRouting if typename != "" { diff --git a/src/inet/node/tsn/TsnClock.ned b/src/inet/node/tsn/TsnClock.ned index fc6234618fe..d35e3411e5a 100644 --- a/src/inet/node/tsn/TsnClock.ned +++ b/src/inet/node/tsn/TsnClock.ned @@ -19,8 +19,8 @@ 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 + ethernet.typename = default("EthernetLayer"); // Use the Ethernet protocol layer outside 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 + @display("i=device/card"); // Change icon to emphasize hardware device } diff --git a/src/inet/node/tsn/TsnDevice.ned b/src/inet/node/tsn/TsnDevice.ned index 5d1500a31c5..69ad20cc88f 100644 --- a/src/inet/node/tsn/TsnDevice.ned +++ b/src/inet/node/tsn/TsnDevice.ned @@ -23,7 +23,7 @@ module TsnDevice extends StandardHost 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 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 @@ -39,15 +39,15 @@ module TsnDevice extends StandardHost 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.streamIdentifier.identifier.hasSequenceNumbering = default(hasStreamRedundancy); // Enable sequence numbering 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 + bridging.streamCoder.typename = default(hasIncomingStreams || hasOutgoingStreams || hasStreamRedundancy ? "StreamCoderLayer" : ""); // Enable stream encoding/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 emphasize 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 d228ad2d9cc..b66dd05be4c 100644 --- a/src/inet/node/tsn/TsnSwitch.ned +++ b/src/inet/node/tsn/TsnSwitch.ned @@ -27,7 +27,7 @@ module TsnSwitch extends EthernetSwitch 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 + bool 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 @@ -42,7 +42,7 @@ module TsnSwitch extends EthernetSwitch 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.streamCoder.typename = default(hasIncomingStreams || hasOutgoingStreams || hasIngressTrafficFiltering || hasStreamRedundancy ? "StreamCoderLayer" : ""); // Enable stream encoding/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/xmipv6/CorrespondentNode6.ned b/src/inet/node/xmipv6/CorrespondentNode6.ned index 9390b7552cf..047d59e05e4 100644 --- a/src/inet/node/xmipv6/CorrespondentNode6.ned +++ b/src/inet/node/xmipv6/CorrespondentNode6.ned @@ -17,7 +17,6 @@ import inet.node.ipv6.StandardHost6; module CorrespondentNode6 extends StandardHost6 { ipv6.xMIPv6Support = true; - ipv6.mipv6support.isMobileNode = false; //is Mobile Node - ipv6.mipv6support.isHomeAgent = false; //is Home Agent + ipv6.mipv6support.isMobileNode = false; // Is a Mobile Node + ipv6.mipv6support.isHomeAgent = false; // Is a Home Agent } - diff --git a/src/inet/node/xmipv6/HomeAgent6.ned b/src/inet/node/xmipv6/HomeAgent6.ned index a255bae9c7a..dfd5ac331aa 100644 --- a/src/inet/node/xmipv6/HomeAgent6.ned +++ b/src/inet/node/xmipv6/HomeAgent6.ned @@ -17,7 +17,6 @@ import inet.node.ipv6.Router6; module HomeAgent6 extends Router6 { ipv6.xMIPv6Support = true; - ipv6.mipv6support.isMobileNode = false; //is Mobile Node - ipv6.mipv6support.isHomeAgent = true; //is Home Agent + ipv6.mipv6support.isMobileNode = false; // Is Mobile Node + ipv6.mipv6support.isHomeAgent = true; // Is Home Agent } - diff --git a/src/inet/node/xmipv6/MobileHost6.ned b/src/inet/node/xmipv6/MobileHost6.ned index 8088d487ae1..080e994589f 100644 --- a/src/inet/node/xmipv6/MobileHost6.ned +++ b/src/inet/node/xmipv6/MobileHost6.ned @@ -17,7 +17,6 @@ import inet.node.ipv6.StandardHost6; module MobileHost6 extends StandardHost6 { ipv6.xMIPv6Support = true; - ipv6.mipv6support.isMobileNode = true; //is Mobile Node - ipv6.mipv6support.isHomeAgent = false; //is Home Agent + ipv6.mipv6support.isMobileNode = true; // Is a Mobile Node + ipv6.mipv6support.isHomeAgent = false; // Is a Home Agent } - diff --git a/src/inet/node/xmipv6/WirelessHost6.ned b/src/inet/node/xmipv6/WirelessHost6.ned index bd46699fdb3..f7b998507d2 100644 --- a/src/inet/node/xmipv6/WirelessHost6.ned +++ b/src/inet/node/xmipv6/WirelessHost6.ned @@ -21,8 +21,7 @@ module WirelessHost6 extends StandardHost6 { numWlanInterfaces = 1; ipv6.xMIPv6Support = true; - ipv6.mipv6support.isMobileNode = true; //is Mobile Node - ipv6.mipv6support.isHomeAgent = false; //is Home Agent + ipv6.mipv6support.isMobileNode = true; // Is a Mobile Node + ipv6.mipv6support.isHomeAgent = false; // Is a Home Agent @display("i=device/wifilaptop"); } - diff --git a/src/inet/physicallayer/wired/ethernet/EthernetPhyLayer.ned b/src/inet/physicallayer/wired/ethernet/EthernetPhyLayer.ned index 483f704f966..2fd13178109 100644 --- a/src/inet/physicallayer/wired/ethernet/EthernetPhyLayer.ned +++ b/src/inet/physicallayer/wired/ethernet/EthernetPhyLayer.ned @@ -34,7 +34,7 @@ module EthernetPhyLayer like IEthernetPhyLayer @display("p=200,100"); } interFrameGapInserter: InterpacketGapInserter { - duration = default(96s / dropUnit(parent.bitrate)); // 96 bit / bps + duration = default(96s / dropUnit(parent.bitrate)); // 96 bits / bps @display("p=200,200"); } outboundEmitter: like IPacketFlow { diff --git a/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned b/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned index 6a6dc60e0e0..2cdb975dffc 100644 --- a/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned +++ b/src/inet/physicallayer/wireless/apsk/bitlevel/ApskLayeredTransmitter.ned @@ -43,7 +43,7 @@ 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 power @unit(W); // Scalar transmission power for the entire signal duration double centerFrequency @unit(Hz); // Center frequency of the narrowband carrier signal double bandwidth @unit(Hz); // Bandwidth double preambleDuration @unit(s) = default(0s); diff --git a/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalMediumAnalogModel.ned b/src/inet/physicallayer/wireless/common/analogmodel/dimensional/DimensionalMediumAnalogModel.ned index d4a2eddd1ad..c989f835e5a 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 frequency 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 6a0c6e67acd..d95c5f3cf9d 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 the sensitivity (idle or busy states). @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 f9e28c88f45..c80dd5a64e6 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 that only partially overlaps 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/antenna/AxiallySymmetricAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/AxiallySymmetricAntenna.ned index 6f9cc758557..2154ab3fd89 100644 --- a/src/inet/physicallayer/wireless/common/antenna/AxiallySymmetricAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/AxiallySymmetricAntenna.ned @@ -17,7 +17,7 @@ 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 gains = default("0 0"); // Sequence of angles [degrees] 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 cfd204c3c3e..6b47c6c3297 100644 --- a/src/inet/physicallayer/wireless/common/antenna/ConstantGainAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/ConstantGainAntenna.ned @@ -16,7 +16,6 @@ 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 independent of transmission or reception direction @class(ConstantGainAntenna); } - diff --git a/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned b/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned index f1b6b263993..b50d3e8f190 100644 --- a/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned +++ b/src/inet/physicallayer/wireless/common/antenna/DipoleAntenna.ned @@ -19,7 +19,6 @@ 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 - // the default value is Z axis, so that antenna mobility models are not required when antennas are approximately positioned in the same plane + // The default value is the 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/backgroundnoise/DimensionalBackgroundNoise.ned b/src/inet/physicallayer/wireless/common/backgroundnoise/DimensionalBackgroundNoise.ned index 0e0234e9885..b36aee014f2 100644 --- a/src/inet/physicallayer/wireless/common/backgroundnoise/DimensionalBackgroundNoise.ned +++ b/src/inet/physicallayer/wireless/common/backgroundnoise/DimensionalBackgroundNoise.ned @@ -13,9 +13,9 @@ 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 timeGains = default("left 0s 0dB left"); // Sequence of interpolation methods, 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 frequencyGains = default("left 0Hz 0dB left"); // Sequence of interpolation methods, 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); diff --git a/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned index 8cf14ca6d2f..52918b7d5c3 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/ErrorModelBase.ned @@ -18,7 +18,7 @@ module ErrorModelBase like IErrorModel 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 - // 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 + // this can be used, for example, to represent 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/PropagationBase.ned b/src/inet/physicallayer/wireless/common/base/packetlevel/PropagationBase.ned index 9e33a4d5e11..bb001384d5b 100644 --- a/src/inet/physicallayer/wireless/common/base/packetlevel/PropagationBase.ned +++ b/src/inet/physicallayer/wireless/common/base/packetlevel/PropagationBase.ned @@ -18,4 +18,3 @@ module PropagationBase like IPropagation 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/medium/MediumLimitCache.ned b/src/inet/physicallayer/wireless/common/medium/MediumLimitCache.ned index b5bde2d485d..ad635c04e90 100644 --- a/src/inet/physicallayer/wireless/common/medium/MediumLimitCache.ned +++ b/src/inet/physicallayer/wireless/common/medium/MediumLimitCache.ned @@ -13,7 +13,7 @@ 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); // Maximum 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 diff --git a/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned b/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned index e9f57f5c3ec..a6d64e9b79b 100644 --- a/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned +++ b/src/inet/physicallayer/wireless/common/medium/RadioMedium.ned @@ -32,13 +32,13 @@ module RadioMedium like IRadioMedium // 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 + 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 an 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 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 300065d1b0d..b017de1ddd3 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 into so many cells + int cellCountY = default(10); // Divide space into so many cells + int cellCountZ = default(10); // Divide space into 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 017d3cb00d2..a0c07db4cfd 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); // Enable/disable material dielectric loss + bool enableReflectionLoss = default(true); // Enable/disable surface reflection loss @class(DielectricObstacleLoss); } diff --git a/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned b/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned index 9aa1f4c3a18..38d75852367 100644 --- a/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned +++ b/src/inet/physicallayer/wireless/common/propagation/ConstantSpeedPropagation.ned @@ -17,9 +17,8 @@ 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 signal transmission is ignored + bool ignoreMovementDuringPropagation = default(true); // True means that the movement of the transmitter and the receiver during signal propagation is ignored + bool ignoreMovementDuringReception = default(true); // True means that the movement of the transmitter and the receiver during signal reception is ignored @class(ConstantSpeedPropagation); } - diff --git a/src/inet/physicallayer/wireless/generic/GenericTransmitter.ned b/src/inet/physicallayer/wireless/generic/GenericTransmitter.ned index f03ae1069dd..d9bf753f2a1 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 bits in the PHY header. + double bitrate @unit(bps); // The bitrate of the transmitter is used to compute the duration of the PHY header and the data part. @class(GenericTransmitter); @display("i=block/wtx"); } diff --git a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned index 9c807092f3e..b2c8390a98b 100644 --- a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned +++ b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedCcEnergyConsumer.ned @@ -22,12 +22,12 @@ simple Ieee80211StateBasedCcEnergyConsumer extends StateBasedCcEnergyConsumer sleepCurrentConsumption = default(0.01mA); switchingCurrentConsumption = default(100mA); // Tx/rx calibration mode receiverIdleCurrentConsumption = default(100mA); - receiverBusyCurrentConsumption = default(100mA); // No info yet + receiverBusyCurrentConsumption = default(100mA); // No information yet receiverReceivingCurrentConsumption = default(100mA); receiverReceivingPreambleCurrentConsumption = default(receiverReceivingCurrentConsumption); receiverReceivingHeaderCurrentConsumption = default(receiverReceivingCurrentConsumption); receiverReceivingDataCurrentConsumption = default(receiverReceivingCurrentConsumption); - transmitterIdleCurrentConsumption = default(100mA); // No info yet + transmitterIdleCurrentConsumption = default(100mA); // No information 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 2a1208641de..621c15d92cb 100644 --- a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedEpEnergyConsumer.ned +++ b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211StateBasedEpEnergyConsumer.ned @@ -22,12 +22,12 @@ simple Ieee80211StateBasedEpEnergyConsumer extends StateBasedEpEnergyConsumer sleepPowerConsumption = default(0.05mW); switchingPowerConsumption = default(100mW); // Tx/rx calibration mode receiverIdlePowerConsumption = default(0.5W); - receiverBusyPowerConsumption = default(0.5W); // No info yet + receiverBusyPowerConsumption = default(0.5W); // No information available yet receiverReceivingPowerConsumption = default(1W); receiverReceivingPreamblePowerConsumption = default(receiverReceivingPowerConsumption); receiverReceivingHeaderPowerConsumption = default(receiverReceivingPowerConsumption); receiverReceivingDataPowerConsumption = default(receiverReceivingPowerConsumption); - transmitterIdlePowerConsumption = default(1W); // No info yet + transmitterIdlePowerConsumption = default(1W); // No information available yet transmitterTransmittingPowerConsumption = default(2.5W); transmitterTransmittingPreamblePowerConsumption = default(transmitterTransmittingPowerConsumption); transmitterTransmittingHeaderPowerConsumption = default(transmitterTransmittingPowerConsumption); diff --git a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Transmitter.ned b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Transmitter.ned index 24fd981353e..3d50ab670e5 100644 --- a/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Transmitter.ned +++ b/src/inet/physicallayer/wireless/ieee80211/packetlevel/Ieee80211Transmitter.ned @@ -20,7 +20,6 @@ module Ieee80211Transmitter extends NarrowbandTransmitterBase string opMode @enum("a","b","g(erp)","g(mixed)","n(mixed-2.4Ghz)","p","ac"); 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"); int channelNumber; - modulation = default("BPSK"); // TODO this is simply wrong + modulation = default("BPSK"); // TODO: This is simply wrong @class(Ieee80211Transmitter); } - diff --git a/src/inet/physicallayer/wireless/ieee802154/packetlevel/Ieee802154NarrowbandRadio.ned b/src/inet/physicallayer/wireless/ieee802154/packetlevel/Ieee802154NarrowbandRadio.ned index 6ee113d1810..4e18efa091b 100644 --- a/src/inet/physicallayer/wireless/ieee802154/packetlevel/Ieee802154NarrowbandRadio.ned +++ b/src/inet/physicallayer/wireless/ieee802154/packetlevel/Ieee802154NarrowbandRadio.ned @@ -31,30 +31,30 @@ module Ieee802154NarrowbandRadio extends FlatRadioBase // Preamble // 4 octets Preamble - // 1 symbol of 16us -> 4 bit + // 1 symbol of 16us -> 4 bits transmitter.preambleDuration = (4*8/4) * 16 us; // RSSI sensitivity (ATmega256RFR2, page 566) - receiver.energyDetection = default(-90dBm); + receiver.energyDetection = default(-90 dBm); // Receiver sensitivity (ATmega256RFR2, page 565) // TODO That is not quite true, because sensitivity // is defined as the input signal power that yields // a PER < 1% for a PSDU of 20 octets, but INET handles it // as minimum reception power. - receiver.sensitivity = default(-100dBm); + receiver.sensitivity = default(-100 dBm); // There is no fixed boundary, because of the // DSSS and the capture effect. Taking the sensitivity minus some // arbitrary value as an approximate guess. - receiver.minInterferencePower = default(-120dBm); + receiver.minInterferencePower = default(-120 dBm); // Minimum SNIR - // -8 dB results into 98% PER for a PSDU of 20 octets + // -8 dB results in 98% PER for a PSDU of 20 octets receiver.snirThreshold = default(-8 dB); // TX Output power (typ. 3.5 dBm, ATmega256RFR2, page 564) - transmitter.power = default(2.24mW); + transmitter.power = default(2.24 mW); @class(FlatRadioBase); } diff --git a/src/inet/physicallayer/wireless/noise/NoiseTransmitter.ned b/src/inet/physicallayer/wireless/noise/NoiseTransmitter.ned index 7ff328b3369..b464708ebe7 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/power/consumer/AlternatingEpEnergyConsumer.ned b/src/inet/power/consumer/AlternatingEpEnergyConsumer.ned index 9ace1d65cbd..5c92abb60a8 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 the energy source + volatile double powerConsumption @unit(W); // The amount of power consumed in consumption mode + volatile double consumptionInterval @unit(s); // The time interval for the consumption mode + volatile double sleepInterval @unit(s); // The time interval for the sleep mode @class(AlternatingEpEnergyConsumer); } diff --git a/src/inet/power/generator/AlternatingEpEnergyGenerator.ned b/src/inet/power/generator/AlternatingEpEnergyGenerator.ned index a63fed892ff..d2e7b7f020b 100644 --- a/src/inet/power/generator/AlternatingEpEnergyGenerator.ned +++ b/src/inet/power/generator/AlternatingEpEnergyGenerator.ned @@ -20,10 +20,9 @@ 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 the energy sink + volatile double powerGeneration @unit(W); // The amount of power generated in the generation mode + volatile double generationInterval @unit(s); // The time interval for the generation mode + volatile double sleepInterval @unit(s); // The time interval for the sleep mode @class(AlternatingEpEnergyGenerator); } - diff --git a/src/inet/power/storage/CcBatteryPack.ned b/src/inet/power/storage/CcBatteryPack.ned index 4ec81b25fca..29bea4a726f 100644 --- a/src/inet/power/storage/CcBatteryPack.ned +++ b/src/inet/power/storage/CcBatteryPack.ned @@ -13,11 +13,11 @@ simple CcBatteryPack extends SimpleCcBattery { parameters: 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 + string arrangement @enum("serial", "parallel") = default("serial"); + double cellNominalCapacity @unit(C) = default(7200 C); // Typical capacity of an 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 + nominalVoltage = default(arrangement == "serial" ? numberOfCells * cellNominalVoltage : cellNominalVoltage); // Voltage is added when cells are arranged in series + internalResistance = default(arrangement == "serial" ? numberOfCells * cellInternalResistance : cellInternalResistance / numberOfCells); // Internal resistance is added when cells are arranged in series } diff --git a/src/inet/protocolelement/common/InterpacketGapInserter.ned b/src/inet/protocolelement/common/InterpacketGapInserter.ned index 9101b1bbc71..c32ae07b6b2 100644 --- a/src/inet/protocolelement/common/InterpacketGapInserter.ned +++ b/src/inet/protocolelement/common/InterpacketGapInserter.ned @@ -13,7 +13,7 @@ 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 + bool initialChannelBusy = default(false); // Assume that the 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/redundancy/StreamClassifier.ned b/src/inet/protocolelement/redundancy/StreamClassifier.ned index d1d37b58e4b..63562148ac3 100644 --- a/src/inet/protocolelement/redundancy/StreamClassifier.ned +++ b/src/inet/protocolelement/redundancy/StreamClassifier.ned @@ -19,7 +19,7 @@ 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 gateIndexOffset = default(0); // Specify the 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 c8bcfb2c97e..062f69dce01 100644 --- a/src/inet/protocolelement/redundancy/StreamDecoder.ned +++ b/src/inet/protocolelement/redundancy/StreamDecoder.ned @@ -22,7 +22,7 @@ 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}, ...] + 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 559ff0daf9f..58875900373 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/StreamMerger.ned b/src/inet/protocolelement/redundancy/StreamMerger.ned index 08175b58aed..d16c6782602 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. An 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/shaper/EligibilityTimeGate.ned b/src/inet/protocolelement/shaper/EligibilityTimeGate.ned index 1f115f92fe0..1ae6033e6ce 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 the 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 fc1777b8fe8..c33cf1c135f 100644 --- a/src/inet/protocolelement/shaper/EligibilityTimeMeter.ned +++ b/src/inet/protocolelement/shaper/EligibilityTimeMeter.ned @@ -27,7 +27,7 @@ simple EligibilityTimeMeter extends PacketMeterBase like IPacketMeter 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 + double maxResidenceTime @unit(s) = default(-1s); // Maximum packet residence time measured from the packet arrival time to the meter module to the transmission eligibility 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/queueing/base/PacketLabelerBase.ned b/src/inet/queueing/base/PacketLabelerBase.ned index 4f24b9bcf4c..389f81323d9 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/common/OrdinalBasedDuplicator.ned b/src/inet/queueing/common/OrdinalBasedDuplicator.ned index 7da396bec59..a5520e3cc1a 100644 --- a/src/inet/queueing/common/OrdinalBasedDuplicator.ned +++ b/src/inet/queueing/common/OrdinalBasedDuplicator.ned @@ -18,7 +18,7 @@ simple OrdinalBasedDuplicator extends PacketDuplicatorBase { parameters: string duplicatesVector = default(""); // The duplicatesVector format is ";;...;" - // packet numbers in ascending order e.g. "5;6;12;13;" + // Packet numbers in ascending order, e.g. "5;6;12;13;" @display("i=block/control"); @class(OrdinalBasedDuplicator); gates: diff --git a/src/inet/queueing/common/PacketMultiplexer.ned b/src/inet/queueing/common/PacketMultiplexer.ned index c7f9d24464b..8ceb72a081b 100644 --- a/src/inet/queueing/common/PacketMultiplexer.ned +++ b/src/inet/queueing/common/PacketMultiplexer.ned @@ -20,7 +20,7 @@ simple PacketMultiplexer extends PacketProcessorBase like IActivePacketSource // parameters: bool forwardServiceRegistration = default(true); bool forwardProtocolRegistration = default(true); - displayStringTextFormat = default("passed %p pk (%l)"); // %p number of packet, %l total length + displayStringTextFormat = default("passed %p pk (%l)"); // %p number of packets, %l total length @class(PacketMultiplexer); @display("i=-;b=10,10,oval,grey,,1"); @signal[packetPushed](type=inet::Packet); diff --git a/src/inet/queueing/filter/OrdinalBasedDropper.ned b/src/inet/queueing/filter/OrdinalBasedDropper.ned index a89186e25a5..6e461aded04 100644 --- a/src/inet/queueing/filter/OrdinalBasedDropper.ned +++ b/src/inet/queueing/filter/OrdinalBasedDropper.ned @@ -17,7 +17,7 @@ simple OrdinalBasedDropper extends PacketFilterBase { parameters: string dropsVector = default(""); // The dropsVector format is ";;...;" - // packet numbers in ascending order e.g. "5;6;12;13;" + // 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 46ccde67cb7..affcfd345ea 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 that pass the filter, the parameter must be the name of a C++ class that 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 bf61d1e48eb..66180e5c7c3 100644 --- a/src/inet/queueing/filter/RedDropper.ned +++ b/src/inet/queueing/filter/RedDropper.ned @@ -39,8 +39,8 @@ 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 minth = default(5); // Minimum threshold for average queue length + double maxth = default(50); // Maximum threshold for average 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 diff --git a/src/inet/queueing/flow/FlowMeasurementStarter.ned b/src/inet/queueing/flow/FlowMeasurementStarter.ned index fbd76a8f7a4..a6286873e7a 100644 --- a/src/inet/queueing/flow/FlowMeasurementStarter.ned +++ b/src/inet/queueing/flow/FlowMeasurementStarter.ned @@ -13,7 +13,7 @@ import inet.queueing.contract.IPacketFlow; simple FlowMeasurementStarter extends PacketFlowBase like IPacketFlow { parameters: - object packetFilter = default("*"); // Which packets are considered, matches all packets by default + object packetFilter = default("*"); // Specifies 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 diff --git a/src/inet/queueing/gate/GateControlList.ned b/src/inet/queueing/gate/GateControlList.ned index ab155b9d7d4..1bb52340f64 100644 --- a/src/inet/queueing/gate/GateControlList.ned +++ b/src/inet/queueing/gate/GateControlList.ned @@ -15,9 +15,9 @@ 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"] + object gateStates @mutable = default([]); // List of gate states, 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 + string mapping; // String specifying the gate index for the ith gate state, e.g. "76543210" means reverse gate index order @class(GateControlList); @display("i=block/table"); } diff --git a/src/inet/queueing/marker/PacketLabeler.ned b/src/inet/queueing/marker/PacketLabeler.ned index 58a2b0ae46e..b5a35656e13 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 that are marked. The parameter must be the name of a C++ class that 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/meter/MultiTokenBucketMeter.ned b/src/inet/queueing/meter/MultiTokenBucketMeter.ned index b47067abad9..7121e8f2914 100644 --- a/src/inet/queueing/meter/MultiTokenBucketMeter.ned +++ b/src/inet/queueing/meter/MultiTokenBucketMeter.ned @@ -22,7 +22,7 @@ simple MultiTokenBucketMeter extends PacketMeterBase like IPacketMeter // 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 + string defaultLabel = default(""); // The label that is attached to packets if there are not enough 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); diff --git a/src/inet/queueing/meter/TokenBucketMeter.ned b/src/inet/queueing/meter/TokenBucketMeter.ned index 3e542f5098f..9f84a02e3a5 100644 --- a/src/inet/queueing/meter/TokenBucketMeter.ned +++ b/src/inet/queueing/meter/TokenBucketMeter.ned @@ -26,9 +26,9 @@ simple TokenBucketMeter extends PacketMeterBase like IPacketMeter 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 + string defaultLabel = default(""); // The label that is attached to packets if there are not enough 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 + string excessTokenModule = default(""); // Specifies the module (~ITokenStorage) that receives the excess tokens that are produced by this module when overflowed 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/scheduler/MarkovScheduler.ned b/src/inet/queueing/scheduler/MarkovScheduler.ned index 91a1449bb8f..ef318766114 100644 --- a/src/inet/queueing/scheduler/MarkovScheduler.ned +++ b/src/inet/queueing/scheduler/MarkovScheduler.ned @@ -19,8 +19,8 @@ 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 clockModule = default(""); // Relative path to a module that implements IClock; optional + int initialState = default(0); // The starting 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/sink/ActivePacketSink.ned b/src/inet/queueing/sink/ActivePacketSink.ned index 8c19e706032..33c794212f1 100644 --- a/src/inet/queueing/sink/ActivePacketSink.ned +++ b/src/inet/queueing/sink/ActivePacketSink.ned @@ -31,7 +31,7 @@ simple ActivePacketSink extends ActivePacketSinkBase like IActivePacketSink 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 + 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 6b1f9df9075..b834acf318f 100644 --- a/src/inet/queueing/sink/PassivePacketSink.ned +++ b/src/inet/queueing/sink/PassivePacketSink.ned @@ -20,7 +20,7 @@ simple PassivePacketSink extends PassivePacketSinkBase like IPassivePacketSink 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 + 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 e98d43b08ea..db81cb23009 100644 --- a/src/inet/queueing/sink/PcapFilePacketConsumer.ned +++ b/src/inet/queueing/sink/PcapFilePacketConsumer.ned @@ -21,7 +21,7 @@ simple PcapFilePacketConsumer extends PassivePacketSinkBase like IPassivePacketS 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). + int timePrecision = default(6); // Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format). 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); diff --git a/src/inet/queueing/source/ActivePacketSource.ned b/src/inet/queueing/source/ActivePacketSource.ned index f9b9d6aadd9..cc943aa5087 100644 --- a/src/inet/queueing/source/ActivePacketSource.ned +++ b/src/inet/queueing/source/ActivePacketSource.ned @@ -29,7 +29,7 @@ simple ActivePacketSource extends ActivePacketSourceBase like IActivePacketSourc 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 + 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 26cc7089656..ff21a7354dc 100644 --- a/src/inet/queueing/source/PassivePacketSource.ned +++ b/src/inet/queueing/source/PassivePacketSource.ned @@ -20,7 +20,7 @@ simple PassivePacketSource extends PassivePacketSourceBase like IPassivePacketSo 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 + 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/tokengenerator/PacketBasedTokenGenerator.ned b/src/inet/queueing/tokengenerator/PacketBasedTokenGenerator.ned index 62f16205e03..1711d274471 100644 --- a/src/inet/queueing/tokengenerator/PacketBasedTokenGenerator.ned +++ b/src/inet/queueing/tokengenerator/PacketBasedTokenGenerator.ned @@ -19,7 +19,7 @@ simple PacketBasedTokenGenerator extends TokenGeneratorBase like IPassivePacketS parameters: 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 + displayStringTextFormat = default("processed %p pk (%l)\ngenerated %t tk\nto %s"); // %p number of packets, %l total length @class(PacketBasedTokenGenerator); gates: input in; diff --git a/src/inet/routing/aodv/Aodv.ned b/src/inet/routing/aodv/Aodv.ned index 67bdb56fcdd..6d51310df59 100644 --- a/src/inet/routing/aodv/Aodv.ned +++ b/src/inet/routing/aodv/Aodv.ned @@ -45,7 +45,7 @@ simple Aodv like IApp 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 + // need more revision: As well as the decision as to whether // to use jitter being dependent on the medium access control and // lower layers, the selection of the MAXJITTER parameter SHOULD // be appropriate to those mechanisms. @@ -54,7 +54,7 @@ simple Aodv like IApp 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 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 diff --git a/src/inet/routing/ospfv2/Ospfv2.ned b/src/inet/routing/ospfv2/Ospfv2.ned index 4e3ec0891c6..a79c194afe1 100644 --- a/src/inet/routing/ospfv2/Ospfv2.ned +++ b/src/inet/routing/ospfv2/Ospfv2.ned @@ -162,8 +162,8 @@ simple Ospfv2 like IOspf 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 + string interfaceMode @enum("Active","Passive","NoOSPF") = default("Active"); // NoOSPF: the interface is not advertised by OSPF + // Passive: the interface is advertised, but no OSPF message is sent 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 @@ -172,7 +172,7 @@ simple Ospfv2 like IOspf string forwardingAddress = default("0.0.0.0"); int linkCost = default(1); // Cost of link (1-1000) for HostInterface and LoopbackInterface only - string authenticationType @enum("SimplePasswordType","CrytographicType","NullType") = default("NullType"); + string authenticationType @enum("SimplePasswordType","CryptographicType","NullType") = default("NullType"); string authenticationKey = default("0x00"); // 0xnn..nn @display("i=block/network2"); diff --git a/src/inet/routing/ospfv3/Ospfv3Splitter.ned b/src/inet/routing/ospfv3/Ospfv3Splitter.ned index 2bdc667d900..846522dae5d 100644 --- a/src/inet/routing/ospfv3/Ospfv3Splitter.ned +++ b/src/inet/routing/ospfv3/Ospfv3Splitter.ned @@ -3,7 +3,7 @@ package inet.routing.ospfv3; simple Ospfv3Splitter { - parameters: //these are parameteters which need to be filled in omnetpp.ini file + parameters: // these are parameters which need to be filled in the omnetpp.ini file xml ospfv3RoutingConfig; xml ospfv3IntConfig; diff --git a/src/inet/transportlayer/sctp/Sctp.ned b/src/inet/transportlayer/sctp/Sctp.ned index f64eeef1703..41303ff28e1 100644 --- a/src/inet/transportlayer/sctp/Sctp.ned +++ b/src/inet/transportlayer/sctp/Sctp.ned @@ -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 flow control + int bytesToAddPerPeerChunk = default(0); // For flow control + bool tellArwnd = default(false); // For flow control + int messageAcceptLimit = default(0); // For flow control 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 33603e481d1..8a6a489084c 100644 --- a/src/inet/transportlayer/tcp/Tcp.ned +++ b/src/inet/transportlayer/tcp/Tcp.ned @@ -154,7 +154,7 @@ 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) + 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) @@ -166,8 +166,8 @@ 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... + 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 diff --git a/src/inet/transportlayer/tcp/TcpConnection.ned b/src/inet/transportlayer/tcp/TcpConnection.ned index 797570d2145..903d8f51ac8 100644 --- a/src/inet/transportlayer/tcp/TcpConnection.ned +++ b/src/inet/transportlayer/tcp/TcpConnection.ned @@ -26,9 +26,9 @@ simple TcpConnection { @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[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 diff --git a/src/inet/transportlayer/tcp_common/TcpSpoof.ned b/src/inet/transportlayer/tcp_common/TcpSpoof.ned index 2098ed8c06c..4d71647ed4a 100644 --- a/src/inet/transportlayer/tcp_common/TcpSpoof.ned +++ b/src/inet/transportlayer/tcp_common/TcpSpoof.ned @@ -24,7 +24,7 @@ simple TcpSpoof like ITcp 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 + bool isSYN = default(true); // Whether to set the SYN bit on the packet double t @unit(s); // Simulation time to send at @display("i=block/square"); @signal[packetSent](type=cPacket); diff --git a/src/inet/visualizer/base/ChannelVisualizerBase.ned b/src/inet/visualizer/base/ChannelVisualizerBase.ned index 20817b9dc17..21fbdae1fff 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 lineColor = default("blue"); // Arrow color. Black by default. + 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 3d509182ef1..66cf9a6bbee 100644 --- a/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned +++ b/src/inet/visualizer/base/EnergyStorageVisualizerBase.ned @@ -19,13 +19,13 @@ simple EnergyStorageVisualizerBase extends VisualizerBase 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. + 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 d47561f49b2..6545649603a 100644 --- a/src/inet/visualizer/base/GateScheduleVisualizerBase.ned +++ b/src/inet/visualizer/base/GateScheduleVisualizerBase.ned @@ -35,7 +35,7 @@ simple GateScheduleVisualizerBase extends VisualizerBase 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 currentTimePosition = default(width / 2); // Position of the current simulation time in the visualization, horizontally centered by default @class(GateScheduleVisualizerBase); } diff --git a/src/inet/visualizer/base/Ieee80211VisualizerBase.ned b/src/inet/visualizer/base/Ieee80211VisualizerBase.ned index 464da225ee7..b77a0d0c596 100644 --- a/src/inet/visualizer/base/Ieee80211VisualizerBase.ned +++ b/src/inet/visualizer/base/Ieee80211VisualizerBase.ned @@ -29,13 +29,13 @@ simple Ieee80211VisualizerBase extends VisualizerBase 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 maxPower @unit(dBm) = default(-50dBm); // Maximum expected 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. + 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 b2bb0ee2b7c..497f02913db 100644 --- a/src/inet/visualizer/base/InfoVisualizerBase.ned +++ b/src/inet/visualizer/base/InfoVisualizerBase.ned @@ -35,10 +35,10 @@ simple InfoVisualizerBase extends VisualizerBase 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 + string backgroundColor = default("white"); // Text box fill color, specify an empty string for no fill + string lineColor = default("black"); // Text box outline color, specify an 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. + 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/MediumVisualizerBase.ned b/src/inet/visualizer/base/MediumVisualizerBase.ned index 4e181a57a26..33afbf559b2 100644 --- a/src/inet/visualizer/base/MediumVisualizerBase.ned +++ b/src/inet/visualizer/base/MediumVisualizerBase.ned @@ -21,7 +21,7 @@ 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 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 @@ -29,10 +29,10 @@ simple MediumVisualizerBase extends VisualizerBase 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 + 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 signalPropagationAdditionalTime @unit(s) = default(0s); // Additional simulation time to animate signal propagation after leaving the 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 @@ -40,12 +40,12 @@ simple MediumVisualizerBase extends VisualizerBase 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. + 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. + 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 @@ -58,20 +58,20 @@ simple MediumVisualizerBase extends VisualizerBase 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 + // 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 + double signalMinPower @unit(dBmW) = default(inf dBmW); // Minimum signal power if the axis is not automatic + double signalMaxPower @unit(dBmW) = default(0 dBmW); // Maximum signal power if the axis is not automatic + double signalMinPowerDensity @unit(dBmWpMHz) = default(inf dBmWpMHz); // Minimum signal power density if the axis is not automatic + double signalMaxPowerDensity @unit(dBmWpMHz) = default(-inf dBmWpMHz); // Maximum signal power density if the 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 + double signalMinTime @unit(s) = default(0 s); // Relative to the current simulation time + double signalMaxTime @unit(s) = default(0 s); // Relative to the 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 + double signalMinFrequency @unit(Hz) = default(inf Hz); // Minimum signal frequency if the axis is not automatic + double signalMaxFrequency @unit(Hz) = default(-inf Hz); // Maximum signal frequency if the axis is not automatic - // parameters for main power density map + // parameters for the 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 @@ -79,14 +79,14 @@ simple MediumVisualizerBase extends VisualizerBase 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 + string powerDensityMapPixelMode @enum("sample", "partition", "mean") = default("mean"); // Specifies the method used to determine the color of each pixel, the sample method is the least accurate but the fastest (sample < partition < mean) + int powerDensityMapApproximationSize = default(10); // Medium power density function approximation along the 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 @@ -94,31 +94,31 @@ simple MediumVisualizerBase extends VisualizerBase 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 + 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. + 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 + // parameters for the 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) + string spectrogramPixelMode @enum("sample", "partition", "mean") = default("mean"); // Specifies 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. + 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/NetworkConnectionVisualizerBase.ned b/src/inet/visualizer/base/NetworkConnectionVisualizerBase.ned index 10d666b8e35..4a385e59fe3 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 are displayed 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 0c965f544bc..d9dbc47d616 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 are displayed by default. double annotationSpacing = default(4); double placementPenalty = default(10); diff --git a/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned b/src/inet/visualizer/base/PhysicalEnvironmentVisualizerBase.ned index fea6d616527..00ced1d7d20 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 sub-module by default bool displayObjects = default(true); diff --git a/src/inet/visualizer/base/QueueVisualizerBase.ned b/src/inet/visualizer/base/QueueVisualizerBase.ned index 2183fa3300b..c3563e77f68 100644 --- a/src/inet/visualizer/base/QueueVisualizerBase.ned +++ b/src/inet/visualizer/base/QueueVisualizerBase.ned @@ -1,3 +1,4 @@ + // // Copyright (C) 2020 OpenSim Ltd. // @@ -25,7 +26,7 @@ simple QueueVisualizerBase extends VisualizerBase 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. + 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/RoutingTableVisualizerBase.ned b/src/inet/visualizer/base/RoutingTableVisualizerBase.ned index 3f4bf6eb232..09918567847 100644 --- a/src/inet/visualizer/base/RoutingTableVisualizerBase.ned +++ b/src/inet/visualizer/base/RoutingTableVisualizerBase.ned @@ -31,15 +31,15 @@ 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 - - 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 + bool displayRoutingTables = default(false); // Displays routing table data, disabled by default + bool displayRoutesIndividually = default(true); // Displays routes between the same network nodes individually, enabled by default + bool displayLabels = default(true); // Displays labels on arrows, enabled by default + + string destinationFilter @mutable = default("*"); // Determines the destinations that are considered, matches all destinations by default + string nodeFilter @mutable = default("*"); // Determines the nodes that are considered, matches all nodes by default + string multicastSourceNodeFilter @mutable = default("*"); // Determines the multicast source nodes that are considered, matches all nodes by default + string multicastSourceAddressFilter @mutable = default("*"); // Determines the multicast source addresses that are considered, matches all addresses by default + string multicastGroupFilter @mutable = default("*"); // Determines the multicast group addresses that 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) diff --git a/src/inet/visualizer/base/SceneVisualizerBase.ned b/src/inet/visualizer/base/SceneVisualizerBase.ned index f0a7d24b304..339c07654d9 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 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 + double animationSpeed = default(0); // Always active animation speed independent of any visualization, the value must be in the range (0, +inf) + double sceneMinX @unit(m) = default(nan m); // Lower bound of x coordinates in the scene + double sceneMinY @unit(m) = default(nan m); // Lower bound of y coordinates in the scene + double sceneMinZ @unit(m) = default(nan m); // Lower bound of z coordinates in the scene + double sceneMaxX @unit(m) = default(nan m); // Upper bound of x coordinates in the scene + double sceneMaxY @unit(m) = default(nan m); // Upper bound of y coordinates in the scene + double sceneMaxZ @unit(m) = default(nan m); // Upper bound of z coordinates in the scene @class(SceneVisualizerBase); } diff --git a/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned b/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned index 7f24c9c7409..abe1e0b466b 100644 --- a/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned +++ b/src/inet/visualizer/base/TracingObstacleLossVisualizerBase.ned @@ -17,12 +17,12 @@ 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 intersections 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 intersections, disabled by default string faceNormalLineColor = default("grey"); string faceNormalLineStyle = default("solid"); double faceNormalLineWidth = default(1); diff --git a/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned b/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned index 6d343df92f8..25b523ff7bc 100644 --- a/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned +++ b/src/inet/visualizer/base/TransportConnectionVisualizerBase.ned @@ -24,7 +24,7 @@ simple TransportConnectionVisualizerBase extends VisualizerBase parameters: 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 + bool displayTransportConnections = default(false);// display transport connection endpoints, 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 diff --git a/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned b/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned index 0d520019637..d7b917d69dd 100644 --- a/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/linklayer/InterfaceTableCanvasVisualizer.ned @@ -20,7 +20,7 @@ simple InterfaceTableCanvasVisualizer extends InterfaceTableVisualizerBase like { 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 + string anchor @enum("l","r","t") = default("l"); // Specifies the beginning/end/middle @class(InterfaceTableCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/physicallayer/ChannelCanvasVisualizer.ned b/src/inet/visualizer/canvas/physicallayer/ChannelCanvasVisualizer.ned index 045503aa6cd..c3388ea428f 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/scene/NetworkConnectionCanvasVisualizer.ned b/src/inet/visualizer/canvas/scene/NetworkConnectionCanvasVisualizer.ned index 1db49947cb7..ba01d945e19 100644 --- a/src/inet/visualizer/canvas/scene/NetworkConnectionCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/scene/NetworkConnectionCanvasVisualizer.ned @@ -19,7 +19,7 @@ simple NetworkConnectionCanvasVisualizer extends NetworkConnectionVisualizerBase { 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 + nodeFilter = default(""); // Disabled because OMNeT++ displays network connections by default @class(NetworkConnectionCanvasVisualizer); } diff --git a/src/inet/visualizer/canvas/scene/OpenStreetMapSceneCanvasVisualizer.ned b/src/inet/visualizer/canvas/scene/OpenStreetMapSceneCanvasVisualizer.ned index 70227412616..7af0a9e8c0a 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 + bool adjustBackgroundBox = default(true); // If true, sets the 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 c996a66297d..9dadca6ce5f 100644 --- a/src/inet/visualizer/canvas/scene/SceneCanvasVisualizer.ned +++ b/src/inet/visualizer/canvas/scene/SceneCanvasVisualizer.ned @@ -22,7 +22,7 @@ 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 () + 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 diff --git a/src/inet/visualizer/osg/environment/PhysicalEnvironmentOsgVisualizer.ned b/src/inet/visualizer/osg/environment/PhysicalEnvironmentOsgVisualizer.ned index ba573ede2dd..e1a47f75329 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 opacity 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 4ce8a799ded..a0e09ec3712 100644 --- a/src/inet/visualizer/osg/physicallayer/MediumOsgVisualizer.ned +++ b/src/inet/visualizer/osg/physicallayer/MediumOsgVisualizer.ned @@ -26,7 +26,7 @@ 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 + 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) diff --git a/src/inet/visualizer/osg/scene/SceneOsgVisualizer.ned b/src/inet/visualizer/osg/scene/SceneOsgVisualizer.ned index 413bc60d1d2..a78ed684bd5 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, default is white }