Package: simu5g.stack.d2d
LteNicEnbD2D
compound moduleThe LteNicEnbD2D module represents an LTE eNodeB network interface with support for D2D (Device-to-Device) communications. It extends the basic LteNicEnb module to manage D2D-capable UEs (User Equipments). A D2D mode selection algorithm can be specified via the rrc.d2dModeSelection submodule's typename.
The PDCP and RLC entities are missing from the submodules on purpose: the RRC layer's BearerManagement creates them per bearer at run time.
Inheritance diagram
The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.
Extends
| Name | Type | Description |
|---|---|---|
| LteNicEnb | compound module |
The LteNicEnb module is a network interface that provides LTE connectivity within an eNodeB. It implements the data and signaling planes of the LTE stack, which includes the PDCP, RLC, MAC, and PHY layers. The parameters and submodules allow customization of the eNodeB's behavior, including whether it supports D2D communication, CoMP (Coordinated MultiPoint), or dual connectivity. |
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| displayStringTextFormat | string | "%a (%i)\n%m" | |
| recordPcap | bool | false | |
| numPcapRecorders | int | recordPcap ? 1 : 0 | |
| isWireless | bool | true | |
| interfaceTableModule | string | ||
| routingTableModule | string | ||
| hasRniSupport | bool | false | |
| nodeType | string | ||
| processingDelayIn | double | 0s |
Additional processing delay for incoming ip packets |
| processingDelayOut | double | 0s |
Additional processing delay for outgoing ip packets |
| channelModelType | string | "D2dChannelModel" | |
| dualConnectivityEnabled | bool | false | |
| numCarriers | int | 1 | |
| address | string | "auto" | |
| compEnabled | bool | false |
Properties
| Name | Value | Description |
|---|---|---|
| networkInterface | ||
| lifecycleSupport | ||
| class | NonlayoutingNetworkInterface | |
| display | i=block/ifcard;bgb=800,650;bgl=3 |
Gates
| Name | Direction | Size | Description |
|---|---|---|---|
| upperLayerIn | input | ||
| upperLayerOut | output | ||
| radioIn | input |
To receive messages sent using sendDirect() |
|
| nrRadioIn | input |
For NR support |
|
| x2 [ ] | inout |
Optional X2 manager |
Signals
| Name | Type | Unit | Description |
|---|---|---|---|
| packetDropped | inet::Packet |
Statistics
| Name | Title | Source | Record | Unit | Interpolation Mode | Description |
|---|---|---|---|---|---|---|
| packetDropInterfaceDown | packet drops: interface down | packetDropReasonIsInterfaceDown(packetDropped) | count, sum(packetBytes), vector(packetBytes) | none | ||
| packetDropNoCarrier | packet drops: no carrier | packetDropReasonIsNoCarrier(packetDropped) | count, sum(packetBytes), vector(packetBytes) | none |
Unassigned submodule parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| pcapRecorder.verbose | bool | true |
whether to log packets on the module output |
| pcapRecorder.pcapFile | string | "" |
the PCAP file to be written |
| pcapRecorder.fileFormat | string | "pcapng" | |
| pcapRecorder.snaplen | int | 65535 |
maximum number of bytes to record per packet |
| pcapRecorder.dumpBadFrames | bool | true |
enable dump of frames with hasBitError |
| pcapRecorder.sendingSignalNames | string | "packetSentToLower" |
space-separated list of outbound packet signals to subscribe to |
| pcapRecorder.receivingSignalNames | string | "packetReceivedFromLower" |
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 |
| pcapRecorder.displayStringTextFormat | string | "rec: %n pks" | |
| ip2nic.isNr | bool | ||
| rlcMux.bearerManagementModule | string | ||
| packetFlowObserver.macModule | string | ||
| packetFlowObserver.pdcpModule | string | ||
| packetFlowObserver.rlcModule | string | ||
| packetFlowObserver.isNrObserver | bool | ||
| packetFlowObserver.pfmType | string | ||
| pdcpDcMux.binderModule | string | "binder" | |
| pdcpDcMux.bearerManagementModule | string | "^.rrc.bearerManagement" | |
| x2Manager.interfaceTableModule | string | ||
| x2Manager.binderModule | string | "binder" | |
| handoverX2Forwarder.losslessHandover | bool | false | |
| handoverX2Forwarder.handoverPacketHolderModule | string | "^.handoverPacketHolder" |
Source code
// // The LteNicEnbD2D module represents an LTE eNodeB network interface with // support for D2D (Device-to-Device) communications. It extends the basic // LteNicEnb module to manage D2D-capable UEs (User Equipments). A D2D mode // selection algorithm can be specified via the rrc.d2dModeSelection // submodule's typename. // // The PDCP and RLC entities are missing from the submodules on purpose: the RRC // layer's ~BearerManagement creates them per bearer at run time. // module LteNicEnbD2D extends LteNicEnb { parameters: mac.typename = default("LteMacEnbD2D"); phy.typename = default("PhyEnbD2D"); packetFlowObserver.typename = default("PacketFlowObserverEnb"); ip2nic.typename = default("Ip2NicD2D"); rlcMux.typename = default("RlcMuxD2D"); rrc.bearerManagement.lteRlcUmEntityModuleType = default("simu5g.stack.d2d.rlc.LteRlcUmEntityD2D"); // Use the D2D-capable channel model channelModelType = default("D2dChannelModel"); rrc.typename = default("RrcD2D"); rrc.hasD2DModeSelection = true; }File: src/simu5g/stack/d2d/LteNicEnbD2D.ned