Package: simu5g.corenetwork.statsCollector

IStatsCollector

module interface

A module implementing this interface is a utility module that is accessed by the RNIService of a MECHost module to retrieve radio network information related to the parent e/gNodeB module. The RNIS accesses this module via direct method calls. For example, see BaseStationStatsCollector or UeStatsCollector.

Inheritance diagram

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

Implemented by

Name	Type	Description
BaseStationStatsCollector	compound module	This module collects the radio network information of an eNodeB, which can be accessed by the RNIService module of a MECHost. For example, this module provides information such as the utilization of Resource Blocks.
GNodeBStatsCollector	compound module	This module collects the radio network information from a 5G gNodeB, which can be accessed by the RNIService module of a MECHost. Currently, it exposes the same information as the BaseStationStatsCollector module.
NRueStatsCollector	compound module	This 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.
UeStatsCollector	compound module	This 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.

Used in compound modules

Name	Type	Description
eNodeB	compound module	This module models an evolved Node B (eNB) of a 4G LTE network. It is a specialized device equipped with a Network Interface Card (NIC) that enables communication with the Ue devices connected to it. It serves as an access point that routes packets between the UEs and the 4G Core Network. Packets arriving from the UEs are tunneled to the appropriate next hop in the core network (e.g., the PDN Gateway, PGW) using the GPRS Tunneling Protocol (GTP). Conversely, packets received from the core network are detunneled and sent to the appropriate destination UE. In addition to the 4G NIC, this compound module includes a configurable number of wired interfaces to connect with routers of the core network or directly to the PgwStandard module, which serves as the IP module to perform forwarding, and the GtpUser module that handles GTP (de)tunneling. The latter utilizes the TrafficFlowFilter module to classify incoming packets and determine the next hop. Furthermore, it features a configurable number of LteX2App modules to facilitate peer-to-peer communications with other eNodeBs within the same LTE network.

Parameters

Name	Type	Default value	Description
collectorType	string		it can be: "eNBStatsCollector, gNBStatsCollector, ueStatsCollector, NRueStatsCollector

Source code

//
// A module implementing this interface is a utility module that is accessed by
// the ~RNIService of a ~MECHost module to retrieve radio network information related
// to the parent e/gNodeB module. The RNIS accesses this module via direct method calls.
// For example, see ~BaseStationStatsCollector or ~UeStatsCollector.
//
moduleinterface IStatsCollector
{
    string collectorType; // it can be: "eNBStatsCollector, gNBStatsCollector, ueStatsCollector, NRueStatsCollector
}

File: src/corenetwork/statsCollector/IStatsCollector.ned