NrCar

Package: simu5g.nodes

NrCar

compound module

Defines a LteCar node as an NR User Equipment (UE) with vehicular-like mobility. The latter is modeled by utilizing the Veins-Inet project.

See https://veins.car2x.org/documentation/modules/#veins_inet

status : NodeStatus [from inet] ↗ Keeps track of the status of the network node (up, down, etc.) for other modules, and also displays... Source: status: NodeStatus if hasStatus { @display("p=125,80;is=s"); } clock : like IClock IClock [from inet] ↗: Interface for clock models. Source: clock: <default("")> like IClock if typename != "" { @display("p=125,320;is=s"); } energyStorage : like IEnergyStorage IEnergyStorage [from inet] ↗: The energy storage models describe devices that absorb energy produced by generators, and provide... Source: energyStorage: <default("")> like IEnergyStorage if typename != "" { @display("p=125,400;is=s"); } energyManagement : like IEnergyManagement IEnergyManagement [from inet] ↗: The energy management models monitor an energy storage, estimate its state, and control the... Source: energyManagement: <default("")> like IEnergyManagement if typename != "" { @display("p=125,480;is=s"); } energyGenerator : like IEnergyGenerator IEnergyGenerator [from inet] ↗: The energy generator models describe the energy generation process of devices over time. Source: energyGenerator: <default("")> like IEnergyGenerator if typename != "" { @display("p=125,560;is=s"); } mobility : like IMobility IMobility [from inet] ↗: The module interface for mobility models. Source: mobility: <default("")> like IMobility if typename != "" { @display("p=125,160;is=s"); } measurer : like IMeasurer IMeasurer [from inet] ↗: Interface for all standalone measurement modules. Source: measurer: <default("")> like IMeasurer if typename != "" { @display("p=125,640;is=s"); } environment : ExternalEnvironment [from inet] ↗ Executes a setup command on the host OS during initialization and another teardown command during... Source: environment: ExternalEnvironment if hasEnvironment { @display("p=125,800;is=s"); } pcapRecorder[numPcapRecorders] : PcapRecorder [from inet] ↗ Records PCAP traces of frames sent/received by other modules within the same host. Source: pcapRecorder[numPcapRecorders]: PcapRecorder { @display("p=125,720;is=s"); } interfaceTable : InterfaceTable [from inet] ↗ Keeps the table of network interfaces. Source: interfaceTable: InterfaceTable { @display("p=125,240;is=s"); } llc : like IIeee8022Llc IIeee8022Llc [from inet] ↗ Source: llc: <default("")> like IIeee8022Llc if typename != "" { @display("p=375,525"); } cb : MessageDispatcher [from inet] ↗ Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: cb: MessageDispatcher { @display("p=750,600;b=1000,5"); } bridging : like IProtocolLayer IProtocolLayer [from inet] ↗: Interface for all protocol layer modules that connect to a higher and to a lower protocol layer,... Source: bridging: <default("")> like IProtocolLayer if typename != "" { @display("p=750,675"); } bl : MessageDispatcher [from inet] ↗ Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: bl: MessageDispatcher { @display("p=750,750;b=1000,5"); } ethernet : like IEthernetLayer IEthernetLayer [from inet] ↗: Module interface for Ethernet protocol layer implementations. Source: ethernet: <default(sizeof(ethg) > 0 ? "EthernetEncapsulation" : "")> like IEthernetLayer if typename != "" { @display("p=375,825"); } ieee8021q : like IIeee8021qLayer IIeee8021qLayer [from inet] ↗ Source: ieee8021q: <default("")> like IIeee8021qLayer if typename != "" { @display("p=525,825"); } ieee8021r : like IIeee8021rLayer IIeee8021rLayer [from inet] ↗ Source: ieee8021r: <default("")> like IIeee8021rLayer if typename != "" { @display("p=675,825"); } li : MessageDispatcher [from inet] ↗ Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: li: MessageDispatcher { @display("p=750,900;b=1000,5,,,,1"); } lo[numLoInterfaces] : like ILoopbackInterface LoopbackInterface [from inet] ↗: Implements a loopback network interface. ILoopbackInterface [from inet] ↗: Interface for loopback network interfaces. Source: lo[numLoInterfaces]: <default("LoopbackInterface")> like ILoopbackInterface { @display("p=750,975,row,150"); } wlan[numWlanInterfaces] : like IWirelessInterface Ieee80211Interface [from inet] ↗: Implements an IEEE 802.11 network interface. IWirelessInterface [from inet] ↗: Interface for wireless network interfaces. Source: wlan[numWlanInterfaces]: <default("Ieee80211Interface")> like IWirelessInterface { @display("p=375,1000,row,150;q=queue"); } ppp[sizeof(pppg)] : like IPppInterface PppInterface [from inet] ↗: Implements a PPP network interface. IPppInterface [from inet] ↗: Interface for PPP network interfaces. Source: ppp[sizeof(pppg)]: <default("PppInterface")> like IPppInterface { @display("p=300,975,row,150;q=txQueue"); } eth[sizeof(ethg)] : like IEthernetInterface EthernetInterface [from inet] ↗: Represents an Ethernet network interface. IEthernetInterface [from inet] ↗: Interface for Ethernet network interfaces. Source: eth[sizeof(ethg)]: <default("EthernetInterface")> like IEthernetInterface { @display("p=900,975,row,150;q=txQueue"); } tun[numTunInterfaces] : like ITunnelInterface TunInterface [from inet] ↗: Implements a (simulated) TUN network interface. ITunnelInterface [from inet] ↗: Interface for tunnel network interfaces. Source: tun[numTunInterfaces]: <default("TunInterface")> like ITunnelInterface { @display("p=975,1000,row,150;q=txQueue"); } virt[numVirtInterfaces] : like IVirtualInterface VirtualInterface [from inet] ↗: Implements a virtual network interface. IVirtualInterface [from inet] ↗: Interface for virtual network interfaces. Source: virt[numVirtInterfaces]: <default("VirtualInterface")> like IVirtualInterface { @display("p=975,1000,row,150;q=txQueue"); } ipv4 : like INetworkLayer Ipv4NetworkLayer [from inet] ↗: Network layer of an IPv4 node. INetworkLayer [from inet] ↗ Source: ipv4: <default("Ipv4NetworkLayer")> like INetworkLayer if hasIpv4 { @display("p=375,375;q=queue"); } ipv6 : like INetworkLayer Ipv6NetworkLayer [from inet] ↗: Represents a complete IPv6 network layer (L3), to be used within hosts and routers. INetworkLayer [from inet] ↗ Source: ipv6: <default("Ipv6NetworkLayer")> like INetworkLayer if hasIpv6 { @display("p=525,375;q=queue"); } generic : like INetworkLayer INetworkLayer [from inet] ↗ Source: generic: <default("")> like INetworkLayer if hasGn { @display("p=675,375;q=queue"); } nl : MessageDispatcher [from inet] ↗ Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: nl: MessageDispatcher { @display("p=750,450;b=1000,5,,,,1"); } udp : like IUdp IUdp [from inet] ↗: UDP protocol interface. Source: udp: <default(firstAvailableOrEmpty("Udp"))> like IUdp if hasUdp { @display("p=375,225"); } tcp : like ITcp ITcp [from inet] ↗: Interface for TCP protocol implementations. Source: tcp: <default(firstAvailableOrEmpty("Tcp", "TcpLwip", "TcpNsc"))> like ITcp if hasTcp { @display("p=525,225"); } sctp : like ISctp ISctp [from inet] ↗: Interface for SCTP protocol. Source: sctp: <default(firstAvailableOrEmpty("Sctp"))> like ISctp if hasSctp { @display("p=675,225"); } quic : like IQuic IQuic [from inet] ↗: QUIC protocol interface. Source: quic: <default(firstAvailableOrEmpty("Quic"))> like IQuic if hasQuic { @display("p=825,226"); } tn : MessageDispatcher [from inet] ↗ Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: tn: MessageDispatcher { @display("p=750,300;b=1000,5,,,,1"); } app[numApps] : like IApp IApp [from inet] ↗: Generic application interface. Source: app[numApps]: <> like IApp { @display("p=375,75,row,150"); } at : MessageDispatcher [from inet] ↗ Facilitates the interconnection of applications, protocols, and network interfaces, dispatching... Source: at: MessageDispatcher { @display("p=750,150;b=1000,5,,,,1"); } cellularNic : like IUeCellularNic IUeCellularNic: Interface for the 3GPP stack of a UE: the parts of the contract that only a UE's NIC has. Source: cellularNic: <default(hasD2D ? "LteNicUeD2D" : "LteNicUe")> like IUeCellularNic { nodeType = parent.nodeType; sessionType = parent.sessionType; @display("p=600,975"); } macTable : like IMacForwardingTable MacForwardingTable [from inet] ↗: Handles the mapping between ports and MAC addresses. IMacForwardingTable [from inet] ↗: Interface for MAC address tables, used by MAC relay units in Ethenet switches. Source: macTable: <default("MacForwardingTable")> like IMacForwardingTable if hasEthernetSession && ethernetMode == "bridge" { @display("p=125,880;is=s"); } unstructuredApp[numUnstructuredApps] : like IApp UnstructuredApp: An application of a UE whose session is of type Unstructured (the UE's sessionType parameter, see... IApp [from inet] ↗: Generic application interface. Source: unstructuredApp[numUnstructuredApps]: <default("UnstructuredApp")> like IApp { @display("p=1125,75,row,150"); } ueCollector : UeStatsCollector Collects the radio network information of a LTE User Equipment (UE), which can be accessed by the... Source: ueCollector: UeStatsCollector if hasRniSupport { @display("p=125,960;is=s"); } nrUeCollector : NrUeStatsCollector Collects the radio network information of a NR UE, which can be accessed by the ~RniService module... Source: nrUeCollector: NrUeStatsCollector if hasRniSupport { @display("p=125,1040;is=s"); }

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name Type Description
NrUe compound module

Models a User Equipment (UE) for a 5G/LTE network. It extends the LteUe module by implementing a NrNicUe as a Network Interface Card (NIC) module. This module can be used to model a device that can connect to either a 4G eNodeB or a 5G gNodeB, or both.

Parameters

Name Type Default value Description
displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
hasStatus bool false
hasEnvironment bool false
osgModel string ""

3D model for OSG visualization, no 3D model by default
osgModelColor string ""

Tint color, no colorization by default
canvasImage string ""

Image for canvas visualization, no image by default
canvasImageColor string ""

Tint color, no colorization by default
recordPcap bool false
numPcapRecorders int recordPcap ? 1 : 0
numLoInterfaces int 1
numWlanInterfaces int 0
numEthInterfaces int 0

Minimum number of Ethernet interfaces
numPppInterfaces int 0

Minimum number of PPP interfaces
numTunInterfaces int 0
numVirtInterfaces int 0
fcsMode string "declared"
hasIpv4 bool true
hasIpv6 bool false
hasGn bool false
forwarding bool false
multicastForwarding bool false
hasUdp bool firstAvailableOrEmpty("Udp") != ""
hasTcp bool firstAvailableOrEmpty("Tcp", "TcpLwip", "TcpNsc") != ""
hasSctp bool false
hasQuic bool false
numApps int 0
numUnstructuredApps int 0
nodeType string "UE"
servingNodeId int 0

The initial serving eNodeB of the UE; 0 if none
macNodeId int 1025+simu5g_seq("LteUe_macNodeId")
sessionType string "IPv4"

The type of the session the UE requests (see the main comment)
ethernetMode string "host"

Ethernet sessions only: the UE is an Ethernet host, or a bridge for the devices on its eth[] interfaces (see the main comment)
hasEthernetSession bool sessionType == "Ethernet"

Do not change: whether the UE has the Ethernet link layer (see the main comment)
hasD2D bool false
extHostAddress string ""
hasRniSupport bool false
nrServingNodeId int 0

The initial serving gNodeB of the UE; 0 if none
nrMacNodeId int 2049+simu5g_seq("NrUe_macNodeId")

Properties

Name Value Description
class NodeBase
networkNode
labels node
display i=device/car

Gates

Name Direction Size Description
radioIn [ ] input numWlanInterfaces
pppg [ ] inout numPppInterfaces
ethg [ ] inout numEthInterfaces
lteRadioIn input

Connection to master
nrRadioIn input

Connection to master

Unassigned submodule parameters

Name Type Default value Description
status.displayStringTextFormat string "{stateStr}"

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

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

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

Initialization stage for the setup command
environment.globalNamespace bool false

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

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

A host OS system command
environment.teardownCommand string ""

A host OS system command
pcapRecorder.displayStringTextFormat string "rec: %n pks"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
pcapRecorder.verbose bool true

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

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

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

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

Maximum number of bytes to record per packet
pcapRecorder.timePrecision int 6

Time precision in recorded file. pcap supports only 6 (usec) or 9 (nanosec), pcapng supports more values (see 'if_tsresol' option in pcapng file format).
pcapRecorder.dumpBadFrames bool true

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

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

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

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

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

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

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

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

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

Whether to display IP addresses on links
cb.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
cb.interfaceTableModule string

Module path to the InterfaceTable module
cb.forwardServiceRegistration bool true
cb.forwardProtocolRegistration bool true
cb.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
cb.serviceMapping object {}

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

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

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
bl.interfaceTableModule string

Module path to the InterfaceTable module
bl.forwardServiceRegistration bool true
bl.forwardProtocolRegistration bool true
bl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
bl.serviceMapping object {}

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

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

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
li.interfaceTableModule string

Module path to the InterfaceTable module
li.forwardServiceRegistration bool true
li.forwardProtocolRegistration bool true
li.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
li.serviceMapping object {}

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

Maps protocols to connected submodule names (e.g. {"ipv4": "bridging"}), overrides automatically learned dispatching; * overrides all learned protocols, ? overrides default
eth.bitrate double
nl.displayStringTextFormat string "processed {numProcessedPackets} pk ({processedTotalLength})"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
nl.interfaceTableModule string

Module path to the InterfaceTable module
nl.forwardServiceRegistration bool true
nl.forwardProtocolRegistration bool true
nl.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
nl.serviceMapping object {}

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

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

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
tn.interfaceTableModule string

Module path to the InterfaceTable module
tn.forwardServiceRegistration bool true
tn.forwardProtocolRegistration bool true
tn.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
tn.serviceMapping object {}

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

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

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
at.interfaceTableModule string

Module path to the InterfaceTable module
at.forwardServiceRegistration bool true
at.forwardProtocolRegistration bool true
at.interfaceMapping object {}

Maps network interface names to connected submodule names (e.g. {"eth0": "bridging"}), overrides automatically learned dispatching; * overrides all learned network interfaces, ? overrides default
at.serviceMapping object {}

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

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

Source code

//
// Defines a LteCar node as an NR User Equipment (UE) with vehicular-like
// mobility. The latter is modeled by utilizing the Veins-Inet project.
//
// See https://veins.car2x.org/documentation/modules/#veins_inet
//
module NrCar extends NrUe
{
    parameters:
        @display("i=device/car");

        //# Mobility
        mobility.typename = default("VeinsInetMobility");

        //# Network Layer specs
        *.routingTableModule = default(absPath(".ipv4.routingTable"));

        ipv4.configurator.typename = "HostAutoConfigurator";
        ipv4.configurator.interfaces = "cellular lo0";
}
File: src/simu5g/nodes/NrCar.ned

This documentation is released under the Creative Commons license