PacketFlowManager: rename to PacketFlowObserver, updated docu

Author: avarga

src/simu5g/corenetwork/statsCollector/BaseStationStatsCollector.cc

@@ -11,7 +11,7 @@
 
 #include "simu5g/corenetwork/statsCollector/BaseStationStatsCollector.h"
 #include "simu5g/corenetwork/statsCollector/UeStatsCollector.h"
-#include "simu5g/stack/packetFlowManager/PacketFlowManagerEnb.h"
+#include "simu5g/stack/packetFlowObserver/PacketFlowObserverEnb.h"
 #include "simu5g/stack/mac/LteMacEnb.h"
 #include <string>
 
@@ -55,7 +55,7 @@ void BaseStationStatsCollector::initialize(int stage) {
             throw cRuntimeError("%s::initialize - eNodeB statistic collector only works with RLC in UM mode", collectorType_.c_str());
         }
 
-        packetFlowManager_.reference(this, "packetFlowManagerModule", true);
+        packetFlowObserver_.reference(this, "packetFlowObserverModule", true);
         cellInfo_.reference(this, "cellInfoModule", true);
 
         ecgi_.cellId = cellInfo_->getMacCellId(); // at least stage 2
@@ -85,11 +85,11 @@ void BaseStationStatsCollector::initialize(int stage) {
         tPutPeriod_ = par("tPutPeriod");
 
         // start scheduling the l2 measurement
-        // schedule only stats not using packetFlowManager
+        // schedule only stats not using packetFlowObserver
 
         scheduleAt(NOW + prbUsagePeriod_, prbUsage_);
         scheduleAt(NOW + activeUsersPeriod_, activeUsers_);
-        if (packetFlowManager_ != nullptr) {
+        if (packetFlowObserver_ != nullptr) {
             scheduleAt(NOW + dataVolumePeriod_, pdcpBytes_);
             scheduleAt(NOW + discardRatePeriod_, discardRate_);
             scheduleAt(NOW + delayPacketPeriod_, packetDelay_);
@@ -127,7 +127,7 @@ void BaseStationStatsCollector::handleMessage(cMessage *msg)
             add_ul_nongbr_pdr_cell_perUser();
 
             //reset counters
-            packetFlowManager_->resetDiscardCounter();
+            packetFlowObserver_->resetDiscardCounter();
             resetDiscardCounterPerUe();
             scheduleAt(NOW + discardRatePeriod_, discardRate_);
         }
@@ -159,15 +159,15 @@ void BaseStationStatsCollector::resetDiscardCounterPerUe()
 {
     EV << collectorType_ << "::resetDiscardCounterPerUe " << endl;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        packetFlowManager_->resetDiscardCounterPerUe(ueId);
+        packetFlowObserver_->resetDiscardCounterPerUe(ueId);
     }
 }
 
 void BaseStationStatsCollector::resetDelayCounterPerUe()
 {
     EV << collectorType_ << "::resetDelayCounterPerUe " << endl;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        packetFlowManager_->resetDelayCounterPerUe(ueId);
+        packetFlowObserver_->resetDelayCounterPerUe(ueId);
         ueCollector->resetDelayCounter();
     }
 }
@@ -176,15 +176,15 @@ void BaseStationStatsCollector::resetThroughputCountersPerUe()
 {
     EV << collectorType_ << "::resetThroughputCountersPerUe " << endl;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        packetFlowManager_->resetThroughputCounterPerUe(ueId);
+        packetFlowObserver_->resetThroughputCounterPerUe(ueId);
     }
 }
 
 void BaseStationStatsCollector::resetBytesCountersPerUe()
 {
     EV << collectorType_ << "::resetBytesCountersPerUe " << endl;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        packetFlowManager_->resetDataVolume(ueId);
+        packetFlowObserver_->resetDataVolume(ueId);
     }
 }
 
@@ -205,7 +205,7 @@ void BaseStationStatsCollector::removeUeCollector(MacNodeId id)
     if (it != ueCollectors_.end()) {
         ueCollectors_.erase(it);
         EV << "BaseStationStatsCollector::removeUeCollector - removing UE pfm stats for UE with id[" << id << "]" << endl;
-        packetFlowManager_->deleteUe(id);
+        packetFlowObserver_->deleteUe(id);
     }
     else {
         throw cRuntimeError("%s::removeUeCollector - UeStatsCollector not present for UE node id [%hu]", collectorType_.c_str(), num(id));
@@ -263,7 +263,7 @@ void BaseStationStatsCollector::add_number_of_active_ue_ul_nongbr_cell()
 
 void BaseStationStatsCollector::add_dl_nongbr_pdr_cell()
 {
-    double discard = packetFlowManager_->getDiscardedPkt();
+    double discard = packetFlowObserver_->getDiscardedPkt();
     dl_nongbr_pdr_cell.addValue((int)discard);
 }
 
@@ -295,7 +295,7 @@ void BaseStationStatsCollector::add_dl_nongbr_pdr_cell_perUser()
     EV << collectorType_ << "::add_dl_nongbr_pdr_cell_perUser()" << endl;
     double discard;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        discard = packetFlowManager_->getDiscardedPktPerUe(ueId);
+        discard = packetFlowObserver_->getDiscardedPktPerUe(ueId);
         ueCollector->add_dl_nongbr_pdr_ue((int)discard);
     }
 }
@@ -321,7 +321,7 @@ void BaseStationStatsCollector::add_dl_nongbr_delay_perUser()
     EV << collectorType_ << "::add_dl_nongbr_delay_perUser()" << endl;
     double delay;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        delay = packetFlowManager_->getDelayStatsPerUe(ueId);
+        delay = packetFlowObserver_->getDelayStatsPerUe(ueId);
         EV << collectorType_ << "::add_dl_nongbr_delay_perUser - delay: " << delay << " for node id: " << ueId << endl;
         if (delay != 0) {
             ueCollector->add_dl_nongbr_delay_ue((int)delay);
@@ -334,7 +334,7 @@ void BaseStationStatsCollector::add_ul_nongbr_data_volume_ue_perUser()
     EV << collectorType_ << "::add_ul_nongbr_data_volume_ue_perUser" << endl;
     unsigned int bytes;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        bytes = packetFlowManager_->getDataVolume(ueId, UL);
+        bytes = packetFlowObserver_->getDataVolume(ueId, UL);
         EV << collectorType_ << "::add_ul_nongbr_data_volume_ue_perUser - received: " << bytes << "B in UL from node id: " << ueId << endl;
         ueCollector->add_ul_nongbr_data_volume_ue(bytes);
     }
@@ -345,7 +345,7 @@ void BaseStationStatsCollector::add_dl_nongbr_data_volume_ue_perUser()
     EV << collectorType_ << "::add_dl_nongbr_data_volume_ue_perUser" << endl;
     unsigned int bytes;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        bytes = packetFlowManager_->getDataVolume(ueId, DL);
+        bytes = packetFlowObserver_->getDataVolume(ueId, DL);
         EV << collectorType_ << "::add_dl_nongbr_data_volume_ue_perUser - sent: " << bytes << "B in DL to node id: " << ueId << endl;
         ueCollector->add_dl_nongbr_data_volume_ue(bytes);
     }
@@ -356,9 +356,9 @@ void BaseStationStatsCollector::add_dl_nongbr_throughput_ue_perUser()
     EV << collectorType_ << "::add_dl_nongbr_throughput_ue_perUser" << endl;
     double throughput;
     for (auto const& [ueId, ueCollector] : ueCollectors_) {
-        throughput = packetFlowManager_->getThroughputStatsPerUe(ueId);
+        throughput = packetFlowObserver_->getThroughputStatsPerUe(ueId);
         EV << collectorType_ << "::add_dl_nongbr_throughput_ue_perUser - throughput: " << throughput << " for node " << ueId << endl;
-        packetFlowManager_->resetThroughputCounterPerUe(ueId);
+        packetFlowObserver_->resetThroughputCounterPerUe(ueId);
         if (throughput > 0.0)
             ueCollector->add_dl_nongbr_throughput_ue((int)throughput);
     }

src/simu5g/corenetwork/statsCollector/BaseStationStatsCollector.h

@@ -22,7 +22,7 @@
 #include "simu5g/stack/mac/LteMacEnb.h"
 #include "simu5g/stack/pdcp/LtePdcp.h"
 #include "simu5g/stack/rlc/um/LteRlcUm.h"
-#include "simu5g/stack/packetFlowManager/PacketFlowManagerEnb.h"
+#include "simu5g/stack/packetFlowObserver/PacketFlowObserverEnb.h"
 
 namespace simu5g {
 using namespace inet;
@@ -52,7 +52,7 @@ class BaseStationStatsCollector : public cSimpleModule
     inet::ModuleRefByPar<LtePdcpEnb> pdcp_;
     inet::ModuleRefByPar<LteMacEnb> mac_;
     inet::ModuleRefByPar<LteRlcUm> rlc_;
-    inet::ModuleRefByPar<PacketFlowManagerEnb> packetFlowManager_;
+    inet::ModuleRefByPar<PacketFlowObserverEnb> packetFlowObserver_;
 
     inet::ModuleRefByPar<CellInfo> cellInfo_;
 

src/simu5g/corenetwork/statsCollector/BaseStationStatsCollector.ned

@@ -25,7 +25,7 @@ module BaseStationStatsCollector like IStatsCollector
         string pdcpModule = default("^.cellularNic.pdcp");
         string cellInfoModule = default("^.cellinfo");
         string rlcUmModule = default("^.cellularNic.rlc.um");
-        string packetFlowManagerModule = default("^.cellularNic.packetFlowManager");
+        string packetFlowObserverModule = default("^.cellularNic.packetFlowObserver");
 
         bool movingAverage = default(false);
 

src/simu5g/corenetwork/statsCollector/NrUeStatsCollector.ned

@@ -20,5 +20,5 @@ module NrUeStatsCollector extends UeStatsCollector
 {
     parameters:
         collectorType = default("NrUeStatsCollector");
-        packetFlowManagerModule = default("^.cellularNic.nrPacketFlowManager");
+        packetFlowObserverModule = default("^.cellularNic.nrPacketFlowObserver");
 }

src/simu5g/corenetwork/statsCollector/UeStatsCollector.cc

@@ -14,7 +14,7 @@
 
 #include "simu5g/corenetwork/statsCollector/UeStatsCollector.h"
 #include "simu5g/stack/mac/LteMacBase.h"
-#include "simu5g/stack/packetFlowManager/PacketFlowManagerUe.h"
+#include "simu5g/stack/packetFlowObserver/PacketFlowObserverUe.h"
 #include "simu5g/stack/pdcp/LtePdcp.h"
 
 namespace simu5g {
@@ -34,15 +34,15 @@ void UeStatsCollector::initialize(int stage)
         associateId_.type = "1"; // UE_IPV4_ADDRESS
 
         /*
-         * Get packetFlowManager if present.
+         * Get packetFlowObserver if present.
          * When the UE has both Lte and NR NIC, two UeStatsCollector are created.
-         * So each of them has to get the correct reference of the packetFlowManager,
+         * So each of them has to get the correct reference of the packetFlowObserver,
          * since they are split, too.
          */
 
         bool isNr_ = (std::string(getContainingNicModule(mac_)->getComponentType()->getName()) == "NrNicUe");
 
-        packetFlowManager_.reference(this, "packetFlowManagerModule", isNr_);
+        packetFlowObserver_.reference(this, "packetFlowObserverModule", isNr_);
 
         handover_ = false;
 
@@ -63,14 +63,14 @@ void UeStatsCollector::initialize(int stage)
 
 void UeStatsCollector::resetDelayCounter()
 {
-    if (packetFlowManager_ != nullptr)
-        packetFlowManager_->resetDelayCounter();
+    if (packetFlowObserver_ != nullptr)
+        packetFlowObserver_->resetDelayCounter();
 }
 
 void UeStatsCollector::add_ul_nongbr_delay_ue()
 {
-    if (packetFlowManager_ != nullptr) {
-        double delay = packetFlowManager_->getDelayStats();
+    if (packetFlowObserver_ != nullptr) {
+        double delay = packetFlowObserver_->getDelayStats();
         if (delay != 0)
             EV << "UeStatsCollector::add_ul_nongbr_delay_ue() - delay: " << delay << endl;
         ul_nongbr_delay_ue.addValue((int)delay);
@@ -85,7 +85,7 @@ void UeStatsCollector::add_dl_nongbr_delay_ue(double value)
 
 void UeStatsCollector::add_ul_nongbr_pdr_ue()
 {
-    DiscardedPkts pair = packetFlowManager_->getDiscardedPkt();
+    DiscardedPkts pair = packetFlowObserver_->getDiscardedPkt();
     double rate = ((double)pair.discarded * 1000000) / pair.total;
     ul_nongbr_pdr_ue.addValue((int)rate);
 }
@@ -161,17 +161,17 @@ int UeStatsCollector::get_dl_nongbr_data_volume_ue()
 DiscardedPkts UeStatsCollector::getULDiscardedPkt()
 {
     DiscardedPkts pair = { 0, 0 };
-    if (packetFlowManager_ != nullptr) {
+    if (packetFlowObserver_ != nullptr) {
 
-        pair = packetFlowManager_->getDiscardedPkt();
+        pair = packetFlowObserver_->getDiscardedPkt();
         //double rate = ((double)pair.discarded * 1000000) / pair.total;
     }
     return pair;
 }
 
 void UeStatsCollector::resetStats()
 {
-    packetFlowManager_->clearStats();
+    packetFlowObserver_->clearStats();
     // packet delay
     ul_nongbr_delay_ue.reset();
     dl_nongbr_delay_ue.reset();

src/simu5g/corenetwork/statsCollector/UeStatsCollector.h

@@ -20,7 +20,7 @@
 #include <string>
 #include "simu5g/corenetwork/statsCollector/UeStatsCollector.h"
 #include "simu5g/stack/mac/LteMacBase.h"
-#include "simu5g/stack/packetFlowManager/PacketFlowManagerUe.h"
+#include "simu5g/stack/packetFlowObserver/PacketFlowObserverUe.h"
 // #include "simu5g/stack/pdcp/LtePdcp.h"
 
 namespace simu5g {
@@ -46,7 +46,7 @@ class UeStatsCollector : public cSimpleModule
 
     // LTE Nic layers
     inet::ModuleRefByPar<LteMacBase> mac_;
-    inet::ModuleRefByPar<PacketFlowManagerUe> packetFlowManager_;
+    inet::ModuleRefByPar<PacketFlowObserverUe> packetFlowObserver_;
 
     // packet delay
     L2MeasBase ul_nongbr_delay_ue;

src/simu5g/corenetwork/statsCollector/UeStatsCollector.ned

@@ -25,7 +25,7 @@ module UeStatsCollector like IStatsCollector
         string interfaceTableModule;
         string macModule = default("^.cellularNic.mac");
         // string pdcpModule = default("^.cellularNic.pdcp");
-        string packetFlowManagerModule = default("^.cellularNic.packetFlowManager");
+        string packetFlowObserverModule = default("^.cellularNic.packetFlowObserver");
         bool movingAverage = default(true);
 
         // time periods for measurements

src/simu5g/stack/LteNicBase.ned

@@ -15,7 +15,7 @@ package simu5g.stack;
 import inet.networklayer.common.NetworkInterface;
 import simu5g.stack.ip2nic.INetworkLayer2CellularNic;
 import simu5g.stack.mac.ILteMac;
-import simu5g.stack.packetFlowManager.IPacketFlowManager;
+import simu5g.stack.packetFlowObserver.IPacketFlowObserver;
 import simu5g.stack.pdcp.ILtePdcp;
 import simu5g.stack.phy.channelmodel.ILteChannelModel;
 import simu5g.stack.phy.ILtePhy;
@@ -80,7 +80,7 @@ module LteNicBase extends NetworkInterface like ICellularNic
             @display("p=362,226");
             d2dCapable = parent.d2dCapable;
             *.macModule = "^.^.mac";
-            *.packetFlowManagerModule = parent.hasRniSupport ? "^.^.packetFlowManager" : "";
+            *.packetFlowObserverModule = parent.hasRniSupport ? "^.^.packetFlowObserver" : "";
             um.nodeType = parent.nodeType;
         }
         // MAC Layer
@@ -99,7 +99,7 @@ module LteNicBase extends NetworkInterface like ICellularNic
          		//#
         //# Modules used to take trace of PDCP pkt flow
         //#
-        packetFlowManager: <default("")> like IPacketFlowManager if hasRniSupport {
+        packetFlowObserver: <default("")> like IPacketFlowObserver if hasRniSupport {
             @display("p=70,300");
         }
 

src/simu5g/stack/LteNicEnb.ned

@@ -32,7 +32,7 @@ module LteNicEnb extends LteNicBase
         pdcp.typename = default("LtePdcpEnb");
         mac.typename = default("LteMacEnb");
         phy.typename = default("LtePhyEnb");
-        packetFlowManager.typename = default("PacketFlowManagerEnb");
+        packetFlowObserver.typename = default("PacketFlowObserverEnb");
         d2dCapable = default(false);          // DO NOT CHANGE
         bool compEnabled = default(false);
         *.handoverManagerModule = "^.handoverManager";

src/simu5g/stack/LteNicEnbD2D.ned

@@ -27,7 +27,7 @@ module LteNicEnbD2D extends LteNicEnb
         pdcp.typename = default("LtePdcpEnbD2D");
         mac.typename = default("LteMacEnbD2D");
         phy.typename = default("LtePhyEnbD2D");
-        packetFlowManager.typename = default("PacketFlowManagerEnb");
+        packetFlowObserver.typename = default("PacketFlowObserverEnb");
         d2dCapable = default(true);   // DO NOT CHANGE
 
     submodules: