Package: simu5g.corenetwork.statsCollector

UeStatsCollector

compound module

Collects the radio network information of a LTE User Equipment (UE), which can be accessed by the RniService module of a MecHost. For example, this module provides information such as packet delay and discard rate.

Inheritance diagram

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

Used in compound modules

Name	Type	Description
LteUe	compound 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. The UE is an INET StandardHost with the cellular NIC as an additional network interface of its link layer, so it has all the higher layers of the protocol stack, from the link layer to the application modules, and the configuration options of StandardHost (numApps, hasUdp, hasTcp, hasIpv4, hasIpv6, numEthInterfaces, etc.). Its Ethernet interfaces (eth[]) are utilized in real-time emulation mode to connect the UE to the real network (outside the simulator) via a virtual Ethernet interface.

Known subclasses

Name	Type	Description
NrUeStatsCollector	compound module	Collects the radio network information of a NR UE, which can be accessed by the RniService module of a MecHost. Currently, it exposes the same functionalities as the UeStatsCollector.

Parameters

Name	Type	Default value	Description
collectorType	string	"ueStatsCollector"
binderModule	string	"binder"
interfaceTableModule	string
macModule	string	"^.cellularNic.mac"
packetFlowObserverModule	string	"^.cellularNic.packetFlowObserver"	string pdcpModule = default("^.cellularNic.pdcp");
movingAverage	bool	true
dataVolumePeriods	int	15	Time periods for measurements
delayPacketPeriods	int	10
discardRatePeriods	int	15
tPutPeriods	int	15
numberOfSamples	int	20

Properties

Name	Value	Description
display	i=block/cogwheel
class	UeStatsCollector

Source code

//
// Collects the radio network information of a LTE User Equipment (UE), which can
// be accessed by the ~RniService module of a ~MecHost. For example, this module
// provides information such as packet delay and discard rate.
//
//
module UeStatsCollector like IStatsCollector
{
    parameters:
        string collectorType = default("ueStatsCollector");
        string binderModule = default("binder");
        string interfaceTableModule;
        string macModule = default("^.cellularNic.mac");
        // string pdcpModule = default("^.cellularNic.pdcp");
        string packetFlowObserverModule = default("^.cellularNic.packetFlowObserver");
        bool movingAverage = default(true);

        // Time periods for measurements
        int dataVolumePeriods = default(15);
        int delayPacketPeriods = default(10);
        int discardRatePeriods = default(15);
        int tPutPeriods = default(15);

        int numberOfSamples = default(20);

        @display("i=block/cogwheel");
        @class("UeStatsCollector");
}

File: src/simu5g/corenetwork/statsCollector/UeStatsCollector.ned