This module implements a User Equipment (UE) for a 5G LTE network. It extends the Ue 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.

Usage diagram

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

Inheritance diagram

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

Used in

Name	Type	Description
ExtClientServer_bgCells	network	ExtClientServer_bgCells
ExtClientServerExample	network	ExtClientServerExample
ExtMecAppExample	network	(no description)
ExtServerExample	network	ExtServerExample
ExtUeAppExample	network	(no description)
ExtUeAppMecAppExample	network	(no description)

Extends

Name	Type	Description
Ue	compound module	This module models a User Equipment (UE) in a 4G LTE network. It is a host equipped with an LTE Network Interface Card (NIC), allowing the UE to connect to an eNodeB module via the Radio Access Network (RAN) of the LTE network and communicate with any other host in the system. In addition to a NIC submodule, this compound module includes all the higher layers of the protocol stack, from IP to application modules. It supports a configurable number of UDP and TCP applications. It also features an Ethernet interface, which is utilized in real-time emulation mode to connect the UE to the real network (outside the simulator) via a virtual Ethernet interface.

Parameters

Name	Type	Default value	Description
numApps	int	0
hasUdp	bool	firstAvailableOrEmpty("Udp") != ""
hasTcp	bool	firstAvailableOrEmpty("Tcp", "TcpLwip", "TcpNsc") != ""
hasSctp	bool	false
nodeType	string	"UE"
masterId	int
macNodeId	int	0	TODO: this is not a real parameter
macCellId	int	0	TODO: this is not a real parameter
hasIpv4	bool	true
hasIpv6	bool	false
numEthInterfaces	int	0
extHostAddress	string	""
numLoInterfaces	int	1
numPcapRecorders	int	0
hasRNISupport	bool	false
nrMasterId	int	0
nrMacNodeId	int	0	TODO: this is not a real parameter
nrMacCellId	int	0	TODO: this is not a real parameter

Properties

Name	Value	Description
networkNode
display	i=device/pocketpc;bgb=858,659

Gates

Name	Direction	Size	Description
radioIn	input		connection to master
nrRadioIn	input		connection to master

Unassigned submodule parameters

Name	Type	Default value	Description
interfaceTable.displayAddresses	bool	false	whether to display IP addresses on links
eth.bitrate	double
at.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
at.forwardServiceRegistration	bool	true
at.forwardProtocolRegistration	bool	true
tn.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
tn.forwardServiceRegistration	bool	true
tn.forwardProtocolRegistration	bool	true
nl.displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
nl.forwardServiceRegistration	bool	true
nl.forwardProtocolRegistration	bool	true
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.moduleNamePatterns	string	"wlan[*] eth[*] ppp[*]"	space-separated list of sibling module names to listen on
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"

Source code

//
// This module implements a User Equipment (UE) for a 5G LTE network. It extends the ~Ue 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.
//
module NRUe extends Ue
{
    parameters:
        cellularNic.typename = default("NRNicUe");

        int nrMasterId @mutable = default(0);
        int nrMacNodeId @mutable = default(0); // TODO: this is not a real parameter
        int nrMacCellId @mutable = default(0); // TODO: this is not a real parameter
        cellularNic.nrMac.collectorModule = hasRNISupport ? "^.^.NRueCollector" : "";
        cellularNic.nrPhy.hasCollector = hasRNISupport;

    gates:
        input nrRadioIn @directIn;     // connection to master

    submodules:
        //# UeStatsCollector - for MEC
        NRueCollector: NRueStatsCollector if hasRNISupport {
            @display("p=127,506;is=s");
        }

    connections allowunconnected:

        cellularNic.nrRadioIn <-- nrRadioIn;
}

File: src/nodes/NR/NRUe.ned

---

This documentation is released under the Creative Commons license