├── Cell.py
├── InterSliceSch.py
├── IntraSliceSch.py
├── LICENSE
├── LICENSE.md
├── README.md
├── Results.py
├── Scheds_Inter.py
├── Scheds_Intra.py
├── Slice.py
├── UE.py
├── doc
    ├── Py5cheSim.Cell.Cell.html
    ├── Py5cheSim.Cell.html
    ├── Py5cheSim.InterSliceSch.InterSliceScheduler.html
    ├── Py5cheSim.InterSliceSch.html
    ├── Py5cheSim.IntraSliceSch.Format.html
    ├── Py5cheSim.IntraSliceSch.IntraSliceScheduler.html
    ├── Py5cheSim.IntraSliceSch.LTE_scheduler.html
    ├── Py5cheSim.IntraSliceSch.TBqueue.html
    ├── Py5cheSim.IntraSliceSch.TransportBlock.html
    ├── Py5cheSim.IntraSliceSch.html
    ├── Py5cheSim.Results.UEgroup.html
    ├── Py5cheSim.Results.html
    ├── Py5cheSim.Scheds_Inter.PF_Scheduler.html
    ├── Py5cheSim.Scheds_Inter.RRplus_Scheduler.html
    ├── Py5cheSim.Scheds_Inter.html
    ├── Py5cheSim.Scheds_Intra.PF_Scheduler.html
    ├── Py5cheSim.Scheds_Intra.TBqueueTDD.html
    ├── Py5cheSim.Scheds_Intra.TDD_Scheduler.html
    ├── Py5cheSim.Scheds_Intra.html
    ├── Py5cheSim.Slice.Slice.html
    ├── Py5cheSim.Slice.html
    ├── Py5cheSim.UE.Bearer.html
    ├── Py5cheSim.UE.Format.html
    ├── Py5cheSim.UE.Packet.html
    ├── Py5cheSim.UE.PacketFlow.html
    ├── Py5cheSim.UE.PcktQueue.html
    ├── Py5cheSim.UE.RadioLink.html
    ├── Py5cheSim.UE.UE.html
    ├── Py5cheSim.UE.html
    ├── Py5cheSim.html
    ├── Py5cheSim.simulation.html
    ├── apidocs.css
    ├── bootstrap.min.css
    ├── classIndex.html
    ├── index.html
    ├── moduleIndex.html
    ├── nameIndex.html
    ├── objects.inv
    ├── pydoctor.js
    └── undoccedSummary.html
└── simulation.py


/Cell.py:
--------------------------------------------------------------------------------
  1 | """ This module contains the Cell class.
  2 | """
  3 | import os
  4 | import sys
  5 | import simpy #from SimPy.Simulation import * (simpy2.2)
  6 | from collections import deque
  7 | import math
  8 | import random
  9 | from Slice import *
 10 | from Scheds_Inter import *
 11 | 
 12 | # Cell Class: cell description
 13 | 
 14 | class Cell():
 15 |     """Cell class has cell relative parameters and collect kpi ststistics. """
 16 |     def __init__(self,i,b,fr,dm,mBue,tdd,gr,schInter):
 17 |         """This method creates a cell instance.
 18 | 
 19 |         It initialices cell parameters and interSliceScheduler according to the algorithm specified on the sch attribute."""
 20 |         self.id = i
 21 |         self.bw = b
 22 |         self.inactTimer = 3000
 23 |         self.tUdQueue = 0.05
 24 |         self.maxBuffUE = mBue
 25 |         """Maximum bearer buffer size by UE, in bytes"""
 26 |         self.sch = schInter
 27 |         if schInter[0:3] == 'RRp':
 28 |             self.interSliceSched = RRplus_Scheduler(self.bw,fr,dm,tdd,gr)
 29 |         elif schInter[0:2] == 'PF':
 30 |             self.interSliceSched = PF_Scheduler(self.bw,fr,dm,tdd,gr,schInter)
 31 |         elif schInter[0:2] == 'DT':
 32 |             self.interSliceSched = dynTDD_Scheduler(self.bw,fr,dm,tdd,gr)
 33 |         else:
 34 |             self.interSliceSched = InterSliceScheduler(self.bw,fr,dm,tdd,gr)
 35 |             self.sch = 'RR'
 36 |         self.slicesStsts = {}
 37 | 
 38 |     def updateStsts(self,env,interv,tSim): # ---------- PEM -------------
 39 |         """This method manages the statistics collection. This is a PEM Method.
 40 | 
 41 |         This method creates statistics files and stores counter values to calculate later the main kpi considered. \n
 42 |         Inter Slice statistics are stored in the dlStsts_InterSlice.txt file for DL and ulStsts_InterSlice.txt file for UL. \n
 43 |         Intra Slice statistics are stored in the dlStsts_<Slicename>Slice.txt file for DL and ulStsts_<Slicename>Slice.txt file for UL."""
 44 |         if not os.path.exists('Statistics'):
 45 |             os.mkdir('Statistics')
 46 |         for slice in list(self.interSliceSched.slices.keys()):
 47 |             self.slicesStsts[slice] = {}
 48 |             self.slicesStsts[slice]['DL'] = open('Statistics/dlStsts'+'_'+slice+'.txt','w')
 49 |             self.slicesStsts[slice]['DL'].write('time ue sinr MCS BLER ResourceUse sntPackets lstPackets rcvdBytes sliceLabel'+'\n')
 50 |             self.slicesStsts[slice]['UL'] = open('Statistics/ulStsts'+'_'+slice+'.txt','w')
 51 |             self.slicesStsts[slice]['UL'].write('time ue sinr MCS BLER ResourceUse sntPackets lstPackets rcvdBytes sliceLabel'+'\n')
 52 |         self.slicesStsts['InterSlice'] = {}
 53 |         self.slicesStsts['InterSlice']['DL'] = open('Statistics/dlStsts_InterSlice.txt','w')
 54 |         self.slicesStsts['InterSlice']['DL'].write('time Slice Connections ResourceUse sntPackets lstPackets rcvdBytes bufferSize'+'\n')
 55 |         self.slicesStsts['InterSlice']['UL'] = open('Statistics/ulStsts_InterSlice.txt','w')
 56 |         self.slicesStsts['InterSlice']['UL'].write('time Slice Connections ResourceUse sntPackets lstPackets rcvdBytes bufferSize'+'\n')
 57 | 
 58 |         while env.now<(tSim*0.83):
 59 |             yield env.timeout(interv)
 60 |             for slice in list(self.interSliceSched.slices.keys()):
 61 |                 conn_UEs = list(self.interSliceSched.slices[slice].schedulerDL.ues.keys())
 62 |                 res = self.interSliceSched.slices[slice].schedulerDL.nrbUEmax
 63 |                 lostP = 0
 64 |                 sentP = 0
 65 |                 recByts = 0
 66 |                 sliceRcvdBytes = 0 # interSlice PF scheduler
 67 |                 buf = 0
 68 |                 for ue in conn_UEs:
 69 |                     lP = self.interSliceSched.slices[slice].schedulerDL.ues[ue].packetFlows[0].lostPackets
 70 |                     sP = self.interSliceSched.slices[slice].schedulerDL.ues[ue].packetFlows[0].sentPackets
 71 |                     rB = self.interSliceSched.slices[slice].schedulerDL.ues[ue].packetFlows[0].rcvdBytes
 72 |                     sinr = self.interSliceSched.slices[slice].schedulerDL.ues[ue].radioLinks.linkQuality
 73 |                     mcs = self.interSliceSched.slices[slice].schedulerDL.ues[ue].MCS
 74 |                     bler = self.interSliceSched.slices[slice].schedulerDL.ues[ue].bler
 75 |                     resUse = self.interSliceSched.slices[slice].schedulerDL.ues[ue].resUse
 76 |                     buf = self.interSliceSched.slices[slice].schedulerDL.updSumPcks()
 77 |                     lostP = lostP + lP
 78 |                     sentP = sentP + sP
 79 |                     recByts = recByts + rB
 80 |                     self.slicesStsts[slice]['DL'].write(str(env.now)+' '+ue+' '+str(sinr)+' '+str(mcs)+' '+str(bler)+' '+str(resUse)+' '+str(sP)+' '+str(lP)+' '+str(rB)+' '+slice+'\n')
 81 |                 sliceRcvdBytes = sliceRcvdBytes + recByts # interSlice PF scheduler
 82 |                 pfSliceMetric = self.interSliceSched.slices[slice].metric
 83 |                 self.slicesStsts['InterSlice']['DL'].write(str(env.now)+' '+slice+' '+str(len(conn_UEs))+' '+str(res)+' '+ str(sentP)+' '+str(lostP)+' '+str(recByts)+' '+str(buf)+' '+str(pfSliceMetric)+'\n')
 84 | 
 85 |                 if slice != 'LTE':
 86 |                     conn_UEs = list(self.interSliceSched.slices[slice].schedulerUL.ues.keys())
 87 |                     res = self.interSliceSched.slices[slice].schedulerUL.nrbUEmax
 88 |                     lostP = 0
 89 |                     sentP = 0
 90 |                     recByts = 0
 91 |                     buf = 0
 92 |                     for ue in list(self.interSliceSched.slices[slice].schedulerUL.ues.keys()):
 93 |                         lP = self.interSliceSched.slices[slice].schedulerUL.ues[ue].packetFlows[0].lostPackets
 94 |                         sP = self.interSliceSched.slices[slice].schedulerUL.ues[ue].packetFlows[0].sentPackets
 95 |                         rB = self.interSliceSched.slices[slice].schedulerUL.ues[ue].packetFlows[0].rcvdBytes
 96 |                         sinr = self.interSliceSched.slices[slice].schedulerUL.ues[ue].radioLinks.linkQuality
 97 |                         mcs = self.interSliceSched.slices[slice].schedulerUL.ues[ue].MCS
 98 |                         bler = self.interSliceSched.slices[slice].schedulerUL.ues[ue].bler
 99 |                         resUse = self.interSliceSched.slices[slice].schedulerUL.ues[ue].resUse
100 |                         buf = self.interSliceSched.slices[slice].schedulerUL.updSumPcks()
101 |                         lostP = lostP + lP
102 |                         sentP = sentP + sP
103 |                         recByts = recByts + rB
104 |                         self.slicesStsts[slice]['UL'].write(str(env.now)+' '+ue+' '+str(sinr)+' '+str(mcs)+' '+str(bler)+' '+str(resUse)+' '+str(sP)+' '+str(lP)+' '+str(rB)+' '+slice+'\n')
105 |                     sliceRcvdBytes = sliceRcvdBytes + recByts # interSlice PF scheduler
106 |                     self.slicesStsts['InterSlice']['UL'].write(str(env.now)+' '+slice+' '+str(len(conn_UEs))+' '+str(res)+' '+ str(sentP)+' '+str(lostP)+' '+str(recByts)+' '+str(buf)+' '+str(pfSliceMetric)+'\n')
107 |                     if self.sch[0:2] == 'PF' and len(self.interSliceSched.slices[slice].rcvdBytes) >= self.interSliceSched.rcvdBytesLen:
108 |                         self.interSliceSched.slices[slice].rcvdBytes.popleft()
109 |                     self.interSliceSched.slices[slice].rcvdBytes.append(sliceRcvdBytes) # to consider the received bytes during the meassurement interval
110 | 
111 |             if env.now % (tSim/10) == 0:
112 |                 i=int(env.now/(tSim/10))
113 |                 print ("\r[%-10s] %d%%" % ('='*i, 10*i)+ ' complete simulation')
114 | 


--------------------------------------------------------------------------------
/InterSliceSch.py:
--------------------------------------------------------------------------------
 1 | """This module contains the basic Inter Slice Scheduler class.
 2 | All possible inter slice schedulers should inherit from this."""
 3 | import math
 4 | import os
 5 | from Slice import *
 6 | import random
 7 | 
 8 | class InterSliceScheduler():
 9 |     """ Basic inter slice scheduler. It implements Round Robin algorithm."""
10 |     def __init__(self,ba,fr,dm,tdd,gr):
11 |         self.bw = ba
12 |         self.FR = fr
13 |         self.nRBtable = {'FR1':{'15kHz':{'5MHz':25,'10MHz':52,'15MHz':79,'20MHz':106,'25MHz':133,'30MHz':160,'40MHz':216,'50MHz':270},
14 |         '30kHz':{'5MHz':11,'10MHz':24,'15MHz':38,'20MHz':51,'25MHz':65,'30MHz':78,'40MHz':106,'50MHz':133,'60MHz':162,'80MHz':217,'90MHz':245,'100MHz':273},
15 |         '60kHz':{'10MHz':11,'15MHz':18,'20MHz':24,'25MHz':31,'30MHz':38,'40MHz':51,'50MHz':65,'60MHz':79,'80MHz':107,'90MHz':121,'100MHz':135}},
16 |         'FR2':{'60kHz':{'50MHz':66,'100MHz':132,'200MHz':264},
17 |         '120kHz':{'50MHz':32,'100MHz':66,'200MHz':132,'400MHz':264}}} # TS 38.101 table 5.3.2-1
18 | 
19 |         self.PRBs = 0
20 |         for b in self.bw:
21 |             if fr == 'FR1':
22 |                 self.PRBs = self.PRBs + self.nRBtable[fr]['15kHz'][str(b)+'MHz']
23 |             else:
24 |                 self.PRBs = self.PRBs + self.nRBtable[fr]['60kHz'][str(b)+'MHz']
25 |         self.slices = {}
26 |         self.dm = dm
27 |         if not os.path.exists('Logs'):
28 |             os.mkdir('Logs')
29 |         self.dbFile = open('Logs/AllSlices_dbFile.html','w')
30 |         self.tdd = tdd
31 |         self.granularity = gr
32 | 
33 |     def resAlloc(self,env): #PEM ------------------------------------------------
34 |         """This method implements Round Robin PRB allocation between the different configured slices. This is a PEM method"""
35 |         while True:
36 |             self.dbFile.write('<h3> SUBFRAME NUMBER: '+str(env.now)+'</h3>')
37 |             if len(list(self.slices.keys()))>0:
38 |                 if len(list(self.slices.keys()))>1:
39 |                     for slice in list(self.slices.keys()):
40 |                         self.slices[slice].updateConfig(int((self.PRBs/len(list(self.slices.keys())))/self.slices[slice].numRefFactor))
41 |                         self.printSliceConfig(slice)
42 |                 else:
43 |                     slice = self.slices[list(self.slices.keys())[0]]
44 |                     prbs = 0
45 |                     for b in self.bw:
46 |                         prbs = prbs + self.nRBtable[self.FR][slice.scs][str(b)+'MHz']
47 |                     slice.updateConfig(prbs)
48 |                     #slice.updateConfig(1) # For 1PRB IoT test example! ################################################3
49 |             self.dbFile.write('<hr>')
50 |             yield env.timeout(self.granularity)
51 | 
52 |     def createSlice(self,dly,thDL,thUL,avl,cnxDL,cnxUL,ba,dm,mmd,ly,lbl,sch):
53 |         """This method creates a slice and stores it in the slices dictionary."""
54 |         self.slices[lbl] = Slice(dly,thDL,thUL,avl,cnxDL,cnxUL,ba,dm,mmd,ly,lbl,self.tdd,sch)
55 | 
56 | 
57 |     def printSliceConfig(self,slice):
58 |         """This method stores inter slice scheduling debugging information on the log file."""
59 |         if slice == 'LTE':
60 |             sliceCnx = len(list(self.slices[slice].schedulerDL.ues.keys()))
61 |             sliceBrBuffSz = self.slices[slice].schedulerDL.updSumPcks()
62 |             sliceRessources = self.slices[slice].schedulerDL.nrbUEmax
63 |             self.dbFile.write('<h5> Slice '+self.slices[slice].label+' data:</h5>')
64 |         else:
65 |             sliceCnx = max(len(list(self.slices[slice].schedulerDL.ues.keys())),len(list(self.slices[slice].schedulerUL.ues.keys())))
66 |             sliceBrBuffSz = max(self.slices[slice].schedulerDL.updSumPcks(),self.slices[slice].schedulerUL.updSumPcks())
67 |             sliceRessources = max(self.slices[slice].schedulerDL.nrbUEmax,self.slices[slice].schedulerUL.nrbUEmax)
68 |             self.dbFile.write('<h5> Slice '+self.slices[slice].label+' data:</h5>')
69 |             self.dbFile.write('DL/UL symbols: '+str(self.slices[slice].schedulerDL.TDDsmb)+'/'+str(self.slices[slice].schedulerUL.TDDsmb)+'<br>')
70 | 
71 |         self.dbFile.write('Connections: '+str(sliceCnx)+'<br>')
72 |         self.dbFile.write('Bearer Buffer Size (Packets): '+str(sliceBrBuffSz)+'<br>')
73 |         self.dbFile.write('Resources (PRBs): '+str(sliceRessources)+'<br>')
74 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Copyright 2021
2 |   Instituto de Ingenieria Electrica, Facultad de Ingenieria,
3 |   Universidad de la Republica, Uruguay.
4 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Py5cheSim
 2 | Py5cheSim is a flexible and open-source simulator based on Python and 
 3 | specially oriented to simulate cell capacity in 3GPP 5G networks and beyond. 
 4 | To the best of our knowledge, Py5cheSim is the first simulator that supports 
 5 | Network Slicing at the Radio Access Network (RAN), one of the main innovations of 5G. 
 6 | 
 7 | Py5cheSim was designed to simplify new schedulers implementation. 
 8 | The main network model abstractions are contained in the simulator Core, so there is no need to have deep knowledge on that field to run a simulation or to integrate a new scheduler. In this way Py5cheSim provides a framework for 5G new scheduler algorithms implementation in a straightforward and intuitive way.
 9 | 
10 | The tool used to implement Discrete Event Simulation was SimPy and code documentation was made using pydoctor.
11 | 
12 | Py5cheSim is build on the next modules:<br/>
13 | • UE.py: UE parameters and traffic generation.<br/>
14 | • Cell.py: Cell configuration and statistics management.<br/>
15 | • Slice.py: Slice configuration.<br/>
16 | • IntraSliceSch.py: Base intra slice scheduler implementation.<br/>
17 | • InterSliceSch.py: Base inter slice scheduler implementation.<br/>
18 | • Scheds Intra.py: Other intra slice schedulers implementation.<br/>
19 | • Scheds Inter.py: Other inter slice schedulers implementation.<br/>
20 | • simulation.py: Is the simulation script. It configures and runs a simulation.<br/>
21 | • Results.py: Provides auxiliary methods to present simulation results, and configure traffic profiles.<br/>
22 | 
23 | Py5cheSim 1.0 is the result of the Master Thesis of Gabriela Pereyra (Facultad de Ingeniería, UdelaR).
24 | Thesis: Pereyra, G. (2021.). Scheduling in 5G networks : Developing a 5G cell capacity simulator. Tesis de maestría. Universidad de la República (Uruguay). Facultad de Ingeniería.
25 | Article: https://hdl.handle.net/20.500.12008/30549
26 | 
27 | Code Documentation: https://htmlpreview.github.io/?https://github.com/ClaudinaRattaro/Py5cheSim/blob/main/doc/Py5cheSim.html
28 | 
29 | 
30 | In https://github.com/linglesloggia/py5chesim is the improved version of the simulator (version 2 )
31 | it is related to article: https://www.colibri.udelar.edu.uy/jspui/bitstream/20.500.12008/31723/1/PIRB22.pdf
32 | 
33 | In https://github.com/charluy/PFC we have integrated the framework deepmimo (https://deepmimo.net/) as an input of py5chesim (improving the channel model and mimo feature)
34 | 


--------------------------------------------------------------------------------
/Scheds_Inter.py:
--------------------------------------------------------------------------------
  1 | """This module contains different implemented inter slice schedulers.
  2 | New schedulers should be implemented here following the current structure."""
  3 | import math
  4 | from InterSliceSch import InterSliceScheduler
  5 | from Slice import *
  6 | import random
  7 | 
  8 | class RRplus_Scheduler(InterSliceScheduler):
  9 |     """This class implements Round Robin Plus inter slice scheduling algorithm."""
 10 |     def __init__(self,ba,fr,dm,tdd,gr):
 11 |         InterSliceScheduler.__init__(self,ba,fr,dm,tdd,gr)
 12 | 
 13 |     def resAlloc(self,env): #PEM ------------------------------------------------
 14 |         """This method implements Round Robin Plus PRB allocation between the different configured slices.
 15 |         This PEM method overwrites the resAlloc method from InterSliceScheduler class.
 16 | 
 17 |         Round Robin Plus scheduler allocates the same amount of resources to each slice with packets in buffer. """
 18 |         while True:
 19 |             self.dbFile.write('<h3> SUBFRAME NUMBER: '+str(env.now)+'</h3>')
 20 |             if len(list(self.slices.keys()))>0:
 21 |                 if len(list(self.slices.keys()))>1:
 22 |                     slicesWithPacks = 0
 23 |                     for slice in list(self.slices.keys()):
 24 |                         sliceHasPackets = self.slices[slice].schedulerDL.updSumPcks()>0 or self.slices[slice].schedulerUL.updSumPcks()>0
 25 |                         if sliceHasPackets:
 26 |                             slicesWithPacks = slicesWithPacks + 1
 27 |                     if slicesWithPacks == 0:
 28 |                         for slice in list(self.slices.keys()):
 29 |                             self.slices[slice].updateConfig(int((self.PRBs/len(list(self.slices.keys())))/self.slices[slice].numRefFactor))
 30 |                             self.printSliceConfig(slice)
 31 |                     else:
 32 |                         for slice in list(self.slices.keys()):
 33 |                             sliceHasPackets = self.slices[slice].schedulerDL.updSumPcks()>0 or self.slices[slice].schedulerUL.updSumPcks()>0
 34 |                             if not sliceHasPackets:
 35 |                                 self.slices[slice].updateConfig(0)
 36 |                             else:
 37 |                                 self.slices[slice].updateConfig(int((self.PRBs/slicesWithPacks)/self.slices[slice].numRefFactor))
 38 |                             self.printSliceConfig(slice)
 39 |                 else:
 40 |                     slice = self.slices[list(self.slices.keys())[0]]
 41 |                     prbs = 0
 42 |                     for b in self.bw:
 43 |                         prbs = prbs + self.nRBtable[self.FR][slice.scs][str(b)+'MHz']
 44 |                     slice.updateConfig(prbs)
 45 |             self.dbFile.write('<hr>')
 46 |             yield env.timeout(self.granularity)
 47 | 
 48 | 
 49 | class PF_Scheduler(InterSliceScheduler):
 50 |     """This class implements Proportional Fair inter slice scheduling algorithm."""
 51 |     def __init__(self,ba,fr,dm,tdd,gr,sch):
 52 |         InterSliceScheduler.__init__(self,ba,fr,dm,tdd,gr)
 53 |         self.sch = sch
 54 |         """String formatted as PFXY, with X=numerator exponent for metric formula, and Y=denominator exponent. """
 55 |         self.rcvdBytesLen = 10
 56 |         """rcvdBytes list length in Slice instance. No more that rcvdBytesLen values are stored."""
 57 | 
 58 |     def resAlloc(self,env): #PEM ------------------------------------------------
 59 |         """This method implements Proportional Fair resource allocation between the different configured slices.
 60 |         This PEM method overwrites the resAlloc method from InterSliceScheduler class.
 61 | 
 62 |         Proportional Fair scheduler allocates all PRBs in the cell to the slice with the biggest metric.
 63 |         Metric for each slice is calculated as PossibleAverageUEtbs/ReceivedBytes."""
 64 |         while True:
 65 |             self.dbFile.write('<h3> SUBFRAME NUMBER: '+str(env.now)+'</h3>')
 66 |             if len(list(self.slices.keys()))>0:
 67 |                 if len(list(self.slices.keys()))>1:
 68 |                     if env.now>0:
 69 |                         self.setMetric(float(self.sch[2]),float(self.sch[3]))
 70 |                         maxMetSlice = self.findMaxMetSlice()
 71 |                         self.assign2aSlice(maxMetSlice)
 72 |                         self.printSliceConfig(maxMetSlice)
 73 |                     else:
 74 |                         initialSlice = random.choice(list(self.slices.keys()))
 75 |                         self.assign2aSlice(initialSlice)
 76 |                         self.printSliceConfig(initialSlice)
 77 |                 else:
 78 |                     slice = self.slices[list(self.slices.keys())[0]]
 79 |                     prbs = 0
 80 |                     for b in self.bw:
 81 |                         prbs = prbs + self.nRBtable[self.FR][slice.scs][str(b)+'MHz']
 82 |                     slice.updateConfig(prbs)
 83 |                     self.printSliceConfig(slice.label)
 84 |             self.dbFile.write('<hr>')
 85 |             yield env.timeout(self.granularity)
 86 | 
 87 |     def setMetric(self,exp_n,exp_d):
 88 |         """This method sets the PF metric for each slice"""
 89 |         if len(list(self.slices.keys()))>0:
 90 |             for slice in list(self.slices.keys()):
 91 |                 rcvdBt_end = self.slices[slice].rcvdBytes[len(self.slices[slice].rcvdBytes)-1]
 92 |                 rcvdBt_in = self.slices[slice].rcvdBytes[0]
 93 |                 if rcvdBt_end - rcvdBt_in == 0:
 94 |                     den = 1
 95 |                 else:
 96 |                     den = rcvdBt_end - rcvdBt_in
 97 |                 num = 0
 98 |                 for ue in list(self.slices[slice].schedulerDL.ues.keys()):
 99 |                     [tbs, mod, bi, mcs] = self.slices[slice].schedulerDL.setMod(ue,self.PRBs)
100 |                     num = num + tbs
101 |                 for ue in list(self.slices[slice].schedulerUL.ues.keys()):
102 |                     [tbs, mod, bi, mcs] = self.slices[slice].schedulerUL.setMod(ue,self.PRBs)
103 |                     num = num + tbs
104 |                 num = num/(len(list(self.slices[slice].schedulerDL.ues.keys()))+len(list(self.slices[slice].schedulerUL.ues.keys())))
105 |                 self.slices[slice].metric = math.pow(float(num), exp_n)/math.pow(den,exp_d)
106 | 
107 |     def findMaxMetSlice(self):
108 |         """This method finds and returns the Slice with the highest metric"""
109 |         metric = 0
110 |         for slice in list(self.slices.keys()):
111 |             if self.slices[slice].metric > metric:
112 |                 metric = self.slices[slice].metric
113 |                 maxSliceM = slice
114 |             if self.slices[slice].metric == metric:
115 |                 slicesMlist = [maxSliceM,slice]
116 |                 maxSliceM = random.choice(slicesMlist)
117 |         return maxSliceM
118 | 
119 |     def assign2aSlice(self,slice):
120 |         """This method allocates cell's PRBs to the indicated slice"""
121 |         for sl in list(self.slices.keys()):
122 |             if sl == slice:
123 |                 self.slices[sl].updateConfig(int(self.PRBs/self.slices[sl].numRefFactor))
124 |             else:
125 |                 self.slices[sl].updateConfig(0)
126 | 
127 |     def printSliceConfig(self,slice):
128 |         """This method stores inter slice scheduling debugging information on the log file, adding PF metric values."""
129 |         super().printSliceConfig(slice)
130 |         for s in list(self.slices.keys()):
131 |             self.dbFile.write('Slice: '+str(s)+' -> PF Metric: '+str(self.slices[s].metric)+'<br>')
132 | 


--------------------------------------------------------------------------------
/Scheds_Intra.py:
--------------------------------------------------------------------------------
  1 | """This module contains different implemented intra slice schedulers.
  2 | New schedulers should be implemented here following the current structure."""
  3 | 
  4 | import math
  5 | from IntraSliceSch import IntraSliceScheduler, Format
  6 | from collections import deque
  7 | 
  8 | class PF_Scheduler(IntraSliceScheduler): # PF Sched ---------
  9 |     """This class implements Proportional Fair intra slice scheduling algorithm."""
 10 |     def __init__(self,ba,n,debMd,sLod,ttiByms,mmd_,ly_,dir,Smb,robustMCS,slcLbl,sch):
 11 |         IntraSliceScheduler.__init__(self,ba,n,debMd,sLod,ttiByms,mmd_,ly_,dir,Smb,robustMCS,slcLbl,sch)
 12 |         self.promLen = 30
 13 |         """Past Throughput average length considered in PF metric"""
 14 |     def resAlloc(self,band):
 15 |         """This method implements Proportional Fair resource allocation between the different connected UEs.
 16 |         This method overwrites the resAlloc method from IntraSliceScheduler class.
 17 | 
 18 |         Proportional Fair scheduler allocates all PRBs in the slice to the UE with the biggest metric.
 19 |         Metric for each UE is calculated as PossibleUEtbs/AveragePastTbs."""
 20 |         schd = self.schType[0:2]
 21 |         if schd=='PF' and len(list(self.ues.keys()))>0:
 22 |             exp_num = float(self.schType[2])
 23 |             exp_den = float(self.schType[3])
 24 |             self.setUEfactor(exp_num, exp_den)
 25 |             maxInd = self.findMaxFactor()
 26 |             for ue in list(self.ues.keys()):
 27 |                 if ue == maxInd:
 28 |                     self.ues[ue].prbs = band
 29 |                 else:
 30 |                     self.ues[ue].prbs = 0
 31 |                     if len(self.ues[ue].pastTbsz)>self.promLen:
 32 |                         self.ues[ue].pastTbsz.popleft()
 33 |                     self.ues[ue].pastTbsz.append(self.ues[ue].tbsz)
 34 |                     self.ues[ue].tbsz = 1
 35 |         # Print Resource Allocation
 36 |         self.printResAlloc()
 37 | 
 38 |     def setUEfactor(self, exp_n, exp_d):
 39 |         """This method sets the PF metric for each UE"""
 40 |         for ue in list(self.ues.keys()):
 41 |             sumTBS = 0
 42 |             for t in self.ues[ue].pastTbsz:
 43 |                 sumTBS = sumTBS + t
 44 |             actual_den = sumTBS/len(self.ues[ue].pastTbsz)
 45 |             [tbs, mod, bi, mcs] = self.setMod(ue,self.nrbUEmax)
 46 |             self.ues[ue].pfFactor = math.pow(float(tbs), exp_n)/math.pow(actual_den,exp_d)
 47 |             self.ues[ue].lastDen = actual_den
 48 |             self.ues[ue].num = tbs
 49 | 
 50 |     def findMaxFactor(self):
 51 |         """This method finds and returns the UE with the highest metric"""
 52 |         factorMax = 0
 53 |         factorMaxInd = ''
 54 |         for ue in list(self.ues.keys()):
 55 |             if len(self.ues[ue].bearers[0].buffer.pckts)>0 and self.ues[ue].pfFactor>factorMax:
 56 |                 factorMax = self.ues[ue].pfFactor
 57 |                 factorMaxInd = ue
 58 |         if factorMaxInd=='':
 59 |             ue = list(self.ues.keys())[self.ind_u]
 60 |             q = 0
 61 |             while len(self.ues[ue].bearers[0].buffer.pckts)==0 and q<len(self.ues):
 62 |                 self.updIndUE()
 63 |                 ue = list(self.ues.keys())[self.ind_u]
 64 |                 q = q + 1
 65 |             factorMaxInd = ue
 66 | 
 67 |         return factorMaxInd
 68 | 
 69 |     def printResAlloc(self):
 70 |         if self.dbMd:
 71 |             self.printDebData('+++++++++++ Res Alloc +++++++++++++'+'<br>')
 72 |             self.printDebData('PRBs: '+str(self.nrbUEmax)+'<br>')
 73 |             resAllocMsg = ''
 74 |             for ue in list(self.ues.keys()):
 75 |                 resAllocMsg = resAllocMsg + ue +' '+ str(self.ues[ue].pfFactor)+' '+str(self.ues[ue].prbs)+ ' '+str(self.ues[ue].num)+' '+ str(self.ues[ue].lastDen)+'<br>'
 76 |             self.printDebData(resAllocMsg)
 77 |             self.printDebData('+++++++++++++++++++++++++++++++++++'+'<br>')
 78 | 
 79 | class TDD_Scheduler(IntraSliceScheduler): # TDD Sched ---------
 80 |     """This class implements TDD intra slice scheduling."""
 81 |     def __init__(self,ba,n,debMd,sLod,ttiByms,mmd_,ly_,dir,Smb,robustMCS,slcLbl,sch):
 82 |         IntraSliceScheduler.__init__(self,ba,n,debMd,sLod,ttiByms,mmd_,ly_,dir,Smb,robustMCS,slcLbl,sch)
 83 |         self.symMax = Smb
 84 |         self.queue = TBqueueTDD(self.symMax)
 85 |         """TDD scheduler TB queue.
 86 | 
 87 |         IntraSliceScheduler class attribute queue is overwriten here by a new type of queue
 88 |         which handles symbols. This queue will contain as much TB as a slot can contain. If resource allocation is made
 89 |         in terms of slots, it will contain 1 element, else, it will contain as much mini-slots as can be supported in 1 slot."""
 90 | 
 91 |     def resAlloc(self,band):
 92 |         """This method implements resource allocation between the different connected UEs in a TDD slice.
 93 | 
 94 |         It overwrites the resAlloc method from IntraSliceScheduler class.
 95 |         In this Py5cheSim version TDD scheduler allocates all PRBs in the slice to a UE during 1 slot.
 96 |         Future Py5cheSim versions could support mini-slot allocation by changing the UE symbol allocation in this method.
 97 |         Note that in that case, althoug there is no need to update the queueUpdate method,
 98 |         TBS calculation must be adjusted to avoid losing capacity when trunking the Nre__ value."""
 99 | 
100 |         if len(list(self.ues.keys()))>0:
101 |             for ue in list(self.ues.keys()):
102 |                 self.ues[ue].prbs = band
103 |                 self.ues[ue].symb = self.TDDsmb
104 |         # Print Resource Allocation
105 |         self.printResAlloc()
106 | 
107 |     def queueUpdate(self):
108 |         """This method fills scheduler TB queue at each TTI with TBs built with UE data/signalling bytes.
109 | 
110 |         It overwrites queueUpdate method from IntraSliceScheduler class, making Resource allocation in terms of slot Symbols
111 |         and insert generated TBs into Scheduler queue in a TTI. Althoug in this version Resource allocation is made by slot,
112 |         it is prepared to support mini-slot resource allocation by handling a scheduler TB queue in terms of symbols."""
113 |         packts = 1
114 |         self.ueLst = list(self.ues.keys())
115 |         self.resAlloc(self.nrbUEmax)
116 |         sym = 0
117 |         if self.nrbUEmax == 0:
118 |             self.sm_lim = 0
119 |         else:
120 |             if self.mimomd == 'MU':
121 |                 self.sm_lim = self.symMax*self.nlayers
122 |             else:
123 |                 self.sm_lim = self.symMax
124 | 
125 |         while len(self.ueLst)>0 and packts>0 and sym < self.sm_lim:
126 |             ue = self.ueLst[self.ind_u]
127 |             self.printDebDataDM('---------------- '+ue+' ------------------<br>') # print more info in debbug mode
128 |             if self.ues[ue].symb>0:
129 |                 if len(self.ues[ue].bearers)>0 and sym < self.sm_lim:
130 |                     if len(self.ues[ue].pendingTB)==0: # No TB to reTX
131 |                         sym = sym + self.rrcUncstSigIn(ue)
132 |                         if sym < self.sm_lim and len(self.ues[ue].bearers[0].buffer.pckts)>0:
133 |                             sym = sym + self.dataPtoTB(ue)
134 |                     else: # There are TB to reTX
135 |                         self.printPendTB()
136 |                         sym = sym + self.retransmitTB(ue)
137 |                     if self.dbMd:
138 |                         self.printQtb() # Print TB queue in debbug mode
139 |             self.updIndUE()
140 |             packts = self.updSumPcks()
141 | 
142 |     def rrcUncstSigIn(self,u):
143 |         ueN = int(self.ues[u].id[2:])
144 |         sfSig = int(float(1)/self.sLoad)
145 |         rrcUESigCond = (self.sbFrNum-ueN)%sfSig == 0
146 |         if rrcUESigCond:
147 |             p_l = []
148 |             p_l.append(self.ues[u].packetFlows[0].pId)
149 |             self.ues[u].packetFlows[0].pId = self.ues[u].packetFlows[0].pId + 1
150 |             ins = self.insertTB(self.ues[u].TBid,'4-QAM',u,'Sig',p_l,self.ues[u].prbs,19)
151 |             r = self.symMax
152 |         else:
153 |             r = 0
154 |         return r
155 | 
156 |     def retransmitTB(self,u):
157 |         pendingTbl = self.ues[u].pendingTB[0]
158 |         if pendingTbl.reTxNum < 3000: # TB retransmission
159 |             intd = self.queue.insertTB(pendingTbl)
160 |             self.ues[u].pendingTB.pop(0)
161 |             pendingTbl.reTxNum = pendingTbl.reTxNum + 1
162 |             r = self.symMax
163 |         else:
164 |             self.ues[u].pendingTB.pop(0) # Drop!!!
165 |             r = 0
166 |         return r
167 | 
168 |     def dataPtoTB(self,u):
169 |         """This method takes UE data bytes, builds TB and puts them in the scheduler TB queue.
170 | 
171 |         It overwrites dataPtoTB method from IntraSliceScheduler class. In this case it returns
172 |         the amount of allocated symbols to the UE."""
173 |         n = self.ues[u].prbs
174 |         [tbSbits,mod,bits,mcs__] = self.setMod(u,n)
175 |         if self.schType[0:2]=='PF':
176 |             if len(self.ues[u].pastTbsz)>self.promLen:
177 |                 self.ues[u].pastTbsz.popleft()
178 |             self.ues[u].pastTbsz.append(self.ues[u].tbsz)
179 | 
180 |         self.ues[u].tbsz = tbSbits
181 |         self.ues[u].MCS = mcs__
182 |         self.setBLER(u)
183 |         tbSize = int(float(tbSbits)/8) # TB size in bytes
184 |         self.printDebDataDM('TBs: '+str(tbSize)+' nrb: '+str(n)+' FreeSp: '+str(self.queue.getFreeSpace())+'<br>')
185 |         pks_s = 0
186 |         list_p = []
187 |         while pks_s<tbSize and len(self.ues[u].bearers[0].buffer.pckts)>0:
188 |             pacD = self.ues[u].bearers[0].buffer.removePckt()
189 |             pks_s = pks_s + pacD.size
190 |             list_p.append(pacD.secNum)
191 | 
192 |         insrt = self.insertTB(self.ues[u].TBid,mod,u,'data',list_p,n,min(int(pks_s),tbSize))
193 |         if (pks_s - tbSize)>0:
194 |             pacD.size = pks_s - tbSize
195 |             self.ues[u].bearers[0].buffer.insertPcktLeft(pacD)
196 |         return self.ues[u].symb
197 | 
198 |     def setTBS(self,r,qm,uldl,u_,fr,nprb): # TS 38.214 procedure
199 |         OHtable = {'DL':{'FR1':0.14,'FR2':0.18},'UL':{'FR1':0.08,'FR2':0.10}}
200 |         OH = OHtable[uldl][fr]
201 |         Nre__ = min(156,math.floor(12*self.ues[u_].symb*(1-OH)))
202 |         if self.mimomd == 'SU':
203 |             Ninfo = Nre__*nprb*r*qm*self.nlayers
204 |             tbs = Ninfo
205 |         else:
206 |             Ninfo = Nre__*nprb*r*qm
207 |             tbs = Ninfo
208 |         return tbs
209 | 
210 |     def printResAlloc(self):
211 |         if self.dbMd:
212 |             self.printDebData('+++++++++++ Res Alloc +++++++++++++'+'<br>')
213 |             self.printDebData('PRBs: '+str(self.nrbUEmax)+'<br>')
214 |             resAllocMsg = ''
215 |             for ue in list(self.ues.keys()):
216 |                 resAllocMsg = resAllocMsg + ue +': '+ str(self.ues[ue].symb)+' symbols'+'<br>'
217 |             self.printDebData(resAllocMsg)
218 |             self.printDebData('+++++++++++++++++++++++++++++++++++'+'<br>')
219 | 
220 | class TBqueueTDD: # TB queue!!!
221 |     """This class is used to model scheduler TB queue in TDD scheduler."""
222 |     def __init__(self,symb):
223 |         self.res = deque([])
224 |         self.numRes = symb
225 | 
226 |     def getFreeSpace(self):
227 |         freeSpace = self.numRes
228 |         if len(self.res)>0:
229 |             for tbl in self.res:
230 |                 freeSpace = freeSpace - 1
231 |         return freeSpace
232 | 
233 |     def insertTB(self,tb):
234 |         succ = False
235 |         freeSpace = self.getFreeSpace()
236 |         if freeSpace>=1:
237 |             self.res.append(tb) # The TB fits the free space
238 |             succ = True
239 |         else:
240 |             succ = False
241 |             print (Format.CRED+'Not enough space!!! : '+str(freeSpace)+'/'+str(tb.numRB)+Format.CEND)
242 |         return succ
243 | 
244 |     def removeTB(self):
245 |         if len(self.res)>0:
246 |             return self.res.popleft()
247 | 
248 |     def updateSize(self,newSize):
249 |         self.numRes = newSize
250 | 


--------------------------------------------------------------------------------
/Slice.py:
--------------------------------------------------------------------------------
  1 | """This module contains the Slice class.
  2 | """
  3 | from IntraSliceSch import IntraSliceScheduler, LTE_scheduler
  4 | from Scheds_Intra import *
  5 | from collections import deque
  6 | 
  7 | class Slice:
  8 |     """This class has Slice relative parameters and is used to implement the mapping between service requirements and slice configuration."""
  9 |     def __init__(self,dly,thDL,thUL,avl,cnxDL,cnxUL,ba,dm,mmd,ly,lbl,tdd,sch):
 10 |         self.reqDelay = dly
 11 |         self.reqThroughputDL = thDL
 12 |         self.reqThroughputUL = thUL
 13 |         self.reqAvailability = avl
 14 |         self.reqDLconnections = cnxDL
 15 |         self.reqULconnections = cnxUL
 16 | 
 17 |         self.band = ba
 18 |         self.PRBs = 0
 19 |         self.signLoad = 0.000001
 20 |         self.scs = '15kHz'
 21 |         self.ttiBms = 1
 22 |         self.robustMCS = False
 23 |         self.mimoMd = mmd
 24 |         self.layers = ly
 25 |         self.tddSymb = 14
 26 |         self.schType = sch
 27 |         self.label = lbl
 28 |         self.tdd = tdd
 29 |         self.dm = dm
 30 |         self.rcvdBytes = deque([0]) # interSlice PF scheduler
 31 |         self.metric = 0 # interSlice PF scheduler
 32 |         self.setInitialConfig()
 33 |         self.schedulerDL = self.createSliceSched('DL',self.tddSymb)
 34 |         if self.label != 'LTE':
 35 |             self.schedulerUL = self.createSliceSched('UL',14-self.tddSymb)
 36 | 
 37 |     def createSliceSched(self,dir,tddSymb):
 38 |         """This method initializes and returns slice UL or DL scheduler. Scheduler algorithm is selected according to the Slice attribute schType."""
 39 |         if self.tdd:
 40 |             if self.schType[0:2] == 'PF':
 41 |                 scheduler = PF_Scheduler(self.band,self.PRBs,self.dm,self.signLoad,self.ttiBms,self.mimoMd,self.layers,dir,tddSymb,self.robustMCS,self.label,self.schType)
 42 |             else:
 43 |                 scheduler = TDD_Scheduler(self.band,self.PRBs,self.dm,self.signLoad,self.ttiBms,self.mimoMd,self.layers,dir,tddSymb,self.robustMCS,self.label,self.schType)
 44 |         else: # FDD Schedulers
 45 |             if self.label == 'LTE':
 46 |                     scheduler = LTE_scheduler(self.band,self.PRBs,self.dm,self.signLoad,self.mimoMd,self.layers,dir)
 47 |             elif self.schType[0:2] == 'PF':
 48 |                 scheduler = PF_Scheduler(self.band,self.PRBs,self.dm,self.signLoad,self.ttiBms,self.mimoMd,self.layers,dir,14,self.robustMCS,self.label,self.schType)
 49 |             else: # RR Scheduler by default
 50 |                 scheduler = IntraSliceScheduler(self.band,self.PRBs,self.dm,self.signLoad,self.ttiBms,self.mimoMd,self.layers,dir,14,self.robustMCS,self.label,self.schType)
 51 | 
 52 |         return scheduler
 53 | 
 54 |     def setInitialConfig(self):
 55 |         """This method sets initial Slice configuration according to service requirements."""
 56 |         self.dly2scs(self.reqDelay)
 57 |         if self.band == 'n257' or self.band == 'n258' or self.band == 'n260' or self.band == 'n261':
 58 |             self.tdd = True
 59 |             numReftable = {'60kHz':1,'120kHz':2}
 60 |             self.numRefFactor = numReftable[self.scs]
 61 |             if self.reqDLconnections > 0 and self.reqULconnections == 0:
 62 |                 self.tddSymb = 14
 63 |             if self.reqULconnections > 0 and self.reqDLconnections == 0:
 64 |                 self.tddSymb = 0
 65 |             if self.reqULconnections > 0 and self.reqDLconnections > 0:
 66 |                 DLfactor = float(self.reqDLconnections*self.reqThroughputDL)/(self.reqDLconnections*self.reqThroughputDL+self.reqULconnections*self.reqThroughputUL)
 67 |                 self.tddSymb = int(14*DLfactor)
 68 |                 # print(DLfactor,self.tddSymb)
 69 |         else:
 70 |             #self.tdd = False
 71 |             self.numRefFactor = self.ttiBms
 72 | 
 73 |         if self.reqAvailability == 'High':
 74 |             self.robustMCS = True
 75 | 
 76 |         if 'mMTC' in self.label:
 77 |             self.signLoad = 0.003
 78 | 
 79 |     def dly2scs(self,delay):
 80 |         """This method sets Slice numerology depending on delay requirements."""
 81 |         if self.band == 'n257' or self.band == 'n258' or self.band == 'n260' or self.band == 'n261': #FR2
 82 |             if delay<=2.5:
 83 |                 self.scs = '120kHz'
 84 |                 self.ttiBms = 8
 85 |             else:
 86 |                 self.scs = '60kHz'
 87 |                 self.ttiBms = 4
 88 |         else: # FR1
 89 |             if delay<=5:
 90 |                 self.scs = '60kHz'
 91 |                 self.ttiBms = 4
 92 |             elif delay<=10:
 93 |                 self.scs = '30kHz'
 94 |                 self.ttiBms = 2
 95 |             else:
 96 |                 self.scs = '15kHz'
 97 |                 self.ttiBms = 1
 98 | 
 99 |     def updateConfig(self,n):
100 |         """This method updates Slice allocated PRBs."""
101 |         self.PRBs = n
102 |         self.schedulerDL.nrbUEmax = self.PRBs
103 |         if self.label != 'LTE':
104 |             self.schedulerUL.nrbUEmax = self.PRBs
105 |         if self.mimoMd == 'MU':
106 |             self.schedulerDL.queue.updateSize(self.PRBs*self.layers)
107 |             if self.label != 'LTE':
108 |                 self.schedulerUL.queue.updateSize(self.PRBs*self.layers)
109 |         else:
110 |             self.schedulerDL.queue.updateSize(self.PRBs)
111 |             if self.label != 'LTE':
112 |                 self.schedulerUL.queue.updateSize(self.PRBs)
113 | 


--------------------------------------------------------------------------------
/UE.py:
--------------------------------------------------------------------------------
  1 | """ This module contains the UE, Packet Flow, Packet, PcktQueue, Bearer and RadioLink clases.
  2 | This clases are oriented to describe UE traffic profile, and UE relative concepts
  3 | """
  4 | import os
  5 | import sys
  6 | import random
  7 | import simpy
  8 | from collections import deque
  9 | 
 10 | # UE class: terminal description
 11 | 
 12 | class UE():
 13 | 	""" This class is used to model UE behabiour and relative properties """
 14 | 	def __init__(self, i,ue_sinr0,p,npM):
 15 | 		self.id = i
 16 | 		self.state = 'RRC-IDLE'
 17 | 		self.packetFlows = []
 18 | 		self.bearers = []
 19 | 		self.radioLinks = RadioLink(1,ue_sinr0,self.id)
 20 | 		self.TBid = 1
 21 | 		self.pendingPckts = {}
 22 | 		self.prbs = p
 23 | 		self.resUse = 0
 24 | 		self.pendingTB = []
 25 | 		self.bler = 0
 26 | 		self.tbsz = 1
 27 | 		self.MCS = 0
 28 | 		self.pfFactor = 1 # PF Scheduler
 29 | 		self.pastTbsz = deque([1]) # PF Scheduler
 30 | 		self.lastDen = 0.001 # PF Scheduler
 31 | 		self.num = 0 # PF Scheduler
 32 | 		self.BWPs = npM
 33 | 		self.TXedTB = 1
 34 | 		self.lostTB = 0
 35 | 		self.symb = 0
 36 | 
 37 | 	def addPacketFlow(self,pckFl):
 38 | 		self.packetFlows.append(pckFl)
 39 | 
 40 | 	def addBearer(self,br):
 41 | 		self.bearers.append(br)
 42 | 
 43 | 	def receivePckt(self,env,c): # PEM -------------------------------------------
 44 | 		"""This method takes packets on the application buffers and leave them on the bearer buffers. This is a PEM method."""
 45 | 		while True:
 46 | 			if len(self.packetFlows[0].appBuff.pckts)>0:
 47 | 				if self.state == 'RRC-IDLE': # Not connected
 48 | 					self.connect(c)
 49 | 					nextPackTime = c.tUdQueue
 50 | 					yield env.timeout(nextPackTime)
 51 | 					if nextPackTime > c.inactTimer:
 52 | 						self.releaseConnection(c)
 53 | 				else: # Already connecter user
 54 | 					self.queueDataPckt(c)
 55 | 					nextPackTime = c.tUdQueue
 56 | 					yield env.timeout(nextPackTime)
 57 | 					if nextPackTime > c.inactTimer:
 58 | 						self.releaseConnection(c)
 59 | 			else:
 60 | 				nextPackTime = c.tUdQueue
 61 | 				yield env.timeout(nextPackTime)
 62 | 
 63 | 	def connect(self,cl):
 64 | 		"""This method creates bearers and bearers buffers."""
 65 | 		bD = Bearer(1,9,self.packetFlows[0].type)
 66 | 		self.addBearer(bD)
 67 | 		self.queueDataPckt(cl)
 68 | 		if self.packetFlows[0].type == 'DL':
 69 | 			if (list(cl.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerDL.ues.keys()).count(self.id))<1:
 70 | 				cl.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerDL.ues[self.id] = self
 71 | 		else:
 72 | 			if (list(cl.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerUL.ues.keys()).count(self.id))<1:
 73 | 				cl.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerUL.ues[self.id] = self
 74 | 		self.state = 'RRC-CONNECTED'
 75 | 
 76 | 
 77 | 	def queueDataPckt(self,cell):
 78 | 		"""This method queues the packets taken from the application buffer in the bearer buffers."""
 79 | 		pD = self.packetFlows[0].appBuff.removePckt()
 80 | 		buffSizeAllUEs = 0
 81 | 		buffSizeThisUE = 0
 82 | 		if self.packetFlows[0].type == 'DL':
 83 | 			for ue in list(cell.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerDL.ues.keys()):
 84 | 				buffSizeUE = 0
 85 | 				for p in cell.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerDL.ues[ue].bearers[0].buffer.pckts:
 86 | 					buffSizeUE = buffSizeUE + p.size
 87 | 				if self.id == ue:
 88 | 					buffSizeThisUE = buffSizeUE
 89 | 				buffSizeAllUEs = buffSizeAllUEs + buffSizeUE
 90 | 		else:
 91 | 			for ue in list(cell.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerUL.ues.keys()):
 92 | 				buffSizeUE = 0
 93 | 				for p in cell.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerUL.ues[ue].bearers[0].buffer.pckts:
 94 | 					buffSizeUE = buffSizeUE + p.size
 95 | 				if self.id == ue:
 96 | 					buffSizeThisUE = buffSizeUE
 97 | 				buffSizeAllUEs = buffSizeAllUEs + buffSizeUE
 98 | 
 99 | 		if buffSizeThisUE<cell.maxBuffUE:#len(self.bearers[1].buffer.pckts)<cell.maxBuffUE:
100 | 			self.bearers[0].buffer.insertPckt(pD)
101 | 		else:
102 | 			pcktN = pD.secNum
103 | 			#print (Format.CRED+Format.CBOLD+self.id,'packet ',pcktN,' lost .....',str(pD.tIn)+Format.CEND)
104 | 			if self.packetFlows[0].type == 'DL':
105 | 				cell.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerDL.printDebDataDM('<p style="color:red"><b>'+str(self.id)+' packet '+str(pcktN)+' lost .....'+str(pD.tIn)+'</b></p>')
106 | 			else:
107 | 				cell.interSliceSched.slices[self.packetFlows[0].sliceName].schedulerUL.printDebDataDM('<p style="color:red"><b>'+str(self.id)+' packet '+str(pcktN)+' lost .....'+str(pD.tIn)+'</b></p>')
108 | 			self.packetFlows[0].lostPackets = self.packetFlows[0].lostPackets + 1
109 | 
110 | 	def releaseConnection(self,cl):
111 | 		self.state = 'RRC-IDLE'
112 | 		self.bearers = []
113 | 
114 | # ------------------------------------------------
115 | # PacketFlow class: PacketFlow description
116 | class PacketFlow():
117 | 	""" This class is used to describe UE traffic profile for the simulation."""
118 | 	def __init__(self,i,pckSize,pckArrRate,u,tp,slc):
119 | 		self.id = i
120 | 		self.tMed = 0
121 | 		self.sMed = 0
122 | 		self.type = tp
123 | 		self.sliceName = slc
124 | 		self.pckArrivalRate = pckArrRate
125 | 		self.qosFlowId = 0
126 | 		self.packetSize = pckSize
127 | 		self.ue = u
128 | 		self.sMax = (float(self.packetSize)/350)*600
129 | 		self.tMax = (float(self.pckArrivalRate)/6)*12.5
130 | 		self.tStart = 0
131 | 		self.appBuff = PcktQueue()
132 | 		self.lostPackets = 0
133 | 		self.sentPackets = 0
134 | 		self.rcvdBytes = 0
135 | 		self.pId = 1
136 | 		self.header = 30
137 | 		self.meassuredKPI = {'Throughput':0,'Delay':0,'PacketLossRate':0}
138 | 
139 | 
140 | 	def setQosFId(self,q):
141 | 		qosFlowId = q
142 | 
143 | 	def queueAppPckt(self,env,tSim): # --- PEM -----
144 | 		"""This method creates packets according to the packet flow traffic profile and stores them in the application buffer. """
145 | 		ueN = int(self.ue[2:]) # number of UEs in simulation
146 | 		self.tStart = (random.expovariate(1.0))
147 | 		yield env.timeout(self.tStart) 	 # each UE start transmission after tStart
148 | 		while env.now<(tSim*0.83):
149 | 			self.sentPackets = self.sentPackets + 1
150 | 			size = self.getPsize()
151 | 			pD = Packet(self.pId,size+self.header,self.qosFlowId,self.ue)
152 | 			self.pId = self.pId + 1
153 | 			pD.tIn = env.now
154 | 			self.appBuff.insertPckt(pD)
155 | 			nextPackTime = self.getParrRate()
156 | 			yield env.timeout(nextPackTime)
157 | 
158 | 	def getPsize(self):
159 | 		pSize = random.paretovariate(1.2)*(self.packetSize*(0.2/1.2))
160 | 		while pSize > self.sMax:
161 | 			pSize = random.paretovariate(1.2)*(self.packetSize*(0.2/1.2))
162 | 		self.sMed = self.sMed + pSize
163 | 		return pSize
164 | 
165 | 	def getParrRate(self):
166 | 		pArrRate = random.paretovariate(1.2)*(self.pckArrivalRate*(0.2/1.2))
167 | 		while pArrRate > self.tMax:
168 | 			pArrRate = random.paretovariate(1.2)*(self.pckArrivalRate*(0.2/1.2))
169 | 		self.tMed = self.tMed + pArrRate
170 | 		return pArrRate
171 | 
172 | 	def setMeassures(self,tsim):
173 | 		"""This method calculates average PLR and throughput for the simulation."""
174 | 		self.meassuredKPI['PacketLossRate'] = float(100*self.lostPackets)/self.sentPackets
175 | 		if tsim>1000:
176 | 			self.meassuredKPI['Throughput'] = (float(self.rcvdBytes)*8000)/(0.83*tsim*1024*1024)
177 | 		else:
178 | 			self.meassuredKPI['Throughput'] = 0
179 | 
180 | class Packet:
181 | 	"""This class is used to model packets properties and behabiour."""
182 | 	def __init__(self,sn,s,qfi,u):
183 | 		self.secNum = sn
184 | 		self.size = s
185 | 		self.qosFlowId = qfi
186 | 		self.ue = u
187 | 		self.tIn = 0
188 | 
189 | 	def printPacket(self):
190 | 		print (Format.CYELLOW + Format.CBOLD + self.ue+ '+packet '+str(self.secNum)+' arrives at t ='+str(now()) + Format.CEND)
191 | 
192 | class Bearer:
193 | 	"""This class is used to model Bearers properties and behabiour."""
194 | 	def __init__(self,i,q,tp):
195 | 		self.id = i
196 | 		self.qci = q
197 | 		self.type = tp
198 | 		self.buffer = PcktQueue()
199 | 
200 | class PcktQueue:
201 | 	"""This class is used to model application and bearer buffers."""
202 | 	def __init__(self):
203 | 		self.pckts = deque([])
204 | 
205 | 	def insertPckt(self,p):
206 | 		self.pckts.append(p)
207 | 
208 | 	def insertPcktLeft(self,p):
209 | 		self.pckts.appendleft(p)
210 | 
211 | 	def removePckt(self):
212 | 		if len(self.pckts)>0:
213 | 			return self.pckts.popleft()
214 | 
215 | class RadioLink():
216 | 	"""This class is used to model radio link properties and behabiour."""
217 | 	def __init__(self,i,lq_0,u):
218 | 		self.id = i
219 | 		state = 'ON'
220 | 		self.linkQuality = lq_0
221 | 		self.ue = u
222 | 		self.totCount = 0
223 | 		self.maxVar = 0.1
224 | 
225 | 	def updateLQ(self,env,udIntrv,tSim,fl,u,r):
226 | 		"""This method updates UE link quality in terms of SINR during the simulation. This is a PEM method.
227 | 
228 | 		During the simulation it is assumed that UE SINR varies following a normal distribution with mean value equal to initial SINR value, and a small variance."""
229 | 
230 | 		while env.now<(tSim*0.83):
231 | 			yield env.timeout(udIntrv)
232 | 			deltaSINR = random.normalvariate(0, self.maxVar)
233 | 			while deltaSINR > self.maxVar or deltaSINR<(0-self.maxVar):
234 | 				deltaSINR = random.normalvariate(0, self.maxVar)
235 | 			self.linkQuality = self.linkQuality + deltaSINR
236 | 
237 | class Format:
238 |     CEND      = '\33[0m'
239 |     CBOLD     = '\33[1m'
240 |     CITALIC   = '\33[3m'
241 |     CURL      = '\33[4m'
242 |     CBLINK    = '\33[5m'
243 |     CBLINK2   = '\33[6m'
244 |     CSELECTED = '\33[7m'
245 |     CBLACK  = '\33[30m'
246 |     CRED    = '\33[31m'
247 |     CGREEN  = '\33[32m'
248 |     CYELLOW = '\33[33m'
249 |     CBLUE   = '\33[34m'
250 |     CVIOLET = '\33[35m'
251 |     CBEIGE  = '\33[36m'
252 |     CWHITE  = '\33[37m'
253 |     CGREENBG  = '\33[42m'
254 |     CBLUEBG   = '\33[44m'
255 | 


--------------------------------------------------------------------------------
/doc/Py5cheSim.Cell.Cell.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.Cell.Cell : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Cell.html">Cell</a></code>.<code><a href="Py5cheSim.Cell.Cell.html">Cell</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">Cell</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.Cell.Cell">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>Cell class has cell relative parameters and collect kpi ststistics.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id3">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span>This method creates a cell instance.</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#id">id</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#bw">bw</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="instancevariable">
 64 |     
 65 |     <td>Instance Variable</td>
 66 |     <td><code><a href="#inactTimer">inactTimer</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="instancevariable">
 69 |     
 70 |     <td>Instance Variable</td>
 71 |     <td><code><a href="#tUdQueue">tUdQueue</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="instancevariable">
 74 |     
 75 |     <td>Instance Variable</td>
 76 |     <td><code><a href="#maxBuffUE">maxBuffUE</a></code></td>
 77 |     <td><span>Maximum bearer buffer size by UE, in bytes</span></td>
 78 |   </tr><tr class="instancevariable">
 79 |     
 80 |     <td>Instance Variable</td>
 81 |     <td><code><a href="#sch">sch</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr><tr class="instancevariable">
 84 |     
 85 |     <td>Instance Variable</td>
 86 |     <td><code><a href="#interSliceSched">interSliceSched</a></code></td>
 87 |     <td><span class="undocumented">Undocumented</span></td>
 88 |   </tr><tr class="instancevariable">
 89 |     
 90 |     <td>Instance Variable</td>
 91 |     <td><code><a href="#slicesStsts">slicesStsts</a></code></td>
 92 |     <td><span class="undocumented">Undocumented</span></td>
 93 |   </tr><tr class="method">
 94 |     
 95 |     <td>Method</td>
 96 |     <td><code><a href="#updateStsts">updateStsts</a></code></td>
 97 |     <td><span>This method manages the statistics collection. This is a PEM Method.</span></td>
 98 |   </tr>
 99 | </table>
100 |         
101 | 
102 |           
103 |       </div>
104 | 
105 |       <div id="childList">
106 | 
107 |         <div class="basemethod">
108 |   
109 |   <a name="Py5cheSim.Cell.Cell.__init__">
110 |     
111 |   </a>
112 |   <a name="__init__">
113 |     
114 |   </a>
115 |   <div class="functionHeader">
116 |     
117 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, i, b, fr, dm, mBue, tdd, gr, schInter):
118 |     
119 |   </div>
120 |   <div class="docstring functionBody">
121 |     
122 |     
123 |     <div><p>This method creates a cell instance.</p><p>It initialices cell parameters and interSliceScheduler according to the algorithm specified on the sch attribute.</p></div>
124 |   </div>
125 | </div><div class="baseinstancevariable">
126 |   
127 |   <a name="Py5cheSim.Cell.Cell.id">
128 |     
129 |   </a>
130 |   <a name="id">
131 |     
132 |   </a>
133 |   <div class="functionHeader">
134 |     
135 |     <span class="py-defname">id</span> =
136 |     
137 |   </div>
138 |   <div class="functionBody">
139 |     
140 |     
141 |     <div><p class="undocumented">Undocumented</p></div>
142 |   </div>
143 | </div><div class="baseinstancevariable">
144 |   
145 |   <a name="Py5cheSim.Cell.Cell.bw">
146 |     
147 |   </a>
148 |   <a name="bw">
149 |     
150 |   </a>
151 |   <div class="functionHeader">
152 |     
153 |     <span class="py-defname">bw</span> =
154 |     
155 |   </div>
156 |   <div class="functionBody">
157 |     
158 |     
159 |     <div><p class="undocumented">Undocumented</p></div>
160 |   </div>
161 | </div><div class="baseinstancevariable">
162 |   
163 |   <a name="Py5cheSim.Cell.Cell.inactTimer">
164 |     
165 |   </a>
166 |   <a name="inactTimer">
167 |     
168 |   </a>
169 |   <div class="functionHeader">
170 |     
171 |     <span class="py-defname">inactTimer</span> =
172 |     
173 |   </div>
174 |   <div class="functionBody">
175 |     
176 |     
177 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>int</code>)
178 |   </div>
179 | </div><div class="baseinstancevariable">
180 |   
181 |   <a name="Py5cheSim.Cell.Cell.tUdQueue">
182 |     
183 |   </a>
184 |   <a name="tUdQueue">
185 |     
186 |   </a>
187 |   <div class="functionHeader">
188 |     
189 |     <span class="py-defname">tUdQueue</span> =
190 |     
191 |   </div>
192 |   <div class="functionBody">
193 |     
194 |     
195 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>float</code>)
196 |   </div>
197 | </div><div class="baseinstancevariable">
198 |   
199 |   <a name="Py5cheSim.Cell.Cell.maxBuffUE">
200 |     
201 |   </a>
202 |   <a name="maxBuffUE">
203 |     
204 |   </a>
205 |   <div class="functionHeader">
206 |     
207 |     <span class="py-defname">maxBuffUE</span> =
208 |     
209 |   </div>
210 |   <div class="functionBody">
211 |     
212 |     
213 |     <div><p>Maximum bearer buffer size by UE, in bytes</p></div>
214 |   </div>
215 | </div><div class="baseinstancevariable">
216 |   
217 |   <a name="Py5cheSim.Cell.Cell.sch">
218 |     
219 |   </a>
220 |   <a name="sch">
221 |     
222 |   </a>
223 |   <div class="functionHeader">
224 |     
225 |     <span class="py-defname">sch</span> =
226 |     
227 |   </div>
228 |   <div class="functionBody">
229 |     
230 |     
231 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
232 |   </div>
233 | </div><div class="baseinstancevariable">
234 |   
235 |   <a name="Py5cheSim.Cell.Cell.interSliceSched">
236 |     
237 |   </a>
238 |   <a name="interSliceSched">
239 |     
240 |   </a>
241 |   <div class="functionHeader">
242 |     
243 |     <span class="py-defname">interSliceSched</span> =
244 |     
245 |   </div>
246 |   <div class="functionBody">
247 |     
248 |     
249 |     <div><p class="undocumented">Undocumented</p></div>
250 |   </div>
251 | </div><div class="baseinstancevariable">
252 |   
253 |   <a name="Py5cheSim.Cell.Cell.slicesStsts">
254 |     
255 |   </a>
256 |   <a name="slicesStsts">
257 |     
258 |   </a>
259 |   <div class="functionHeader">
260 |     
261 |     <span class="py-defname">slicesStsts</span> =
262 |     
263 |   </div>
264 |   <div class="functionBody">
265 |     
266 |     
267 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>dict</code>)
268 |   </div>
269 | </div><div class="basemethod">
270 |   
271 |   <a name="Py5cheSim.Cell.Cell.updateStsts">
272 |     
273 |   </a>
274 |   <a name="updateStsts">
275 |     
276 |   </a>
277 |   <div class="functionHeader">
278 |     
279 |     <span class="py-keyword">def</span> <span class="py-defname">updateStsts</span>(self, env, interv, tSim):
280 |     
281 |   </div>
282 |   <div class="docstring functionBody">
283 |     
284 |     
285 |     <div><p>This method manages the statistics collection. This is a PEM Method.</p><p>This method creates statistics files and stores counter values to calculate later the main kpi considered.</p><p>Inter Slice statistics are stored in the dlStsts_InterSlice.txt file for DL and ulStsts_InterSlice.txt file for UL.</p><p>Intra Slice statistics are stored in the dlStsts_&lt;Slicename&gt;Slice.txt file for DL and ulStsts_&lt;Slicename&gt;Slice.txt file for UL.</p></div>
286 |   </div>
287 | </div>
288 | 
289 |       </div>
290 |       <address>
291 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
292 |       </address>
293 | 
294 |     </div>
295 | 
296 |     <script src="pydoctor.js" type="text/javascript"></script>
297 | 
298 |   </body>
299 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Cell.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Py5cheSim.Cell : API documentation</title>
 7 | 
 8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
11 |   </head>
12 |   <body>
13 | 
14 |     <nav class="navbar navbar-default">
15 |       <div class="container">
16 |         <div class="navbar-header navbar-brand">
17 |           Py5cheSim
18 |           <a href="index.html">API Documentation</a>
19 |         </div>
20 |       </div>
21 |     </nav>
22 | 
23 |     <div class="container">
24 | 
25 |       <div class="page-header">
26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Cell.html">Cell</a></code></code></h1>
27 |         <div id="showPrivate">
28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
29 |         </div>
30 |       </div>
31 | 
32 |       <div class="categoryHeader">
33 |         module documentation
34 |       </div>
35 | 
36 |       <div class="extrasDocstring">
37 |         
38 |         <p></p>
39 |       </div>
40 | 
41 |       <div class="moduleDocstring">
42 |         <div><p>This module contains the Cell class.</p></div>
43 |       </div>
44 | 
45 |       <div id="splitTables">
46 |         <table class="children sortable" id="id2">
47 |   
48 |   <tr class="class">
49 |     
50 |     <td>Class</td>
51 |     <td><code><a href="Py5cheSim.Cell.Cell.html">Cell</a></code></td>
52 |     <td><span>Cell class has cell relative parameters and collect kpi ststistics.</span></td>
53 |   </tr>
54 | </table>
55 |         
56 | 
57 |           
58 |       </div>
59 | 
60 |       <div id="childList">
61 | 
62 |         
63 | 
64 |       </div>
65 |       <address>
66 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
67 |       </address>
68 | 
69 |     </div>
70 | 
71 |     <script src="pydoctor.js" type="text/javascript"></script>
72 | 
73 |   </body>
74 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.InterSliceSch.InterSliceScheduler.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.InterSliceSch.InterSliceScheduler : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.InterSliceSch.html">InterSliceSch</a></code>.<code><a href="Py5cheSim.InterSliceSch.InterSliceScheduler.html">InterSliceScheduler</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">InterSliceScheduler</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.InterSliceSch.InterSliceScheduler">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>Basic inter slice scheduler. It implements Round Robin algorithm.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id5">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#bw">bw</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#FR">FR</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="instancevariable">
 64 |     
 65 |     <td>Instance Variable</td>
 66 |     <td><code><a href="#nRBtable">nRBtable</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="instancevariable">
 69 |     
 70 |     <td>Instance Variable</td>
 71 |     <td><code><a href="#PRBs">PRBs</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="instancevariable">
 74 |     
 75 |     <td>Instance Variable</td>
 76 |     <td><code><a href="#slices">slices</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="instancevariable">
 79 |     
 80 |     <td>Instance Variable</td>
 81 |     <td><code><a href="#dm">dm</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr><tr class="instancevariable">
 84 |     
 85 |     <td>Instance Variable</td>
 86 |     <td><code><a href="#dbFile">dbFile</a></code></td>
 87 |     <td><span class="undocumented">Undocumented</span></td>
 88 |   </tr><tr class="instancevariable">
 89 |     
 90 |     <td>Instance Variable</td>
 91 |     <td><code><a href="#tdd">tdd</a></code></td>
 92 |     <td><span class="undocumented">Undocumented</span></td>
 93 |   </tr><tr class="instancevariable">
 94 |     
 95 |     <td>Instance Variable</td>
 96 |     <td><code><a href="#granularity">granularity</a></code></td>
 97 |     <td><span class="undocumented">Undocumented</span></td>
 98 |   </tr><tr class="method">
 99 |     
100 |     <td>Method</td>
101 |     <td><code><a href="#resAlloc">resAlloc</a></code></td>
102 |     <td><span>This method implements Round Robin PRB allocation between the different configured slices. This is a PEM method</span></td>
103 |   </tr><tr class="method">
104 |     
105 |     <td>Method</td>
106 |     <td><code><a href="#createSlice">createSlice</a></code></td>
107 |     <td><span>This method creates a slice and stores it in the slices dictionary.</span></td>
108 |   </tr><tr class="method">
109 |     
110 |     <td>Method</td>
111 |     <td><code><a href="#printSliceConfig">printSliceConfig</a></code></td>
112 |     <td><span>This method stores inter slice scheduling debugging information on the log file.</span></td>
113 |   </tr>
114 | </table>
115 |         
116 | 
117 |           
118 |       </div>
119 | 
120 |       <div id="childList">
121 | 
122 |         <div class="basemethod">
123 |   
124 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.__init__">
125 |     
126 |   </a>
127 |   <a name="__init__">
128 |     
129 |   </a>
130 |   <div class="functionHeader">
131 |     
132 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, ba, fr, dm, tdd, gr):
133 |     
134 |   </div>
135 |   <div class="docstring functionBody">
136 |     
137 |     
138 |     <div><p class="undocumented">Undocumented</p></div>
139 |   </div>
140 | </div><div class="baseinstancevariable">
141 |   
142 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.bw">
143 |     
144 |   </a>
145 |   <a name="bw">
146 |     
147 |   </a>
148 |   <div class="functionHeader">
149 |     
150 |     <span class="py-defname">bw</span> =
151 |     
152 |   </div>
153 |   <div class="functionBody">
154 |     
155 |     
156 |     <div><p class="undocumented">Undocumented</p></div>
157 |   </div>
158 | </div><div class="baseinstancevariable">
159 |   
160 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.FR">
161 |     
162 |   </a>
163 |   <a name="FR">
164 |     
165 |   </a>
166 |   <div class="functionHeader">
167 |     
168 |     <span class="py-defname">FR</span> =
169 |     
170 |   </div>
171 |   <div class="functionBody">
172 |     
173 |     
174 |     <div><p class="undocumented">Undocumented</p></div>
175 |   </div>
176 | </div><div class="baseinstancevariable">
177 |   
178 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.nRBtable">
179 |     
180 |   </a>
181 |   <a name="nRBtable">
182 |     
183 |   </a>
184 |   <div class="functionHeader">
185 |     
186 |     <span class="py-defname">nRBtable</span> =
187 |     
188 |   </div>
189 |   <div class="functionBody">
190 |     
191 |     
192 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>dict[str, dict]</code>)
193 |   </div>
194 | </div><div class="baseinstancevariable">
195 |   
196 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.PRBs">
197 |     
198 |   </a>
199 |   <a name="PRBs">
200 |     
201 |   </a>
202 |   <div class="functionHeader">
203 |     
204 |     <span class="py-defname">PRBs</span> =
205 |     
206 |   </div>
207 |   <div class="functionBody">
208 |     
209 |     
210 |     <div><p class="undocumented">Undocumented</p></div>
211 |   </div>
212 | </div><div class="baseinstancevariable">
213 |   
214 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.slices">
215 |     
216 |   </a>
217 |   <a name="slices">
218 |     
219 |   </a>
220 |   <div class="functionHeader">
221 |     
222 |     <span class="py-defname">slices</span> =
223 |     
224 |   </div>
225 |   <div class="functionBody">
226 |     
227 |     
228 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>dict</code>)
229 |   </div>
230 | </div><div class="baseinstancevariable">
231 |   
232 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.dm">
233 |     
234 |   </a>
235 |   <a name="dm">
236 |     
237 |   </a>
238 |   <div class="functionHeader">
239 |     
240 |     <span class="py-defname">dm</span> =
241 |     
242 |   </div>
243 |   <div class="functionBody">
244 |     
245 |     
246 |     <div><p class="undocumented">Undocumented</p></div>
247 |   </div>
248 | </div><div class="baseinstancevariable">
249 |   
250 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.dbFile">
251 |     
252 |   </a>
253 |   <a name="dbFile">
254 |     
255 |   </a>
256 |   <div class="functionHeader">
257 |     
258 |     <span class="py-defname">dbFile</span> =
259 |     
260 |   </div>
261 |   <div class="functionBody">
262 |     
263 |     
264 |     <div><p class="undocumented">Undocumented</p></div>
265 |   </div>
266 | </div><div class="baseinstancevariable">
267 |   
268 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.tdd">
269 |     
270 |   </a>
271 |   <a name="tdd">
272 |     
273 |   </a>
274 |   <div class="functionHeader">
275 |     
276 |     <span class="py-defname">tdd</span> =
277 |     
278 |   </div>
279 |   <div class="functionBody">
280 |     
281 |     
282 |     <div><p class="undocumented">Undocumented</p></div>
283 |   </div>
284 | </div><div class="baseinstancevariable">
285 |   
286 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.granularity">
287 |     
288 |   </a>
289 |   <a name="granularity">
290 |     
291 |   </a>
292 |   <div class="functionHeader">
293 |     
294 |     <span class="py-defname">granularity</span> =
295 |     
296 |   </div>
297 |   <div class="functionBody">
298 |     
299 |     
300 |     <div><p class="undocumented">Undocumented</p></div>
301 |   </div>
302 | </div><div class="basemethod">
303 |   
304 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.resAlloc">
305 |     
306 |   </a>
307 |   <a name="resAlloc">
308 |     
309 |   </a>
310 |   <div class="functionHeader">
311 |     
312 |     <span class="py-keyword">def</span> <span class="py-defname">resAlloc</span>(self, env):
313 |     
314 |   </div>
315 |   <div class="docstring functionBody">
316 |     
317 |     
318 |     <div><p>This method implements Round Robin PRB allocation between the different configured slices. This is a PEM method</p></div>
319 |   </div>
320 | </div><div class="basemethod">
321 |   
322 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.createSlice">
323 |     
324 |   </a>
325 |   <a name="createSlice">
326 |     
327 |   </a>
328 |   <div class="functionHeader">
329 |     
330 |     <span class="py-keyword">def</span> <span class="py-defname">createSlice</span>(self, dly, thDL, thUL, avl, cnxDL, cnxUL, ba, dm, mmd, ly, lbl, sch):
331 |     
332 |   </div>
333 |   <div class="docstring functionBody">
334 |     
335 |     
336 |     <div><p>This method creates a slice and stores it in the slices dictionary.</p></div>
337 |   </div>
338 | </div><div class="basemethod">
339 |   
340 |   <a name="Py5cheSim.InterSliceSch.InterSliceScheduler.printSliceConfig">
341 |     
342 |   </a>
343 |   <a name="printSliceConfig">
344 |     
345 |   </a>
346 |   <div class="functionHeader">
347 |     
348 |     <span class="py-keyword">def</span> <span class="py-defname">printSliceConfig</span>(self, slice):
349 |     
350 |   </div>
351 |   <div class="docstring functionBody">
352 |     
353 |     
354 |     <div><p>This method stores inter slice scheduling debugging information on the log file.</p></div>
355 |   </div>
356 | </div>
357 | 
358 |       </div>
359 |       <address>
360 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
361 |       </address>
362 | 
363 |     </div>
364 | 
365 |     <script src="pydoctor.js" type="text/javascript"></script>
366 | 
367 |   </body>
368 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.InterSliceSch.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Py5cheSim.InterSliceSch : API documentation</title>
 7 | 
 8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
11 |   </head>
12 |   <body>
13 | 
14 |     <nav class="navbar navbar-default">
15 |       <div class="container">
16 |         <div class="navbar-header navbar-brand">
17 |           Py5cheSim
18 |           <a href="index.html">API Documentation</a>
19 |         </div>
20 |       </div>
21 |     </nav>
22 | 
23 |     <div class="container">
24 | 
25 |       <div class="page-header">
26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.InterSliceSch.html">InterSliceSch</a></code></code></h1>
27 |         <div id="showPrivate">
28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
29 |         </div>
30 |       </div>
31 | 
32 |       <div class="categoryHeader">
33 |         module documentation
34 |       </div>
35 | 
36 |       <div class="extrasDocstring">
37 |         
38 |         <p></p>
39 |       </div>
40 | 
41 |       <div class="moduleDocstring">
42 |         <div><p>This module contains the basic Inter Slice Scheduler class. All possible inter slice schedulers should inherit from this.</p></div>
43 |       </div>
44 | 
45 |       <div id="splitTables">
46 |         <table class="children sortable" id="id4">
47 |   
48 |   <tr class="class">
49 |     
50 |     <td>Class</td>
51 |     <td><code><a href="Py5cheSim.InterSliceSch.InterSliceScheduler.html">InterSliceScheduler</a></code></td>
52 |     <td><span>Basic inter slice scheduler. It implements Round Robin algorithm.</span></td>
53 |   </tr>
54 | </table>
55 |         
56 | 
57 |           
58 |       </div>
59 | 
60 |       <div id="childList">
61 | 
62 |         
63 | 
64 |       </div>
65 |       <address>
66 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
67 |       </address>
68 | 
69 |     </div>
70 | 
71 |     <script src="pydoctor.js" type="text/javascript"></script>
72 | 
73 |   </body>
74 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.IntraSliceSch.TBqueue.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.IntraSliceSch.TBqueue : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.IntraSliceSch.html">IntraSliceSch</a></code>.<code><a href="Py5cheSim.IntraSliceSch.TBqueue.html">TBqueue</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">TBqueue</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.IntraSliceSch.TBqueue">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class is used to model scheduler TB queue.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id10">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#res">res</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#numRB">numRB</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="method">
 64 |     
 65 |     <td>Method</td>
 66 |     <td><code><a href="#getFreeSpace">getFreeSpace</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="method">
 69 |     
 70 |     <td>Method</td>
 71 |     <td><code><a href="#insertTB">insertTB</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="method">
 74 |     
 75 |     <td>Method</td>
 76 |     <td><code><a href="#removeTB">removeTB</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="method">
 79 |     
 80 |     <td>Method</td>
 81 |     <td><code><a href="#updateSize">updateSize</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr>
 84 | </table>
 85 |         
 86 | 
 87 |           
 88 |       </div>
 89 | 
 90 |       <div id="childList">
 91 | 
 92 |         <div class="basemethod">
 93 |   
 94 |   <a name="Py5cheSim.IntraSliceSch.TBqueue.__init__">
 95 |     
 96 |   </a>
 97 |   <a name="__init__">
 98 |     
 99 |   </a>
100 |   <div class="functionHeader">
101 |     
102 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, nrb):
103 |     
104 |   </div>
105 |   <div class="docstring functionBody">
106 |     
107 |     
108 |     <div><p class="undocumented">Undocumented</p></div>
109 |   </div>
110 | </div><div class="baseinstancevariable">
111 |   
112 |   <a name="Py5cheSim.IntraSliceSch.TBqueue.res">
113 |     
114 |   </a>
115 |   <a name="res">
116 |     
117 |   </a>
118 |   <div class="functionHeader">
119 |     
120 |     <span class="py-defname">res</span> =
121 |     
122 |   </div>
123 |   <div class="functionBody">
124 |     
125 |     
126 |     <div><p class="undocumented">Undocumented</p></div>
127 |   </div>
128 | </div><div class="baseinstancevariable">
129 |   
130 |   <a name="Py5cheSim.IntraSliceSch.TBqueue.numRB">
131 |     
132 |   </a>
133 |   <a name="numRB">
134 |     
135 |   </a>
136 |   <div class="functionHeader">
137 |     
138 |     <span class="py-defname">numRB</span> =
139 |     
140 |   </div>
141 |   <div class="functionBody">
142 |     
143 |     
144 |     <div><p class="undocumented">Undocumented</p></div>
145 |   </div>
146 | </div><div class="basemethod">
147 |   
148 |   <a name="Py5cheSim.IntraSliceSch.TBqueue.getFreeSpace">
149 |     
150 |   </a>
151 |   <a name="getFreeSpace">
152 |     
153 |   </a>
154 |   <div class="functionHeader">
155 |     
156 |     <span class="py-keyword">def</span> <span class="py-defname">getFreeSpace</span>(self):
157 |     
158 |   </div>
159 |   <div class="docstring functionBody">
160 |     
161 |     
162 |     <div><p class="undocumented">Undocumented</p></div>
163 |   </div>
164 | </div><div class="basemethod">
165 |   
166 |   <a name="Py5cheSim.IntraSliceSch.TBqueue.insertTB">
167 |     
168 |   </a>
169 |   <a name="insertTB">
170 |     
171 |   </a>
172 |   <div class="functionHeader">
173 |     
174 |     <span class="py-keyword">def</span> <span class="py-defname">insertTB</span>(self, tb):
175 |     
176 |   </div>
177 |   <div class="docstring functionBody">
178 |     
179 |     
180 |     <div><p class="undocumented">Undocumented</p></div>
181 |   </div>
182 | </div><div class="basemethod">
183 |   
184 |   <a name="Py5cheSim.IntraSliceSch.TBqueue.removeTB">
185 |     
186 |   </a>
187 |   <a name="removeTB">
188 |     
189 |   </a>
190 |   <div class="functionHeader">
191 |     
192 |     <span class="py-keyword">def</span> <span class="py-defname">removeTB</span>(self):
193 |     
194 |   </div>
195 |   <div class="docstring functionBody">
196 |     
197 |     
198 |     <div><p class="undocumented">Undocumented</p></div>
199 |   </div>
200 | </div><div class="basemethod">
201 |   
202 |   <a name="Py5cheSim.IntraSliceSch.TBqueue.updateSize">
203 |     
204 |   </a>
205 |   <a name="updateSize">
206 |     
207 |   </a>
208 |   <div class="functionHeader">
209 |     
210 |     <span class="py-keyword">def</span> <span class="py-defname">updateSize</span>(self, newSize):
211 |     
212 |   </div>
213 |   <div class="docstring functionBody">
214 |     
215 |     
216 |     <div><p class="undocumented">Undocumented</p></div>
217 |   </div>
218 | </div>
219 | 
220 |       </div>
221 |       <address>
222 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
223 |       </address>
224 | 
225 |     </div>
226 | 
227 |     <script src="pydoctor.js" type="text/javascript"></script>
228 | 
229 |   </body>
230 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.IntraSliceSch.TransportBlock.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.IntraSliceSch.TransportBlock : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.IntraSliceSch.html">IntraSliceSch</a></code>.<code><a href="Py5cheSim.IntraSliceSch.TransportBlock.html">TransportBlock</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">TransportBlock</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.IntraSliceSch.TransportBlock">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class is used to describe TB properties and behabiour.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id11">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#id">id</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#mod">mod</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="instancevariable">
 64 |     
 65 |     <td>Instance Variable</td>
 66 |     <td><code><a href="#ue">ue</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="instancevariable">
 69 |     
 70 |     <td>Instance Variable</td>
 71 |     <td><code><a href="#type">type</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="instancevariable">
 74 |     
 75 |     <td>Instance Variable</td>
 76 |     <td><code><a href="#pckt_l">pckt_l</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="instancevariable">
 79 |     
 80 |     <td>Instance Variable</td>
 81 |     <td><code><a href="#numRB">numRB</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr><tr class="instancevariable">
 84 |     
 85 |     <td>Instance Variable</td>
 86 |     <td><code><a href="#reTxNum">reTxNum</a></code></td>
 87 |     <td><span class="undocumented">Undocumented</span></td>
 88 |   </tr><tr class="instancevariable">
 89 |     
 90 |     <td>Instance Variable</td>
 91 |     <td><code><a href="#size">size</a></code></td>
 92 |     <td><span class="undocumented">Undocumented</span></td>
 93 |   </tr>
 94 | </table>
 95 |         
 96 | 
 97 |           
 98 |       </div>
 99 | 
100 |       <div id="childList">
101 | 
102 |         <div class="basemethod">
103 |   
104 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.__init__">
105 |     
106 |   </a>
107 |   <a name="__init__">
108 |     
109 |   </a>
110 |   <div class="functionHeader">
111 |     
112 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, i, m, u, typ, p_l, nrb, sz):
113 |     
114 |   </div>
115 |   <div class="docstring functionBody">
116 |     
117 |     
118 |     <div><p class="undocumented">Undocumented</p></div>
119 |   </div>
120 | </div><div class="baseinstancevariable">
121 |   
122 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.id">
123 |     
124 |   </a>
125 |   <a name="id">
126 |     
127 |   </a>
128 |   <div class="functionHeader">
129 |     
130 |     <span class="py-defname">id</span> =
131 |     
132 |   </div>
133 |   <div class="functionBody">
134 |     
135 |     
136 |     <div><p class="undocumented">Undocumented</p></div>
137 |   </div>
138 | </div><div class="baseinstancevariable">
139 |   
140 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.mod">
141 |     
142 |   </a>
143 |   <a name="mod">
144 |     
145 |   </a>
146 |   <div class="functionHeader">
147 |     
148 |     <span class="py-defname">mod</span> =
149 |     
150 |   </div>
151 |   <div class="functionBody">
152 |     
153 |     
154 |     <div><p class="undocumented">Undocumented</p></div>
155 |   </div>
156 | </div><div class="baseinstancevariable">
157 |   
158 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.ue">
159 |     
160 |   </a>
161 |   <a name="ue">
162 |     
163 |   </a>
164 |   <div class="functionHeader">
165 |     
166 |     <span class="py-defname">ue</span> =
167 |     
168 |   </div>
169 |   <div class="functionBody">
170 |     
171 |     
172 |     <div><p class="undocumented">Undocumented</p></div>
173 |   </div>
174 | </div><div class="baseinstancevariable">
175 |   
176 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.type">
177 |     
178 |   </a>
179 |   <a name="type">
180 |     
181 |   </a>
182 |   <div class="functionHeader">
183 |     
184 |     <span class="py-defname">type</span> =
185 |     
186 |   </div>
187 |   <div class="functionBody">
188 |     
189 |     
190 |     <div><p class="undocumented">Undocumented</p></div>
191 |   </div>
192 | </div><div class="baseinstancevariable">
193 |   
194 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.pckt_l">
195 |     
196 |   </a>
197 |   <a name="pckt_l">
198 |     
199 |   </a>
200 |   <div class="functionHeader">
201 |     
202 |     <span class="py-defname">pckt_l</span> =
203 |     
204 |   </div>
205 |   <div class="functionBody">
206 |     
207 |     
208 |     <div><p class="undocumented">Undocumented</p></div>
209 |   </div>
210 | </div><div class="baseinstancevariable">
211 |   
212 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.numRB">
213 |     
214 |   </a>
215 |   <a name="numRB">
216 |     
217 |   </a>
218 |   <div class="functionHeader">
219 |     
220 |     <span class="py-defname">numRB</span> =
221 |     
222 |   </div>
223 |   <div class="functionBody">
224 |     
225 |     
226 |     <div><p class="undocumented">Undocumented</p></div>
227 |   </div>
228 | </div><div class="baseinstancevariable">
229 |   
230 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.reTxNum">
231 |     
232 |   </a>
233 |   <a name="reTxNum">
234 |     
235 |   </a>
236 |   <div class="functionHeader">
237 |     
238 |     <span class="py-defname">reTxNum</span> =
239 |     
240 |   </div>
241 |   <div class="functionBody">
242 |     
243 |     
244 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>int</code>)
245 |   </div>
246 | </div><div class="baseinstancevariable">
247 |   
248 |   <a name="Py5cheSim.IntraSliceSch.TransportBlock.size">
249 |     
250 |   </a>
251 |   <a name="size">
252 |     
253 |   </a>
254 |   <div class="functionHeader">
255 |     
256 |     <span class="py-defname">size</span> =
257 |     
258 |   </div>
259 |   <div class="functionBody">
260 |     
261 |     
262 |     <div><p class="undocumented">Undocumented</p></div>
263 |   </div>
264 | </div>
265 | 
266 |       </div>
267 |       <address>
268 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
269 |       </address>
270 | 
271 |     </div>
272 | 
273 |     <script src="pydoctor.js" type="text/javascript"></script>
274 | 
275 |   </body>
276 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.IntraSliceSch.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Py5cheSim.IntraSliceSch : API documentation</title>
 7 | 
 8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
11 |   </head>
12 |   <body>
13 | 
14 |     <nav class="navbar navbar-default">
15 |       <div class="container">
16 |         <div class="navbar-header navbar-brand">
17 |           Py5cheSim
18 |           <a href="index.html">API Documentation</a>
19 |         </div>
20 |       </div>
21 |     </nav>
22 | 
23 |     <div class="container">
24 | 
25 |       <div class="page-header">
26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.IntraSliceSch.html">IntraSliceSch</a></code></code></h1>
27 |         <div id="showPrivate">
28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
29 |         </div>
30 |       </div>
31 | 
32 |       <div class="categoryHeader">
33 |         module documentation
34 |       </div>
35 | 
36 |       <div class="extrasDocstring">
37 |         
38 |         <p></p>
39 |       </div>
40 | 
41 |       <div class="moduleDocstring">
42 |         <div><p>This module contains the basic Intra Slice Scheduler class. All possible intra slice schedulers should inherit from this.</p></div>
43 |       </div>
44 | 
45 |       <div id="splitTables">
46 |         <table class="children sortable" id="id6">
47 |   
48 |   <tr class="class">
49 |     
50 |     <td>Class</td>
51 |     <td><code><a href="Py5cheSim.IntraSliceSch.IntraSliceScheduler.html">IntraSliceScheduler</a></code></td>
52 |     <td><span>Basic intra slice scheduler. It implements Round Robin algorithm.</span></td>
53 |   </tr><tr class="class">
54 |     
55 |     <td>Class</td>
56 |     <td><code><a href="Py5cheSim.IntraSliceSch.LTE_scheduler.html">LTE_scheduler</a></code></td>
57 |     <td><span>Basic intra slice LTE scheduler. It implements Round Robin algorithm for scheduling in a LTE Slice.</span></td>
58 |   </tr><tr class="class">
59 |     
60 |     <td>Class</td>
61 |     <td><code><a href="Py5cheSim.IntraSliceSch.TBqueue.html">TBqueue</a></code></td>
62 |     <td><span>This class is used to model scheduler TB queue.</span></td>
63 |   </tr><tr class="class">
64 |     
65 |     <td>Class</td>
66 |     <td><code><a href="Py5cheSim.IntraSliceSch.TransportBlock.html">TransportBlock</a></code></td>
67 |     <td><span>This class is used to describe TB properties and behabiour.</span></td>
68 |   </tr><tr class="class">
69 |     
70 |     <td>Class</td>
71 |     <td><code><a href="Py5cheSim.IntraSliceSch.Format.html">Format</a></code></td>
72 |     <td><span class="undocumented">Undocumented</span></td>
73 |   </tr>
74 | </table>
75 |         
76 | 
77 |           
78 |       </div>
79 | 
80 |       <div id="childList">
81 | 
82 |         
83 | 
84 |       </div>
85 |       <address>
86 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
87 |       </address>
88 | 
89 |     </div>
90 | 
91 |     <script src="pydoctor.js" type="text/javascript"></script>
92 | 
93 |   </body>
94 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Results.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.Results : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Results.html">Results</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         module documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         
 38 |         <p></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This module contains auxiliary simulation classes and methods along with results processing.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id13">
 47 |   
 48 |   <tr class="function">
 49 |     
 50 |     <td>Function</td>
 51 |     <td><code><a href="#initialSinrGenerator">initialSinrGenerator</a></code></td>
 52 |     <td><span>Auxiliary method for SINR generation. This method is used to generate initial UE SINR. Later, during the simulation SINR will have small variations with time.</span></td>
 53 |   </tr><tr class="class">
 54 |     
 55 |     <td>Class</td>
 56 |     <td><code><a href="Py5cheSim.Results.UEgroup.html">UEgroup</a></code></td>
 57 |     <td><span>This class is used to describe traffic profile and requirements of group of UE which the simulation will run for. It is assumed that all UEs shares the same traffic profile and service requirements, and will be served by the same slice.</span></td>
 58 |   </tr><tr class="function">
 59 |     
 60 |     <td>Function</td>
 61 |     <td><code><a href="#printResults">printResults</a></code></td>
 62 |     <td><span>This method prints main simulation results on the terminal</span></td>
 63 |   </tr><tr class="function">
 64 |     
 65 |     <td>Function</td>
 66 |     <td><code><a href="#getKPIs">getKPIs</a></code></td>
 67 |     <td><span>This method gets the intra slice kpi from the statistic files</span></td>
 68 |   </tr><tr class="function">
 69 |     
 70 |     <td>Function</td>
 71 |     <td><code><a href="#getKPIsInter">getKPIsInter</a></code></td>
 72 |     <td><span>This method gets the inter Slice kpi from the statistic files</span></td>
 73 |   </tr><tr class="function">
 74 |     
 75 |     <td>Function</td>
 76 |     <td><code><a href="#makeTimePlot">makeTimePlot</a></code></td>
 77 |     <td><span>This method makes basic time plots. Labels deppend on which kpi is being plotted.</span></td>
 78 |   </tr><tr class="function">
 79 |     
 80 |     <td>Function</td>
 81 |     <td><code><a href="#makeIntraSlicePlot">makeIntraSlicePlot</a></code></td>
 82 |     <td><span>This method makes and stores any Intra Slice plot</span></td>
 83 |   </tr><tr class="function">
 84 |     
 85 |     <td>Function</td>
 86 |     <td><code><a href="#makeInterSlicePlot">makeInterSlicePlot</a></code></td>
 87 |     <td><span>This method makes and stores any Inter Slice plot</span></td>
 88 |   </tr><tr class="function">
 89 |     
 90 |     <td>Function</td>
 91 |     <td><code><a href="#makePlotsIntra">makePlotsIntra</a></code></td>
 92 |     <td><span>This method makes all Intra Slice kpi plots</span></td>
 93 |   </tr><tr class="function">
 94 |     
 95 |     <td>Function</td>
 96 |     <td><code><a href="#makePlotsInter">makePlotsInter</a></code></td>
 97 |     <td><span>This method makes all Inter Slice kpi plots</span></td>
 98 |   </tr>
 99 | </table>
100 |         
101 | 
102 |           
103 |       </div>
104 | 
105 |       <div id="childList">
106 | 
107 |         <div class="basefunction">
108 |   
109 |   <a name="Py5cheSim.Results.initialSinrGenerator">
110 |     
111 |   </a>
112 |   <a name="initialSinrGenerator">
113 |     
114 |   </a>
115 |   <div class="functionHeader">
116 |     
117 |     <span class="py-keyword">def</span> <span class="py-defname">initialSinrGenerator</span>(n_ues, refValue):
118 |     
119 |   </div>
120 |   <div class="docstring functionBody">
121 |     
122 |     
123 |     <div><p>Auxiliary method for SINR generation. This method is used to generate initial UE SINR. Later, during the simulation SINR will have small variations with time.</p></div>
124 |   </div>
125 | </div><div class="basefunction">
126 |   
127 |   <a name="Py5cheSim.Results.printResults">
128 |     
129 |   </a>
130 |   <a name="printResults">
131 |     
132 |   </a>
133 |   <div class="functionHeader">
134 |     
135 |     <span class="py-keyword">def</span> <span class="py-defname">printResults</span>(dir, users, num_users, scheduler, t_sim, singleRunMode, fileSINR, sinr):
136 |     
137 |   </div>
138 |   <div class="docstring functionBody">
139 |     
140 |     
141 |     <div><p>This method prints main simulation results on the terminal</p></div>
142 |   </div>
143 | </div><div class="basefunction">
144 |   
145 |   <a name="Py5cheSim.Results.getKPIs">
146 |     
147 |   </a>
148 |   <a name="getKPIs">
149 |     
150 |   </a>
151 |   <div class="functionHeader">
152 |     
153 |     <span class="py-keyword">def</span> <span class="py-defname">getKPIs</span>(dir, stFile, users, num_users, sinr_0, measInterv, tSim):
154 |     
155 |   </div>
156 |   <div class="docstring functionBody">
157 |     
158 |     
159 |     <div><p>This method gets the intra slice kpi from the statistic files</p></div>
160 |   </div>
161 | </div><div class="basefunction">
162 |   
163 |   <a name="Py5cheSim.Results.getKPIsInter">
164 |     
165 |   </a>
166 |   <a name="getKPIsInter">
167 |     
168 |   </a>
169 |   <div class="functionHeader">
170 |     
171 |     <span class="py-keyword">def</span> <span class="py-defname">getKPIsInter</span>(dir, stFile, slices, num_slices):
172 |     
173 |   </div>
174 |   <div class="docstring functionBody">
175 |     
176 |     
177 |     <div><p>This method gets the inter Slice kpi from the statistic files</p></div>
178 |   </div>
179 | </div><div class="basefunction">
180 |   
181 |   <a name="Py5cheSim.Results.makeTimePlot">
182 |     
183 |   </a>
184 |   <a name="makeTimePlot">
185 |     
186 |   </a>
187 |   <div class="functionHeader">
188 |     
189 |     <span class="py-keyword">def</span> <span class="py-defname">makeTimePlot</span>(u, plotName, plotType, xAx, yAx):
190 |     
191 |   </div>
192 |   <div class="docstring functionBody">
193 |     
194 |     
195 |     <div><p>This method makes basic time plots. Labels deppend on which kpi is being plotted.</p></div>
196 |   </div>
197 | </div><div class="basefunction">
198 |   
199 |   <a name="Py5cheSim.Results.makeIntraSlicePlot">
200 |     
201 |   </a>
202 |   <a name="makeIntraSlicePlot">
203 |     
204 |   </a>
205 |   <div class="functionHeader">
206 |     
207 |     <span class="py-keyword">def</span> <span class="py-defname">makeIntraSlicePlot</span>(plotName, plotType, xAx, yAx, slcLbl, bw, sch, gran):
208 |     
209 |   </div>
210 |   <div class="docstring functionBody">
211 |     
212 |     
213 |     <div><p>This method makes and stores any Intra Slice plot</p></div>
214 |   </div>
215 | </div><div class="basefunction">
216 |   
217 |   <a name="Py5cheSim.Results.makeInterSlicePlot">
218 |     
219 |   </a>
220 |   <a name="makeInterSlicePlot">
221 |     
222 |   </a>
223 |   <div class="functionHeader">
224 |     
225 |     <span class="py-keyword">def</span> <span class="py-defname">makeInterSlicePlot</span>(plotName, plotType, xAx, yAx, bw, sch, gran):
226 |     
227 |   </div>
228 |   <div class="docstring functionBody">
229 |     
230 |     
231 |     <div><p>This method makes and stores any Inter Slice plot</p></div>
232 |   </div>
233 | </div><div class="basefunction">
234 |   
235 |   <a name="Py5cheSim.Results.makePlotsIntra">
236 |     
237 |   </a>
238 |   <a name="makePlotsIntra">
239 |     
240 |   </a>
241 |   <div class="functionHeader">
242 |     
243 |     <span class="py-keyword">def</span> <span class="py-defname">makePlotsIntra</span>(dir, times, sinr, mcs, rU, plr, th, slcLbl, bw, sch, gr):
244 |     
245 |   </div>
246 |   <div class="docstring functionBody">
247 |     
248 |     
249 |     <div><p>This method makes all Intra Slice kpi plots</p></div>
250 |   </div>
251 | </div><div class="basefunction">
252 |   
253 |   <a name="Py5cheSim.Results.makePlotsInter">
254 |     
255 |   </a>
256 |   <a name="makePlotsInter">
257 |     
258 |   </a>
259 |   <div class="functionHeader">
260 |     
261 |     <span class="py-keyword">def</span> <span class="py-defname">makePlotsInter</span>(dir, times, res, plr, th, cnx, buf, met, bw, schIn, gr):
262 |     
263 |   </div>
264 |   <div class="docstring functionBody">
265 |     
266 |     
267 |     <div><p>This method makes all Inter Slice kpi plots</p></div>
268 |   </div>
269 | </div>
270 | 
271 |       </div>
272 |       <address>
273 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
274 |       </address>
275 | 
276 |     </div>
277 | 
278 |     <script src="pydoctor.js" type="text/javascript"></script>
279 | 
280 |   </body>
281 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Scheds_Inter.PF_Scheduler.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.Scheds_Inter.PF_Scheduler : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Scheds_Inter.html">Scheds_Inter</a></code>.<code><a href="Py5cheSim.Scheds_Inter.PF_Scheduler.html">PF_Scheduler</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">PF_Scheduler</span>(<span title="InterSliceSch.InterSliceScheduler">InterSliceScheduler</span>):</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.Scheds_Inter.PF_Scheduler">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class implements Proportional Fair inter slice scheduling algorithm.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id17">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#sch">sch</a></code></td>
 57 |     <td><span>String formatted as PFXY, with X=numerator exponent for metric formula, and Y=denominator exponent.</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#rcvdBytesLen">rcvdBytesLen</a></code></td>
 62 |     <td><span>rcvdBytes list length in Slice instance. No more that rcvdBytesLen values are stored.</span></td>
 63 |   </tr><tr class="method">
 64 |     
 65 |     <td>Method</td>
 66 |     <td><code><a href="#resAlloc">resAlloc</a></code></td>
 67 |     <td><span>This method implements Proportional Fair resource allocation between the different configured slices. This PEM method overwrites the resAlloc method from InterSliceScheduler class.</span></td>
 68 |   </tr><tr class="method">
 69 |     
 70 |     <td>Method</td>
 71 |     <td><code><a href="#setMetric">setMetric</a></code></td>
 72 |     <td><span>This method sets the PF metric for each slice</span></td>
 73 |   </tr><tr class="method">
 74 |     
 75 |     <td>Method</td>
 76 |     <td><code><a href="#findMaxMetSlice">findMaxMetSlice</a></code></td>
 77 |     <td><span>This method finds and returns the Slice with the highest metric</span></td>
 78 |   </tr><tr class="method">
 79 |     
 80 |     <td>Method</td>
 81 |     <td><code><a href="#assign2aSlice">assign2aSlice</a></code></td>
 82 |     <td><span>This method allocates cell's PRBs to the indicated slice</span></td>
 83 |   </tr><tr class="method">
 84 |     
 85 |     <td>Method</td>
 86 |     <td><code><a href="#printSliceConfig">printSliceConfig</a></code></td>
 87 |     <td><span>This method stores inter slice scheduling debugging information on the log file, adding PF metric values.</span></td>
 88 |   </tr>
 89 | </table>
 90 |         
 91 | 
 92 |           
 93 |       </div>
 94 | 
 95 |       <div id="childList">
 96 | 
 97 |         <div class="basemethod">
 98 |   
 99 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.__init__">
100 |     
101 |   </a>
102 |   <a name="__init__">
103 |     
104 |   </a>
105 |   <div class="functionHeader">
106 |     
107 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, ba, fr, dm, tdd, gr, sch):
108 |     
109 |   </div>
110 |   <div class="docstring functionBody">
111 |     
112 |     
113 |     <div><p class="undocumented">Undocumented</p></div>
114 |   </div>
115 | </div><div class="baseinstancevariable">
116 |   
117 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.sch">
118 |     
119 |   </a>
120 |   <a name="sch">
121 |     
122 |   </a>
123 |   <div class="functionHeader">
124 |     
125 |     <span class="py-defname">sch</span> =
126 |     
127 |   </div>
128 |   <div class="functionBody">
129 |     
130 |     
131 |     <div><p>String formatted as PFXY, with X=numerator exponent for metric formula, and Y=denominator exponent.</p></div>
132 |   </div>
133 | </div><div class="baseinstancevariable">
134 |   
135 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.rcvdBytesLen">
136 |     
137 |   </a>
138 |   <a name="rcvdBytesLen">
139 |     
140 |   </a>
141 |   <div class="functionHeader">
142 |     
143 |     <span class="py-defname">rcvdBytesLen</span> =
144 |     
145 |   </div>
146 |   <div class="functionBody">
147 |     
148 |     
149 |     <div><p>rcvdBytes list length in Slice instance. No more that rcvdBytesLen values are stored.</p></div> (type: <code>int</code>)
150 |   </div>
151 | </div><div class="basemethod">
152 |   
153 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.resAlloc">
154 |     
155 |   </a>
156 |   <a name="resAlloc">
157 |     
158 |   </a>
159 |   <div class="functionHeader">
160 |     
161 |     <span class="py-keyword">def</span> <span class="py-defname">resAlloc</span>(self, env):
162 |     
163 |   </div>
164 |   <div class="docstring functionBody">
165 |     
166 |     
167 |     <div><p>This method implements Proportional Fair resource allocation between the different configured slices. This PEM method overwrites the resAlloc method from InterSliceScheduler class.</p><p>Proportional Fair scheduler allocates all PRBs in the cell to the slice with the biggest metric. Metric for each slice is calculated as PossibleAverageUEtbs/ReceivedBytes.</p></div>
168 |   </div>
169 | </div><div class="basemethod">
170 |   
171 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.setMetric">
172 |     
173 |   </a>
174 |   <a name="setMetric">
175 |     
176 |   </a>
177 |   <div class="functionHeader">
178 |     
179 |     <span class="py-keyword">def</span> <span class="py-defname">setMetric</span>(self, exp_n, exp_d):
180 |     
181 |   </div>
182 |   <div class="docstring functionBody">
183 |     
184 |     
185 |     <div><p>This method sets the PF metric for each slice</p></div>
186 |   </div>
187 | </div><div class="basemethod">
188 |   
189 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.findMaxMetSlice">
190 |     
191 |   </a>
192 |   <a name="findMaxMetSlice">
193 |     
194 |   </a>
195 |   <div class="functionHeader">
196 |     
197 |     <span class="py-keyword">def</span> <span class="py-defname">findMaxMetSlice</span>(self):
198 |     
199 |   </div>
200 |   <div class="docstring functionBody">
201 |     
202 |     
203 |     <div><p>This method finds and returns the Slice with the highest metric</p></div>
204 |   </div>
205 | </div><div class="basemethod">
206 |   
207 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.assign2aSlice">
208 |     
209 |   </a>
210 |   <a name="assign2aSlice">
211 |     
212 |   </a>
213 |   <div class="functionHeader">
214 |     
215 |     <span class="py-keyword">def</span> <span class="py-defname">assign2aSlice</span>(self, slice):
216 |     
217 |   </div>
218 |   <div class="docstring functionBody">
219 |     
220 |     
221 |     <div><p>This method allocates cell's PRBs to the indicated slice</p></div>
222 |   </div>
223 | </div><div class="basemethod">
224 |   
225 |   <a name="Py5cheSim.Scheds_Inter.PF_Scheduler.printSliceConfig">
226 |     
227 |   </a>
228 |   <a name="printSliceConfig">
229 |     
230 |   </a>
231 |   <div class="functionHeader">
232 |     
233 |     <span class="py-keyword">def</span> <span class="py-defname">printSliceConfig</span>(self, slice):
234 |     
235 |   </div>
236 |   <div class="docstring functionBody">
237 |     
238 |     
239 |     <div><p>This method stores inter slice scheduling debugging information on the log file, adding PF metric values.</p></div>
240 |   </div>
241 | </div>
242 | 
243 |       </div>
244 |       <address>
245 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
246 |       </address>
247 | 
248 |     </div>
249 | 
250 |     <script src="pydoctor.js" type="text/javascript"></script>
251 | 
252 |   </body>
253 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Scheds_Inter.RRplus_Scheduler.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.Scheds_Inter.RRplus_Scheduler : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Scheds_Inter.html">Scheds_Inter</a></code>.<code><a href="Py5cheSim.Scheds_Inter.RRplus_Scheduler.html">RRplus_Scheduler</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">RRplus_Scheduler</span>(<span title="InterSliceSch.InterSliceScheduler">InterSliceScheduler</span>):</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.Scheds_Inter.RRplus_Scheduler">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class implements Round Robin Plus inter slice scheduling algorithm.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id16">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="method">
 54 |     
 55 |     <td>Method</td>
 56 |     <td><code><a href="#resAlloc">resAlloc</a></code></td>
 57 |     <td><span>This method implements Round Robin Plus PRB allocation between the different configured slices. This PEM method overwrites the resAlloc method from InterSliceScheduler class.</span></td>
 58 |   </tr>
 59 | </table>
 60 |         
 61 | 
 62 |           
 63 |       </div>
 64 | 
 65 |       <div id="childList">
 66 | 
 67 |         <div class="basemethod">
 68 |   
 69 |   <a name="Py5cheSim.Scheds_Inter.RRplus_Scheduler.__init__">
 70 |     
 71 |   </a>
 72 |   <a name="__init__">
 73 |     
 74 |   </a>
 75 |   <div class="functionHeader">
 76 |     
 77 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, ba, fr, dm, tdd, gr):
 78 |     
 79 |   </div>
 80 |   <div class="docstring functionBody">
 81 |     
 82 |     
 83 |     <div><p class="undocumented">Undocumented</p></div>
 84 |   </div>
 85 | </div><div class="basemethod">
 86 |   
 87 |   <a name="Py5cheSim.Scheds_Inter.RRplus_Scheduler.resAlloc">
 88 |     
 89 |   </a>
 90 |   <a name="resAlloc">
 91 |     
 92 |   </a>
 93 |   <div class="functionHeader">
 94 |     
 95 |     <span class="py-keyword">def</span> <span class="py-defname">resAlloc</span>(self, env):
 96 |     
 97 |   </div>
 98 |   <div class="docstring functionBody">
 99 |     
100 |     
101 |     <div><p>This method implements Round Robin Plus PRB allocation between the different configured slices. This PEM method overwrites the resAlloc method from InterSliceScheduler class.</p><p>Round Robin Plus scheduler allocates the same amount of resources to each slice with packets in buffer.</p></div>
102 |   </div>
103 | </div>
104 | 
105 |       </div>
106 |       <address>
107 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
108 |       </address>
109 | 
110 |     </div>
111 | 
112 |     <script src="pydoctor.js" type="text/javascript"></script>
113 | 
114 |   </body>
115 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Scheds_Inter.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Py5cheSim.Scheds_Inter : API documentation</title>
 7 | 
 8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
11 |   </head>
12 |   <body>
13 | 
14 |     <nav class="navbar navbar-default">
15 |       <div class="container">
16 |         <div class="navbar-header navbar-brand">
17 |           Py5cheSim
18 |           <a href="index.html">API Documentation</a>
19 |         </div>
20 |       </div>
21 |     </nav>
22 | 
23 |     <div class="container">
24 | 
25 |       <div class="page-header">
26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Scheds_Inter.html">Scheds_Inter</a></code></code></h1>
27 |         <div id="showPrivate">
28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
29 |         </div>
30 |       </div>
31 | 
32 |       <div class="categoryHeader">
33 |         module documentation
34 |       </div>
35 | 
36 |       <div class="extrasDocstring">
37 |         
38 |         <p></p>
39 |       </div>
40 | 
41 |       <div class="moduleDocstring">
42 |         <div><p>This module contains different implemented inter slice schedulers. New schedulers should be implemented here following the current structure.</p></div>
43 |       </div>
44 | 
45 |       <div id="splitTables">
46 |         <table class="children sortable" id="id15">
47 |   
48 |   <tr class="class">
49 |     
50 |     <td>Class</td>
51 |     <td><code><a href="Py5cheSim.Scheds_Inter.RRplus_Scheduler.html">RRplus_Scheduler</a></code></td>
52 |     <td><span>This class implements Round Robin Plus inter slice scheduling algorithm.</span></td>
53 |   </tr><tr class="class">
54 |     
55 |     <td>Class</td>
56 |     <td><code><a href="Py5cheSim.Scheds_Inter.PF_Scheduler.html">PF_Scheduler</a></code></td>
57 |     <td><span>This class implements Proportional Fair inter slice scheduling algorithm.</span></td>
58 |   </tr>
59 | </table>
60 |         
61 | 
62 |           
63 |       </div>
64 | 
65 |       <div id="childList">
66 | 
67 |         
68 | 
69 |       </div>
70 |       <address>
71 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
72 |       </address>
73 | 
74 |     </div>
75 | 
76 |     <script src="pydoctor.js" type="text/javascript"></script>
77 | 
78 |   </body>
79 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Scheds_Intra.PF_Scheduler.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.Scheds_Intra.PF_Scheduler : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Scheds_Intra.html">Scheds_Intra</a></code>.<code><a href="Py5cheSim.Scheds_Intra.PF_Scheduler.html">PF_Scheduler</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">PF_Scheduler</span>(<span title="IntraSliceSch.IntraSliceScheduler">IntraSliceScheduler</span>):</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.Scheds_Intra.PF_Scheduler">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class implements Proportional Fair intra slice scheduling algorithm.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id19">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#promLen">promLen</a></code></td>
 57 |     <td><span>Past Throughput average length considered in PF metric</span></td>
 58 |   </tr><tr class="method">
 59 |     
 60 |     <td>Method</td>
 61 |     <td><code><a href="#resAlloc">resAlloc</a></code></td>
 62 |     <td><span>This method implements Proportional Fair resource allocation between the different connected UEs. This method overwrites the resAlloc method from IntraSliceScheduler class.</span></td>
 63 |   </tr><tr class="method">
 64 |     
 65 |     <td>Method</td>
 66 |     <td><code><a href="#setUEfactor">setUEfactor</a></code></td>
 67 |     <td><span>This method sets the PF metric for each UE</span></td>
 68 |   </tr><tr class="method">
 69 |     
 70 |     <td>Method</td>
 71 |     <td><code><a href="#findMaxFactor">findMaxFactor</a></code></td>
 72 |     <td><span>This method finds and returns the UE with the highest metric</span></td>
 73 |   </tr><tr class="method">
 74 |     
 75 |     <td>Method</td>
 76 |     <td><code><a href="#printResAlloc">printResAlloc</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr>
 79 | </table>
 80 |         
 81 | 
 82 |           
 83 |       </div>
 84 | 
 85 |       <div id="childList">
 86 | 
 87 |         <div class="basemethod">
 88 |   
 89 |   <a name="Py5cheSim.Scheds_Intra.PF_Scheduler.__init__">
 90 |     
 91 |   </a>
 92 |   <a name="__init__">
 93 |     
 94 |   </a>
 95 |   <div class="functionHeader">
 96 |     
 97 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, ba, n, debMd, sLod, ttiByms, mmd_, ly_, dir, Smb, robustMCS, slcLbl, sch):
 98 |     
 99 |   </div>
100 |   <div class="docstring functionBody">
101 |     
102 |     
103 |     <div><p class="undocumented">Undocumented</p></div>
104 |   </div>
105 | </div><div class="baseinstancevariable">
106 |   
107 |   <a name="Py5cheSim.Scheds_Intra.PF_Scheduler.promLen">
108 |     
109 |   </a>
110 |   <a name="promLen">
111 |     
112 |   </a>
113 |   <div class="functionHeader">
114 |     
115 |     <span class="py-defname">promLen</span> =
116 |     
117 |   </div>
118 |   <div class="functionBody">
119 |     
120 |     
121 |     <div><p>Past Throughput average length considered in PF metric</p></div> (type: <code>int</code>)
122 |   </div>
123 | </div><div class="basemethod">
124 |   
125 |   <a name="Py5cheSim.Scheds_Intra.PF_Scheduler.resAlloc">
126 |     
127 |   </a>
128 |   <a name="resAlloc">
129 |     
130 |   </a>
131 |   <div class="functionHeader">
132 |     
133 |     <span class="py-keyword">def</span> <span class="py-defname">resAlloc</span>(self, band):
134 |     
135 |   </div>
136 |   <div class="docstring functionBody">
137 |     
138 |     
139 |     <div><p>This method implements Proportional Fair resource allocation between the different connected UEs. This method overwrites the resAlloc method from IntraSliceScheduler class.</p><p>Proportional Fair scheduler allocates all PRBs in the slice to the UE with the biggest metric. Metric for each UE is calculated as PossibleUEtbs/AveragePastTbs.</p></div>
140 |   </div>
141 | </div><div class="basemethod">
142 |   
143 |   <a name="Py5cheSim.Scheds_Intra.PF_Scheduler.setUEfactor">
144 |     
145 |   </a>
146 |   <a name="setUEfactor">
147 |     
148 |   </a>
149 |   <div class="functionHeader">
150 |     
151 |     <span class="py-keyword">def</span> <span class="py-defname">setUEfactor</span>(self, exp_n, exp_d):
152 |     
153 |   </div>
154 |   <div class="docstring functionBody">
155 |     
156 |     
157 |     <div><p>This method sets the PF metric for each UE</p></div>
158 |   </div>
159 | </div><div class="basemethod">
160 |   
161 |   <a name="Py5cheSim.Scheds_Intra.PF_Scheduler.findMaxFactor">
162 |     
163 |   </a>
164 |   <a name="findMaxFactor">
165 |     
166 |   </a>
167 |   <div class="functionHeader">
168 |     
169 |     <span class="py-keyword">def</span> <span class="py-defname">findMaxFactor</span>(self):
170 |     
171 |   </div>
172 |   <div class="docstring functionBody">
173 |     
174 |     
175 |     <div><p>This method finds and returns the UE with the highest metric</p></div>
176 |   </div>
177 | </div><div class="basemethod">
178 |   
179 |   <a name="Py5cheSim.Scheds_Intra.PF_Scheduler.printResAlloc">
180 |     
181 |   </a>
182 |   <a name="printResAlloc">
183 |     
184 |   </a>
185 |   <div class="functionHeader">
186 |     
187 |     <span class="py-keyword">def</span> <span class="py-defname">printResAlloc</span>(self):
188 |     
189 |   </div>
190 |   <div class="docstring functionBody">
191 |     
192 |     
193 |     <div><p class="undocumented">Undocumented</p></div>
194 |   </div>
195 | </div>
196 | 
197 |       </div>
198 |       <address>
199 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
200 |       </address>
201 | 
202 |     </div>
203 | 
204 |     <script src="pydoctor.js" type="text/javascript"></script>
205 | 
206 |   </body>
207 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Scheds_Intra.TBqueueTDD.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.Scheds_Intra.TBqueueTDD : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Scheds_Intra.html">Scheds_Intra</a></code>.<code><a href="Py5cheSim.Scheds_Intra.TBqueueTDD.html">TBqueueTDD</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">TBqueueTDD</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.Scheds_Intra.TBqueueTDD">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class is used to model scheduler TB queue in TDD scheduler.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id21">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#res">res</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#numRes">numRes</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="method">
 64 |     
 65 |     <td>Method</td>
 66 |     <td><code><a href="#getFreeSpace">getFreeSpace</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="method">
 69 |     
 70 |     <td>Method</td>
 71 |     <td><code><a href="#insertTB">insertTB</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="method">
 74 |     
 75 |     <td>Method</td>
 76 |     <td><code><a href="#removeTB">removeTB</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="method">
 79 |     
 80 |     <td>Method</td>
 81 |     <td><code><a href="#updateSize">updateSize</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr>
 84 | </table>
 85 |         
 86 | 
 87 |           
 88 |       </div>
 89 | 
 90 |       <div id="childList">
 91 | 
 92 |         <div class="basemethod">
 93 |   
 94 |   <a name="Py5cheSim.Scheds_Intra.TBqueueTDD.__init__">
 95 |     
 96 |   </a>
 97 |   <a name="__init__">
 98 |     
 99 |   </a>
100 |   <div class="functionHeader">
101 |     
102 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, symb):
103 |     
104 |   </div>
105 |   <div class="docstring functionBody">
106 |     
107 |     
108 |     <div><p class="undocumented">Undocumented</p></div>
109 |   </div>
110 | </div><div class="baseinstancevariable">
111 |   
112 |   <a name="Py5cheSim.Scheds_Intra.TBqueueTDD.res">
113 |     
114 |   </a>
115 |   <a name="res">
116 |     
117 |   </a>
118 |   <div class="functionHeader">
119 |     
120 |     <span class="py-defname">res</span> =
121 |     
122 |   </div>
123 |   <div class="functionBody">
124 |     
125 |     
126 |     <div><p class="undocumented">Undocumented</p></div>
127 |   </div>
128 | </div><div class="baseinstancevariable">
129 |   
130 |   <a name="Py5cheSim.Scheds_Intra.TBqueueTDD.numRes">
131 |     
132 |   </a>
133 |   <a name="numRes">
134 |     
135 |   </a>
136 |   <div class="functionHeader">
137 |     
138 |     <span class="py-defname">numRes</span> =
139 |     
140 |   </div>
141 |   <div class="functionBody">
142 |     
143 |     
144 |     <div><p class="undocumented">Undocumented</p></div>
145 |   </div>
146 | </div><div class="basemethod">
147 |   
148 |   <a name="Py5cheSim.Scheds_Intra.TBqueueTDD.getFreeSpace">
149 |     
150 |   </a>
151 |   <a name="getFreeSpace">
152 |     
153 |   </a>
154 |   <div class="functionHeader">
155 |     
156 |     <span class="py-keyword">def</span> <span class="py-defname">getFreeSpace</span>(self):
157 |     
158 |   </div>
159 |   <div class="docstring functionBody">
160 |     
161 |     
162 |     <div><p class="undocumented">Undocumented</p></div>
163 |   </div>
164 | </div><div class="basemethod">
165 |   
166 |   <a name="Py5cheSim.Scheds_Intra.TBqueueTDD.insertTB">
167 |     
168 |   </a>
169 |   <a name="insertTB">
170 |     
171 |   </a>
172 |   <div class="functionHeader">
173 |     
174 |     <span class="py-keyword">def</span> <span class="py-defname">insertTB</span>(self, tb):
175 |     
176 |   </div>
177 |   <div class="docstring functionBody">
178 |     
179 |     
180 |     <div><p class="undocumented">Undocumented</p></div>
181 |   </div>
182 | </div><div class="basemethod">
183 |   
184 |   <a name="Py5cheSim.Scheds_Intra.TBqueueTDD.removeTB">
185 |     
186 |   </a>
187 |   <a name="removeTB">
188 |     
189 |   </a>
190 |   <div class="functionHeader">
191 |     
192 |     <span class="py-keyword">def</span> <span class="py-defname">removeTB</span>(self):
193 |     
194 |   </div>
195 |   <div class="docstring functionBody">
196 |     
197 |     
198 |     <div><p class="undocumented">Undocumented</p></div>
199 |   </div>
200 | </div><div class="basemethod">
201 |   
202 |   <a name="Py5cheSim.Scheds_Intra.TBqueueTDD.updateSize">
203 |     
204 |   </a>
205 |   <a name="updateSize">
206 |     
207 |   </a>
208 |   <div class="functionHeader">
209 |     
210 |     <span class="py-keyword">def</span> <span class="py-defname">updateSize</span>(self, newSize):
211 |     
212 |   </div>
213 |   <div class="docstring functionBody">
214 |     
215 |     
216 |     <div><p class="undocumented">Undocumented</p></div>
217 |   </div>
218 | </div>
219 | 
220 |       </div>
221 |       <address>
222 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
223 |       </address>
224 | 
225 |     </div>
226 | 
227 |     <script src="pydoctor.js" type="text/javascript"></script>
228 | 
229 |   </body>
230 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Scheds_Intra.TDD_Scheduler.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.Scheds_Intra.TDD_Scheduler : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Scheds_Intra.html">Scheds_Intra</a></code>.<code><a href="Py5cheSim.Scheds_Intra.TDD_Scheduler.html">TDD_Scheduler</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">TDD_Scheduler</span>(<span title="IntraSliceSch.IntraSliceScheduler">IntraSliceScheduler</span>):</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.Scheds_Intra.TDD_Scheduler">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class implements TDD intra slice scheduling.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id20">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#symMax">symMax</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#queue">queue</a></code></td>
 62 |     <td><span>TDD scheduler TB queue.</span></td>
 63 |   </tr><tr class="method">
 64 |     
 65 |     <td>Method</td>
 66 |     <td><code><a href="#resAlloc">resAlloc</a></code></td>
 67 |     <td><span>This method implements resource allocation between the different connected UEs in a TDD slice.</span></td>
 68 |   </tr><tr class="method">
 69 |     
 70 |     <td>Method</td>
 71 |     <td><code><a href="#queueUpdate">queueUpdate</a></code></td>
 72 |     <td><span>This method fills scheduler TB queue at each TTI with TBs built with UE data/signalling bytes.</span></td>
 73 |   </tr><tr class="instancevariable">
 74 |     
 75 |     <td>Instance Variable</td>
 76 |     <td><code><a href="#ueLst">ueLst</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="instancevariable">
 79 |     
 80 |     <td>Instance Variable</td>
 81 |     <td><code><a href="#sm_lim">sm_lim</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr><tr class="method">
 84 |     
 85 |     <td>Method</td>
 86 |     <td><code><a href="#rrcUncstSigIn">rrcUncstSigIn</a></code></td>
 87 |     <td><span class="undocumented">Undocumented</span></td>
 88 |   </tr><tr class="method">
 89 |     
 90 |     <td>Method</td>
 91 |     <td><code><a href="#retransmitTB">retransmitTB</a></code></td>
 92 |     <td><span class="undocumented">Undocumented</span></td>
 93 |   </tr><tr class="method">
 94 |     
 95 |     <td>Method</td>
 96 |     <td><code><a href="#dataPtoTB">dataPtoTB</a></code></td>
 97 |     <td><span>This method takes UE data bytes, builds TB and puts them in the scheduler TB queue.</span></td>
 98 |   </tr><tr class="method">
 99 |     
100 |     <td>Method</td>
101 |     <td><code><a href="#setTBS">setTBS</a></code></td>
102 |     <td><span class="undocumented">Undocumented</span></td>
103 |   </tr><tr class="method">
104 |     
105 |     <td>Method</td>
106 |     <td><code><a href="#printResAlloc">printResAlloc</a></code></td>
107 |     <td><span class="undocumented">Undocumented</span></td>
108 |   </tr>
109 | </table>
110 |         
111 | 
112 |           
113 |       </div>
114 | 
115 |       <div id="childList">
116 | 
117 |         <div class="basemethod">
118 |   
119 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.__init__">
120 |     
121 |   </a>
122 |   <a name="__init__">
123 |     
124 |   </a>
125 |   <div class="functionHeader">
126 |     
127 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, ba, n, debMd, sLod, ttiByms, mmd_, ly_, dir, Smb, robustMCS, slcLbl, sch):
128 |     
129 |   </div>
130 |   <div class="docstring functionBody">
131 |     
132 |     
133 |     <div><p class="undocumented">Undocumented</p></div>
134 |   </div>
135 | </div><div class="baseinstancevariable">
136 |   
137 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.symMax">
138 |     
139 |   </a>
140 |   <a name="symMax">
141 |     
142 |   </a>
143 |   <div class="functionHeader">
144 |     
145 |     <span class="py-defname">symMax</span> =
146 |     
147 |   </div>
148 |   <div class="functionBody">
149 |     
150 |     
151 |     <div><p class="undocumented">Undocumented</p></div>
152 |   </div>
153 | </div><div class="baseinstancevariable">
154 |   
155 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.queue">
156 |     
157 |   </a>
158 |   <a name="queue">
159 |     
160 |   </a>
161 |   <div class="functionHeader">
162 |     
163 |     <span class="py-defname">queue</span> =
164 |     
165 |   </div>
166 |   <div class="functionBody">
167 |     
168 |     
169 |     <div><p>TDD scheduler TB queue.</p><p>IntraSliceScheduler class attribute queue is overwriten here by a new type of queue which handles symbols. This queue will contain as much TB as a slot can contain. If resource allocation is made in terms of slots, it will contain 1 element, else, it will contain as much mini-slots as can be supported in 1 slot.</p></div>
170 |   </div>
171 | </div><div class="basemethod">
172 |   
173 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.resAlloc">
174 |     
175 |   </a>
176 |   <a name="resAlloc">
177 |     
178 |   </a>
179 |   <div class="functionHeader">
180 |     
181 |     <span class="py-keyword">def</span> <span class="py-defname">resAlloc</span>(self, band):
182 |     
183 |   </div>
184 |   <div class="docstring functionBody">
185 |     
186 |     
187 |     <div><p>This method implements resource allocation between the different connected UEs in a TDD slice.</p><p>It overwrites the resAlloc method from IntraSliceScheduler class. In this Py5cheSim version TDD scheduler allocates all PRBs in the slice to a UE during 1 slot. Future Py5cheSim versions could support mini-slot allocation by changing the UE symbol allocation in this method. Note that in that case, althoug there is no need to update the queueUpdate method, TBS calculation must be adjusted to avoid losing capacity when trunking the Nre__ value.</p></div>
188 |   </div>
189 | </div><div class="basemethod">
190 |   
191 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.queueUpdate">
192 |     
193 |   </a>
194 |   <a name="queueUpdate">
195 |     
196 |   </a>
197 |   <div class="functionHeader">
198 |     
199 |     <span class="py-keyword">def</span> <span class="py-defname">queueUpdate</span>(self):
200 |     
201 |   </div>
202 |   <div class="docstring functionBody">
203 |     
204 |     
205 |     <div><p>This method fills scheduler TB queue at each TTI with TBs built with UE data/signalling bytes.</p><p>It overwrites queueUpdate method from IntraSliceScheduler class, making Resource allocation in terms of slot Symbols and insert generated TBs into Scheduler queue in a TTI. Althoug in this version Resource allocation is made by slot, it is prepared to support mini-slot resource allocation by handling a scheduler TB queue in terms of symbols.</p></div>
206 |   </div>
207 | </div><div class="baseinstancevariable">
208 |   
209 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.ueLst">
210 |     
211 |   </a>
212 |   <a name="ueLst">
213 |     
214 |   </a>
215 |   <div class="functionHeader">
216 |     
217 |     <span class="py-defname">ueLst</span> =
218 |     
219 |   </div>
220 |   <div class="functionBody">
221 |     
222 |     
223 |     <div><p class="undocumented">Undocumented</p></div>
224 |   </div>
225 | </div><div class="baseinstancevariable">
226 |   
227 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.sm_lim">
228 |     
229 |   </a>
230 |   <a name="sm_lim">
231 |     
232 |   </a>
233 |   <div class="functionHeader">
234 |     
235 |     <span class="py-defname">sm_lim</span> =
236 |     
237 |   </div>
238 |   <div class="functionBody">
239 |     
240 |     
241 |     <div><p class="undocumented">Undocumented</p></div>
242 |   </div>
243 | </div><div class="basemethod">
244 |   
245 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.rrcUncstSigIn">
246 |     
247 |   </a>
248 |   <a name="rrcUncstSigIn">
249 |     
250 |   </a>
251 |   <div class="functionHeader">
252 |     
253 |     <span class="py-keyword">def</span> <span class="py-defname">rrcUncstSigIn</span>(self, u):
254 |     
255 |   </div>
256 |   <div class="docstring functionBody">
257 |     
258 |     
259 |     <div><p class="undocumented">Undocumented</p></div>
260 |   </div>
261 | </div><div class="basemethod">
262 |   
263 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.retransmitTB">
264 |     
265 |   </a>
266 |   <a name="retransmitTB">
267 |     
268 |   </a>
269 |   <div class="functionHeader">
270 |     
271 |     <span class="py-keyword">def</span> <span class="py-defname">retransmitTB</span>(self, u):
272 |     
273 |   </div>
274 |   <div class="docstring functionBody">
275 |     
276 |     
277 |     <div><p class="undocumented">Undocumented</p></div>
278 |   </div>
279 | </div><div class="basemethod">
280 |   
281 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.dataPtoTB">
282 |     
283 |   </a>
284 |   <a name="dataPtoTB">
285 |     
286 |   </a>
287 |   <div class="functionHeader">
288 |     
289 |     <span class="py-keyword">def</span> <span class="py-defname">dataPtoTB</span>(self, u):
290 |     
291 |   </div>
292 |   <div class="docstring functionBody">
293 |     
294 |     
295 |     <div><p>This method takes UE data bytes, builds TB and puts them in the scheduler TB queue.</p><p>It overwrites dataPtoTB method from IntraSliceScheduler class. In this case it returns the amount of allocated symbols to the UE.</p></div>
296 |   </div>
297 | </div><div class="basemethod">
298 |   
299 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.setTBS">
300 |     
301 |   </a>
302 |   <a name="setTBS">
303 |     
304 |   </a>
305 |   <div class="functionHeader">
306 |     
307 |     <span class="py-keyword">def</span> <span class="py-defname">setTBS</span>(self, r, qm, uldl, u_, fr, nprb):
308 |     
309 |   </div>
310 |   <div class="docstring functionBody">
311 |     
312 |     
313 |     <div><p class="undocumented">Undocumented</p></div>
314 |   </div>
315 | </div><div class="basemethod">
316 |   
317 |   <a name="Py5cheSim.Scheds_Intra.TDD_Scheduler.printResAlloc">
318 |     
319 |   </a>
320 |   <a name="printResAlloc">
321 |     
322 |   </a>
323 |   <div class="functionHeader">
324 |     
325 |     <span class="py-keyword">def</span> <span class="py-defname">printResAlloc</span>(self):
326 |     
327 |   </div>
328 |   <div class="docstring functionBody">
329 |     
330 |     
331 |     <div><p class="undocumented">Undocumented</p></div>
332 |   </div>
333 | </div>
334 | 
335 |       </div>
336 |       <address>
337 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
338 |       </address>
339 | 
340 |     </div>
341 | 
342 |     <script src="pydoctor.js" type="text/javascript"></script>
343 | 
344 |   </body>
345 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Scheds_Intra.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Py5cheSim.Scheds_Intra : API documentation</title>
 7 | 
 8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
11 |   </head>
12 |   <body>
13 | 
14 |     <nav class="navbar navbar-default">
15 |       <div class="container">
16 |         <div class="navbar-header navbar-brand">
17 |           Py5cheSim
18 |           <a href="index.html">API Documentation</a>
19 |         </div>
20 |       </div>
21 |     </nav>
22 | 
23 |     <div class="container">
24 | 
25 |       <div class="page-header">
26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Scheds_Intra.html">Scheds_Intra</a></code></code></h1>
27 |         <div id="showPrivate">
28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
29 |         </div>
30 |       </div>
31 | 
32 |       <div class="categoryHeader">
33 |         module documentation
34 |       </div>
35 | 
36 |       <div class="extrasDocstring">
37 |         
38 |         <p></p>
39 |       </div>
40 | 
41 |       <div class="moduleDocstring">
42 |         <div><p>This module contains different implemented intra slice schedulers. New schedulers should be implemented here following the current structure.</p></div>
43 |       </div>
44 | 
45 |       <div id="splitTables">
46 |         <table class="children sortable" id="id18">
47 |   
48 |   <tr class="class">
49 |     
50 |     <td>Class</td>
51 |     <td><code><a href="Py5cheSim.Scheds_Intra.PF_Scheduler.html">PF_Scheduler</a></code></td>
52 |     <td><span>This class implements Proportional Fair intra slice scheduling algorithm.</span></td>
53 |   </tr><tr class="class">
54 |     
55 |     <td>Class</td>
56 |     <td><code><a href="Py5cheSim.Scheds_Intra.TDD_Scheduler.html">TDD_Scheduler</a></code></td>
57 |     <td><span>This class implements TDD intra slice scheduling.</span></td>
58 |   </tr><tr class="class">
59 |     
60 |     <td>Class</td>
61 |     <td><code><a href="Py5cheSim.Scheds_Intra.TBqueueTDD.html">TBqueueTDD</a></code></td>
62 |     <td><span>This class is used to model scheduler TB queue in TDD scheduler.</span></td>
63 |   </tr>
64 | </table>
65 |         
66 | 
67 |           
68 |       </div>
69 | 
70 |       <div id="childList">
71 | 
72 |         
73 | 
74 |       </div>
75 |       <address>
76 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
77 |       </address>
78 | 
79 |     </div>
80 | 
81 |     <script src="pydoctor.js" type="text/javascript"></script>
82 | 
83 |   </body>
84 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.Slice.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Py5cheSim.Slice : API documentation</title>
 7 | 
 8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
11 |   </head>
12 |   <body>
13 | 
14 |     <nav class="navbar navbar-default">
15 |       <div class="container">
16 |         <div class="navbar-header navbar-brand">
17 |           Py5cheSim
18 |           <a href="index.html">API Documentation</a>
19 |         </div>
20 |       </div>
21 |     </nav>
22 | 
23 |     <div class="container">
24 | 
25 |       <div class="page-header">
26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.Slice.html">Slice</a></code></code></h1>
27 |         <div id="showPrivate">
28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
29 |         </div>
30 |       </div>
31 | 
32 |       <div class="categoryHeader">
33 |         module documentation
34 |       </div>
35 | 
36 |       <div class="extrasDocstring">
37 |         
38 |         <p></p>
39 |       </div>
40 | 
41 |       <div class="moduleDocstring">
42 |         <div><p>This module contains the Slice class.</p></div>
43 |       </div>
44 | 
45 |       <div id="splitTables">
46 |         <table class="children sortable" id="id22">
47 |   
48 |   <tr class="class">
49 |     
50 |     <td>Class</td>
51 |     <td><code><a href="Py5cheSim.Slice.Slice.html">Slice</a></code></td>
52 |     <td><span>This class has Slice relative parameters and is used to implement the mapping between service requirements and slice configuration.</span></td>
53 |   </tr>
54 | </table>
55 |         
56 | 
57 |           
58 |       </div>
59 | 
60 |       <div id="childList">
61 | 
62 |         
63 | 
64 |       </div>
65 |       <address>
66 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
67 |       </address>
68 | 
69 |     </div>
70 | 
71 |     <script src="pydoctor.js" type="text/javascript"></script>
72 | 
73 |   </body>
74 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.UE.Bearer.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.UE.Bearer : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.UE.html">UE</a></code>.<code><a href="Py5cheSim.UE.Bearer.html">Bearer</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">Bearer</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.UE.Bearer">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class is used to model Bearers properties and behabiour.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id28">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#id">id</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#qci">qci</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="instancevariable">
 64 |     
 65 |     <td>Instance Variable</td>
 66 |     <td><code><a href="#type">type</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="instancevariable">
 69 |     
 70 |     <td>Instance Variable</td>
 71 |     <td><code><a href="#buffer">buffer</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr>
 74 | </table>
 75 |         
 76 | 
 77 |           
 78 |       </div>
 79 | 
 80 |       <div id="childList">
 81 | 
 82 |         <div class="basemethod">
 83 |   
 84 |   <a name="Py5cheSim.UE.Bearer.__init__">
 85 |     
 86 |   </a>
 87 |   <a name="__init__">
 88 |     
 89 |   </a>
 90 |   <div class="functionHeader">
 91 |     
 92 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, i, q, tp):
 93 |     
 94 |   </div>
 95 |   <div class="docstring functionBody">
 96 |     
 97 |     
 98 |     <div><p class="undocumented">Undocumented</p></div>
 99 |   </div>
100 | </div><div class="baseinstancevariable">
101 |   
102 |   <a name="Py5cheSim.UE.Bearer.id">
103 |     
104 |   </a>
105 |   <a name="id">
106 |     
107 |   </a>
108 |   <div class="functionHeader">
109 |     
110 |     <span class="py-defname">id</span> =
111 |     
112 |   </div>
113 |   <div class="functionBody">
114 |     
115 |     
116 |     <div><p class="undocumented">Undocumented</p></div>
117 |   </div>
118 | </div><div class="baseinstancevariable">
119 |   
120 |   <a name="Py5cheSim.UE.Bearer.qci">
121 |     
122 |   </a>
123 |   <a name="qci">
124 |     
125 |   </a>
126 |   <div class="functionHeader">
127 |     
128 |     <span class="py-defname">qci</span> =
129 |     
130 |   </div>
131 |   <div class="functionBody">
132 |     
133 |     
134 |     <div><p class="undocumented">Undocumented</p></div>
135 |   </div>
136 | </div><div class="baseinstancevariable">
137 |   
138 |   <a name="Py5cheSim.UE.Bearer.type">
139 |     
140 |   </a>
141 |   <a name="type">
142 |     
143 |   </a>
144 |   <div class="functionHeader">
145 |     
146 |     <span class="py-defname">type</span> =
147 |     
148 |   </div>
149 |   <div class="functionBody">
150 |     
151 |     
152 |     <div><p class="undocumented">Undocumented</p></div>
153 |   </div>
154 | </div><div class="baseinstancevariable">
155 |   
156 |   <a name="Py5cheSim.UE.Bearer.buffer">
157 |     
158 |   </a>
159 |   <a name="buffer">
160 |     
161 |   </a>
162 |   <div class="functionHeader">
163 |     
164 |     <span class="py-defname">buffer</span> =
165 |     
166 |   </div>
167 |   <div class="functionBody">
168 |     
169 |     
170 |     <div><p class="undocumented">Undocumented</p></div>
171 |   </div>
172 | </div>
173 | 
174 |       </div>
175 |       <address>
176 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
177 |       </address>
178 | 
179 |     </div>
180 | 
181 |     <script src="pydoctor.js" type="text/javascript"></script>
182 | 
183 |   </body>
184 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.UE.Format.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.UE.Format : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.UE.html">UE</a></code>.<code><a href="Py5cheSim.UE.Format.html">Format</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">Format</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.UE.Format">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p class="undocumented">Undocumented</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id31">
 47 |   
 48 |   <tr class="classvariable">
 49 |     
 50 |     <td>Class Variable</td>
 51 |     <td><code><a href="#CEND">CEND</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="classvariable">
 54 |     
 55 |     <td>Class Variable</td>
 56 |     <td><code><a href="#CBOLD">CBOLD</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="classvariable">
 59 |     
 60 |     <td>Class Variable</td>
 61 |     <td><code><a href="#CITALIC">CITALIC</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="classvariable">
 64 |     
 65 |     <td>Class Variable</td>
 66 |     <td><code><a href="#CURL">CURL</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="classvariable">
 69 |     
 70 |     <td>Class Variable</td>
 71 |     <td><code><a href="#CBLINK">CBLINK</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="classvariable">
 74 |     
 75 |     <td>Class Variable</td>
 76 |     <td><code><a href="#CBLINK2">CBLINK2</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="classvariable">
 79 |     
 80 |     <td>Class Variable</td>
 81 |     <td><code><a href="#CSELECTED">CSELECTED</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr><tr class="classvariable">
 84 |     
 85 |     <td>Class Variable</td>
 86 |     <td><code><a href="#CBLACK">CBLACK</a></code></td>
 87 |     <td><span class="undocumented">Undocumented</span></td>
 88 |   </tr><tr class="classvariable">
 89 |     
 90 |     <td>Class Variable</td>
 91 |     <td><code><a href="#CRED">CRED</a></code></td>
 92 |     <td><span class="undocumented">Undocumented</span></td>
 93 |   </tr><tr class="classvariable">
 94 |     
 95 |     <td>Class Variable</td>
 96 |     <td><code><a href="#CGREEN">CGREEN</a></code></td>
 97 |     <td><span class="undocumented">Undocumented</span></td>
 98 |   </tr><tr class="classvariable">
 99 |     
100 |     <td>Class Variable</td>
101 |     <td><code><a href="#CYELLOW">CYELLOW</a></code></td>
102 |     <td><span class="undocumented">Undocumented</span></td>
103 |   </tr><tr class="classvariable">
104 |     
105 |     <td>Class Variable</td>
106 |     <td><code><a href="#CBLUE">CBLUE</a></code></td>
107 |     <td><span class="undocumented">Undocumented</span></td>
108 |   </tr><tr class="classvariable">
109 |     
110 |     <td>Class Variable</td>
111 |     <td><code><a href="#CVIOLET">CVIOLET</a></code></td>
112 |     <td><span class="undocumented">Undocumented</span></td>
113 |   </tr><tr class="classvariable">
114 |     
115 |     <td>Class Variable</td>
116 |     <td><code><a href="#CBEIGE">CBEIGE</a></code></td>
117 |     <td><span class="undocumented">Undocumented</span></td>
118 |   </tr><tr class="classvariable">
119 |     
120 |     <td>Class Variable</td>
121 |     <td><code><a href="#CWHITE">CWHITE</a></code></td>
122 |     <td><span class="undocumented">Undocumented</span></td>
123 |   </tr><tr class="classvariable">
124 |     
125 |     <td>Class Variable</td>
126 |     <td><code><a href="#CGREENBG">CGREENBG</a></code></td>
127 |     <td><span class="undocumented">Undocumented</span></td>
128 |   </tr><tr class="classvariable">
129 |     
130 |     <td>Class Variable</td>
131 |     <td><code><a href="#CBLUEBG">CBLUEBG</a></code></td>
132 |     <td><span class="undocumented">Undocumented</span></td>
133 |   </tr>
134 | </table>
135 |         
136 | 
137 |           
138 |       </div>
139 | 
140 |       <div id="childList">
141 | 
142 |         <div class="baseclassvariable">
143 |   
144 |   <a name="Py5cheSim.UE.Format.CEND">
145 |     
146 |   </a>
147 |   <a name="CEND">
148 |     
149 |   </a>
150 |   <div class="functionHeader">
151 |     
152 |     <span class="py-defname">CEND</span> =
153 |     
154 |   </div>
155 |   <div class="functionBody">
156 |     
157 |     
158 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
159 |   </div>
160 | </div><div class="baseclassvariable">
161 |   
162 |   <a name="Py5cheSim.UE.Format.CBOLD">
163 |     
164 |   </a>
165 |   <a name="CBOLD">
166 |     
167 |   </a>
168 |   <div class="functionHeader">
169 |     
170 |     <span class="py-defname">CBOLD</span> =
171 |     
172 |   </div>
173 |   <div class="functionBody">
174 |     
175 |     
176 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
177 |   </div>
178 | </div><div class="baseclassvariable">
179 |   
180 |   <a name="Py5cheSim.UE.Format.CITALIC">
181 |     
182 |   </a>
183 |   <a name="CITALIC">
184 |     
185 |   </a>
186 |   <div class="functionHeader">
187 |     
188 |     <span class="py-defname">CITALIC</span> =
189 |     
190 |   </div>
191 |   <div class="functionBody">
192 |     
193 |     
194 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
195 |   </div>
196 | </div><div class="baseclassvariable">
197 |   
198 |   <a name="Py5cheSim.UE.Format.CURL">
199 |     
200 |   </a>
201 |   <a name="CURL">
202 |     
203 |   </a>
204 |   <div class="functionHeader">
205 |     
206 |     <span class="py-defname">CURL</span> =
207 |     
208 |   </div>
209 |   <div class="functionBody">
210 |     
211 |     
212 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
213 |   </div>
214 | </div><div class="baseclassvariable">
215 |   
216 |   <a name="Py5cheSim.UE.Format.CBLINK">
217 |     
218 |   </a>
219 |   <a name="CBLINK">
220 |     
221 |   </a>
222 |   <div class="functionHeader">
223 |     
224 |     <span class="py-defname">CBLINK</span> =
225 |     
226 |   </div>
227 |   <div class="functionBody">
228 |     
229 |     
230 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
231 |   </div>
232 | </div><div class="baseclassvariable">
233 |   
234 |   <a name="Py5cheSim.UE.Format.CBLINK2">
235 |     
236 |   </a>
237 |   <a name="CBLINK2">
238 |     
239 |   </a>
240 |   <div class="functionHeader">
241 |     
242 |     <span class="py-defname">CBLINK2</span> =
243 |     
244 |   </div>
245 |   <div class="functionBody">
246 |     
247 |     
248 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
249 |   </div>
250 | </div><div class="baseclassvariable">
251 |   
252 |   <a name="Py5cheSim.UE.Format.CSELECTED">
253 |     
254 |   </a>
255 |   <a name="CSELECTED">
256 |     
257 |   </a>
258 |   <div class="functionHeader">
259 |     
260 |     <span class="py-defname">CSELECTED</span> =
261 |     
262 |   </div>
263 |   <div class="functionBody">
264 |     
265 |     
266 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
267 |   </div>
268 | </div><div class="baseclassvariable">
269 |   
270 |   <a name="Py5cheSim.UE.Format.CBLACK">
271 |     
272 |   </a>
273 |   <a name="CBLACK">
274 |     
275 |   </a>
276 |   <div class="functionHeader">
277 |     
278 |     <span class="py-defname">CBLACK</span> =
279 |     
280 |   </div>
281 |   <div class="functionBody">
282 |     
283 |     
284 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
285 |   </div>
286 | </div><div class="baseclassvariable">
287 |   
288 |   <a name="Py5cheSim.UE.Format.CRED">
289 |     
290 |   </a>
291 |   <a name="CRED">
292 |     
293 |   </a>
294 |   <div class="functionHeader">
295 |     
296 |     <span class="py-defname">CRED</span> =
297 |     
298 |   </div>
299 |   <div class="functionBody">
300 |     
301 |     
302 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
303 |   </div>
304 | </div><div class="baseclassvariable">
305 |   
306 |   <a name="Py5cheSim.UE.Format.CGREEN">
307 |     
308 |   </a>
309 |   <a name="CGREEN">
310 |     
311 |   </a>
312 |   <div class="functionHeader">
313 |     
314 |     <span class="py-defname">CGREEN</span> =
315 |     
316 |   </div>
317 |   <div class="functionBody">
318 |     
319 |     
320 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
321 |   </div>
322 | </div><div class="baseclassvariable">
323 |   
324 |   <a name="Py5cheSim.UE.Format.CYELLOW">
325 |     
326 |   </a>
327 |   <a name="CYELLOW">
328 |     
329 |   </a>
330 |   <div class="functionHeader">
331 |     
332 |     <span class="py-defname">CYELLOW</span> =
333 |     
334 |   </div>
335 |   <div class="functionBody">
336 |     
337 |     
338 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
339 |   </div>
340 | </div><div class="baseclassvariable">
341 |   
342 |   <a name="Py5cheSim.UE.Format.CBLUE">
343 |     
344 |   </a>
345 |   <a name="CBLUE">
346 |     
347 |   </a>
348 |   <div class="functionHeader">
349 |     
350 |     <span class="py-defname">CBLUE</span> =
351 |     
352 |   </div>
353 |   <div class="functionBody">
354 |     
355 |     
356 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
357 |   </div>
358 | </div><div class="baseclassvariable">
359 |   
360 |   <a name="Py5cheSim.UE.Format.CVIOLET">
361 |     
362 |   </a>
363 |   <a name="CVIOLET">
364 |     
365 |   </a>
366 |   <div class="functionHeader">
367 |     
368 |     <span class="py-defname">CVIOLET</span> =
369 |     
370 |   </div>
371 |   <div class="functionBody">
372 |     
373 |     
374 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
375 |   </div>
376 | </div><div class="baseclassvariable">
377 |   
378 |   <a name="Py5cheSim.UE.Format.CBEIGE">
379 |     
380 |   </a>
381 |   <a name="CBEIGE">
382 |     
383 |   </a>
384 |   <div class="functionHeader">
385 |     
386 |     <span class="py-defname">CBEIGE</span> =
387 |     
388 |   </div>
389 |   <div class="functionBody">
390 |     
391 |     
392 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
393 |   </div>
394 | </div><div class="baseclassvariable">
395 |   
396 |   <a name="Py5cheSim.UE.Format.CWHITE">
397 |     
398 |   </a>
399 |   <a name="CWHITE">
400 |     
401 |   </a>
402 |   <div class="functionHeader">
403 |     
404 |     <span class="py-defname">CWHITE</span> =
405 |     
406 |   </div>
407 |   <div class="functionBody">
408 |     
409 |     
410 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
411 |   </div>
412 | </div><div class="baseclassvariable">
413 |   
414 |   <a name="Py5cheSim.UE.Format.CGREENBG">
415 |     
416 |   </a>
417 |   <a name="CGREENBG">
418 |     
419 |   </a>
420 |   <div class="functionHeader">
421 |     
422 |     <span class="py-defname">CGREENBG</span> =
423 |     
424 |   </div>
425 |   <div class="functionBody">
426 |     
427 |     
428 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
429 |   </div>
430 | </div><div class="baseclassvariable">
431 |   
432 |   <a name="Py5cheSim.UE.Format.CBLUEBG">
433 |     
434 |   </a>
435 |   <a name="CBLUEBG">
436 |     
437 |   </a>
438 |   <div class="functionHeader">
439 |     
440 |     <span class="py-defname">CBLUEBG</span> =
441 |     
442 |   </div>
443 |   <div class="functionBody">
444 |     
445 |     
446 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>str</code>)
447 |   </div>
448 | </div>
449 | 
450 |       </div>
451 |       <address>
452 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
453 |       </address>
454 | 
455 |     </div>
456 | 
457 |     <script src="pydoctor.js" type="text/javascript"></script>
458 | 
459 |   </body>
460 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.UE.Packet.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.UE.Packet : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.UE.html">UE</a></code>.<code><a href="Py5cheSim.UE.Packet.html">Packet</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">Packet</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.UE.Packet">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class is used to model packets properties and behabiour.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id27">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#secNum">secNum</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#size">size</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="instancevariable">
 64 |     
 65 |     <td>Instance Variable</td>
 66 |     <td><code><a href="#qosFlowId">qosFlowId</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="instancevariable">
 69 |     
 70 |     <td>Instance Variable</td>
 71 |     <td><code><a href="#ue">ue</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="instancevariable">
 74 |     
 75 |     <td>Instance Variable</td>
 76 |     <td><code><a href="#tIn">tIn</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="method">
 79 |     
 80 |     <td>Method</td>
 81 |     <td><code><a href="#printPacket">printPacket</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr>
 84 | </table>
 85 |         
 86 | 
 87 |           
 88 |       </div>
 89 | 
 90 |       <div id="childList">
 91 | 
 92 |         <div class="basemethod">
 93 |   
 94 |   <a name="Py5cheSim.UE.Packet.__init__">
 95 |     
 96 |   </a>
 97 |   <a name="__init__">
 98 |     
 99 |   </a>
100 |   <div class="functionHeader">
101 |     
102 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, sn, s, qfi, u):
103 |     
104 |   </div>
105 |   <div class="docstring functionBody">
106 |     
107 |     
108 |     <div><p class="undocumented">Undocumented</p></div>
109 |   </div>
110 | </div><div class="baseinstancevariable">
111 |   
112 |   <a name="Py5cheSim.UE.Packet.secNum">
113 |     
114 |   </a>
115 |   <a name="secNum">
116 |     
117 |   </a>
118 |   <div class="functionHeader">
119 |     
120 |     <span class="py-defname">secNum</span> =
121 |     
122 |   </div>
123 |   <div class="functionBody">
124 |     
125 |     
126 |     <div><p class="undocumented">Undocumented</p></div>
127 |   </div>
128 | </div><div class="baseinstancevariable">
129 |   
130 |   <a name="Py5cheSim.UE.Packet.size">
131 |     
132 |   </a>
133 |   <a name="size">
134 |     
135 |   </a>
136 |   <div class="functionHeader">
137 |     
138 |     <span class="py-defname">size</span> =
139 |     
140 |   </div>
141 |   <div class="functionBody">
142 |     
143 |     
144 |     <div><p class="undocumented">Undocumented</p></div>
145 |   </div>
146 | </div><div class="baseinstancevariable">
147 |   
148 |   <a name="Py5cheSim.UE.Packet.qosFlowId">
149 |     
150 |   </a>
151 |   <a name="qosFlowId">
152 |     
153 |   </a>
154 |   <div class="functionHeader">
155 |     
156 |     <span class="py-defname">qosFlowId</span> =
157 |     
158 |   </div>
159 |   <div class="functionBody">
160 |     
161 |     
162 |     <div><p class="undocumented">Undocumented</p></div>
163 |   </div>
164 | </div><div class="baseinstancevariable">
165 |   
166 |   <a name="Py5cheSim.UE.Packet.ue">
167 |     
168 |   </a>
169 |   <a name="ue">
170 |     
171 |   </a>
172 |   <div class="functionHeader">
173 |     
174 |     <span class="py-defname">ue</span> =
175 |     
176 |   </div>
177 |   <div class="functionBody">
178 |     
179 |     
180 |     <div><p class="undocumented">Undocumented</p></div>
181 |   </div>
182 | </div><div class="baseinstancevariable">
183 |   
184 |   <a name="Py5cheSim.UE.Packet.tIn">
185 |     
186 |   </a>
187 |   <a name="tIn">
188 |     
189 |   </a>
190 |   <div class="functionHeader">
191 |     
192 |     <span class="py-defname">tIn</span> =
193 |     
194 |   </div>
195 |   <div class="functionBody">
196 |     
197 |     
198 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>int</code>)
199 |   </div>
200 | </div><div class="basemethod">
201 |   
202 |   <a name="Py5cheSim.UE.Packet.printPacket">
203 |     
204 |   </a>
205 |   <a name="printPacket">
206 |     
207 |   </a>
208 |   <div class="functionHeader">
209 |     
210 |     <span class="py-keyword">def</span> <span class="py-defname">printPacket</span>(self):
211 |     
212 |   </div>
213 |   <div class="docstring functionBody">
214 |     
215 |     
216 |     <div><p class="undocumented">Undocumented</p></div>
217 |   </div>
218 | </div>
219 | 
220 |       </div>
221 |       <address>
222 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
223 |       </address>
224 | 
225 |     </div>
226 | 
227 |     <script src="pydoctor.js" type="text/javascript"></script>
228 | 
229 |   </body>
230 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.UE.PcktQueue.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.UE.PcktQueue : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.UE.html">UE</a></code>.<code><a href="Py5cheSim.UE.PcktQueue.html">PcktQueue</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">PcktQueue</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.UE.PcktQueue">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class is used to model application and bearer buffers.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id29">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#pckts">pckts</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="method">
 59 |     
 60 |     <td>Method</td>
 61 |     <td><code><a href="#insertPckt">insertPckt</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="method">
 64 |     
 65 |     <td>Method</td>
 66 |     <td><code><a href="#insertPcktLeft">insertPcktLeft</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="method">
 69 |     
 70 |     <td>Method</td>
 71 |     <td><code><a href="#removePckt">removePckt</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr>
 74 | </table>
 75 |         
 76 | 
 77 |           
 78 |       </div>
 79 | 
 80 |       <div id="childList">
 81 | 
 82 |         <div class="basemethod">
 83 |   
 84 |   <a name="Py5cheSim.UE.PcktQueue.__init__">
 85 |     
 86 |   </a>
 87 |   <a name="__init__">
 88 |     
 89 |   </a>
 90 |   <div class="functionHeader">
 91 |     
 92 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self):
 93 |     
 94 |   </div>
 95 |   <div class="docstring functionBody">
 96 |     
 97 |     
 98 |     <div><p class="undocumented">Undocumented</p></div>
 99 |   </div>
100 | </div><div class="baseinstancevariable">
101 |   
102 |   <a name="Py5cheSim.UE.PcktQueue.pckts">
103 |     
104 |   </a>
105 |   <a name="pckts">
106 |     
107 |   </a>
108 |   <div class="functionHeader">
109 |     
110 |     <span class="py-defname">pckts</span> =
111 |     
112 |   </div>
113 |   <div class="functionBody">
114 |     
115 |     
116 |     <div><p class="undocumented">Undocumented</p></div>
117 |   </div>
118 | </div><div class="basemethod">
119 |   
120 |   <a name="Py5cheSim.UE.PcktQueue.insertPckt">
121 |     
122 |   </a>
123 |   <a name="insertPckt">
124 |     
125 |   </a>
126 |   <div class="functionHeader">
127 |     
128 |     <span class="py-keyword">def</span> <span class="py-defname">insertPckt</span>(self, p):
129 |     
130 |   </div>
131 |   <div class="docstring functionBody">
132 |     
133 |     
134 |     <div><p class="undocumented">Undocumented</p></div>
135 |   </div>
136 | </div><div class="basemethod">
137 |   
138 |   <a name="Py5cheSim.UE.PcktQueue.insertPcktLeft">
139 |     
140 |   </a>
141 |   <a name="insertPcktLeft">
142 |     
143 |   </a>
144 |   <div class="functionHeader">
145 |     
146 |     <span class="py-keyword">def</span> <span class="py-defname">insertPcktLeft</span>(self, p):
147 |     
148 |   </div>
149 |   <div class="docstring functionBody">
150 |     
151 |     
152 |     <div><p class="undocumented">Undocumented</p></div>
153 |   </div>
154 | </div><div class="basemethod">
155 |   
156 |   <a name="Py5cheSim.UE.PcktQueue.removePckt">
157 |     
158 |   </a>
159 |   <a name="removePckt">
160 |     
161 |   </a>
162 |   <div class="functionHeader">
163 |     
164 |     <span class="py-keyword">def</span> <span class="py-defname">removePckt</span>(self):
165 |     
166 |   </div>
167 |   <div class="docstring functionBody">
168 |     
169 |     
170 |     <div><p class="undocumented">Undocumented</p></div>
171 |   </div>
172 | </div>
173 | 
174 |       </div>
175 |       <address>
176 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
177 |       </address>
178 | 
179 |     </div>
180 | 
181 |     <script src="pydoctor.js" type="text/javascript"></script>
182 | 
183 |   </body>
184 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.UE.RadioLink.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.UE.RadioLink : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="class"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.UE.html">UE</a></code>.<code><a href="Py5cheSim.UE.RadioLink.html">RadioLink</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         class documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         <p><code><span class="py-keyword">class</span> <span class="py-defname">RadioLink</span>:</code></p>
 38 |         <p><a href="classIndex.html#Py5cheSim.UE.RadioLink">View In Hierarchy</a></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This class is used to model radio link properties and behabiour.</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id30">
 47 |   
 48 |   <tr class="method">
 49 |     
 50 |     <td>Method</td>
 51 |     <td><code><a href="#__init__">__init__</a></code></td>
 52 |     <td><span class="undocumented">Undocumented</span></td>
 53 |   </tr><tr class="instancevariable">
 54 |     
 55 |     <td>Instance Variable</td>
 56 |     <td><code><a href="#id">id</a></code></td>
 57 |     <td><span class="undocumented">Undocumented</span></td>
 58 |   </tr><tr class="instancevariable">
 59 |     
 60 |     <td>Instance Variable</td>
 61 |     <td><code><a href="#linkQuality">linkQuality</a></code></td>
 62 |     <td><span class="undocumented">Undocumented</span></td>
 63 |   </tr><tr class="instancevariable">
 64 |     
 65 |     <td>Instance Variable</td>
 66 |     <td><code><a href="#ue">ue</a></code></td>
 67 |     <td><span class="undocumented">Undocumented</span></td>
 68 |   </tr><tr class="instancevariable">
 69 |     
 70 |     <td>Instance Variable</td>
 71 |     <td><code><a href="#totCount">totCount</a></code></td>
 72 |     <td><span class="undocumented">Undocumented</span></td>
 73 |   </tr><tr class="instancevariable">
 74 |     
 75 |     <td>Instance Variable</td>
 76 |     <td><code><a href="#maxVar">maxVar</a></code></td>
 77 |     <td><span class="undocumented">Undocumented</span></td>
 78 |   </tr><tr class="method">
 79 |     
 80 |     <td>Method</td>
 81 |     <td><code><a href="#updateLQ">updateLQ</a></code></td>
 82 |     <td><span>This method updates UE link quality in terms of SINR during the simulation. This is a PEM method.</span></td>
 83 |   </tr>
 84 | </table>
 85 |         
 86 | 
 87 |           
 88 |       </div>
 89 | 
 90 |       <div id="childList">
 91 | 
 92 |         <div class="basemethod">
 93 |   
 94 |   <a name="Py5cheSim.UE.RadioLink.__init__">
 95 |     
 96 |   </a>
 97 |   <a name="__init__">
 98 |     
 99 |   </a>
100 |   <div class="functionHeader">
101 |     
102 |     <span class="py-keyword">def</span> <span class="py-defname">__init__</span>(self, i, lq_0, u):
103 |     
104 |   </div>
105 |   <div class="docstring functionBody">
106 |     
107 |     
108 |     <div><p class="undocumented">Undocumented</p></div>
109 |   </div>
110 | </div><div class="baseinstancevariable">
111 |   
112 |   <a name="Py5cheSim.UE.RadioLink.id">
113 |     
114 |   </a>
115 |   <a name="id">
116 |     
117 |   </a>
118 |   <div class="functionHeader">
119 |     
120 |     <span class="py-defname">id</span> =
121 |     
122 |   </div>
123 |   <div class="functionBody">
124 |     
125 |     
126 |     <div><p class="undocumented">Undocumented</p></div>
127 |   </div>
128 | </div><div class="baseinstancevariable">
129 |   
130 |   <a name="Py5cheSim.UE.RadioLink.linkQuality">
131 |     
132 |   </a>
133 |   <a name="linkQuality">
134 |     
135 |   </a>
136 |   <div class="functionHeader">
137 |     
138 |     <span class="py-defname">linkQuality</span> =
139 |     
140 |   </div>
141 |   <div class="functionBody">
142 |     
143 |     
144 |     <div><p class="undocumented">Undocumented</p></div>
145 |   </div>
146 | </div><div class="baseinstancevariable">
147 |   
148 |   <a name="Py5cheSim.UE.RadioLink.ue">
149 |     
150 |   </a>
151 |   <a name="ue">
152 |     
153 |   </a>
154 |   <div class="functionHeader">
155 |     
156 |     <span class="py-defname">ue</span> =
157 |     
158 |   </div>
159 |   <div class="functionBody">
160 |     
161 |     
162 |     <div><p class="undocumented">Undocumented</p></div>
163 |   </div>
164 | </div><div class="baseinstancevariable">
165 |   
166 |   <a name="Py5cheSim.UE.RadioLink.totCount">
167 |     
168 |   </a>
169 |   <a name="totCount">
170 |     
171 |   </a>
172 |   <div class="functionHeader">
173 |     
174 |     <span class="py-defname">totCount</span> =
175 |     
176 |   </div>
177 |   <div class="functionBody">
178 |     
179 |     
180 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>int</code>)
181 |   </div>
182 | </div><div class="baseinstancevariable">
183 |   
184 |   <a name="Py5cheSim.UE.RadioLink.maxVar">
185 |     
186 |   </a>
187 |   <a name="maxVar">
188 |     
189 |   </a>
190 |   <div class="functionHeader">
191 |     
192 |     <span class="py-defname">maxVar</span> =
193 |     
194 |   </div>
195 |   <div class="functionBody">
196 |     
197 |     
198 |     <div><p class="undocumented">Undocumented</p></div> (type: <code>float</code>)
199 |   </div>
200 | </div><div class="basemethod">
201 |   
202 |   <a name="Py5cheSim.UE.RadioLink.updateLQ">
203 |     
204 |   </a>
205 |   <a name="updateLQ">
206 |     
207 |   </a>
208 |   <div class="functionHeader">
209 |     
210 |     <span class="py-keyword">def</span> <span class="py-defname">updateLQ</span>(self, env, udIntrv, tSim, fl, u, r):
211 |     
212 |   </div>
213 |   <div class="docstring functionBody">
214 |     
215 |     
216 |     <div><p>This method updates UE link quality in terms of SINR during the simulation. This is a PEM method.</p><p>During the simulation it is assumed that UE SINR varies following a normal distribution with mean value equal to initial SINR value, and a small variance.</p></div>
217 |   </div>
218 | </div>
219 | 
220 |       </div>
221 |       <address>
222 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
223 |       </address>
224 | 
225 |     </div>
226 | 
227 |     <script src="pydoctor.js" type="text/javascript"></script>
228 | 
229 |   </body>
230 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.UE.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim.UE : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="module"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code>.<code><a href="Py5cheSim.UE.html">UE</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         module documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         
 38 |         <p></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p>This module contains the UE, Packet Flow, Packet, PcktQueue, Bearer and RadioLink clases. This clases are oriented to describe UE traffic profile, and UE relative concepts</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id24">
 47 |   
 48 |   <tr class="class">
 49 |     
 50 |     <td>Class</td>
 51 |     <td><code><a href="Py5cheSim.UE.UE.html">UE</a></code></td>
 52 |     <td><span>This class is used to model UE behabiour and relative properties</span></td>
 53 |   </tr><tr class="class">
 54 |     
 55 |     <td>Class</td>
 56 |     <td><code><a href="Py5cheSim.UE.PacketFlow.html">PacketFlow</a></code></td>
 57 |     <td><span>This class is used to describe UE traffic profile for the simulation.</span></td>
 58 |   </tr><tr class="class">
 59 |     
 60 |     <td>Class</td>
 61 |     <td><code><a href="Py5cheSim.UE.Packet.html">Packet</a></code></td>
 62 |     <td><span>This class is used to model packets properties and behabiour.</span></td>
 63 |   </tr><tr class="class">
 64 |     
 65 |     <td>Class</td>
 66 |     <td><code><a href="Py5cheSim.UE.Bearer.html">Bearer</a></code></td>
 67 |     <td><span>This class is used to model Bearers properties and behabiour.</span></td>
 68 |   </tr><tr class="class">
 69 |     
 70 |     <td>Class</td>
 71 |     <td><code><a href="Py5cheSim.UE.PcktQueue.html">PcktQueue</a></code></td>
 72 |     <td><span>This class is used to model application and bearer buffers.</span></td>
 73 |   </tr><tr class="class">
 74 |     
 75 |     <td>Class</td>
 76 |     <td><code><a href="Py5cheSim.UE.RadioLink.html">RadioLink</a></code></td>
 77 |     <td><span>This class is used to model radio link properties and behabiour.</span></td>
 78 |   </tr><tr class="class">
 79 |     
 80 |     <td>Class</td>
 81 |     <td><code><a href="Py5cheSim.UE.Format.html">Format</a></code></td>
 82 |     <td><span class="undocumented">Undocumented</span></td>
 83 |   </tr>
 84 | </table>
 85 |         
 86 | 
 87 |           
 88 |       </div>
 89 | 
 90 |       <div id="childList">
 91 | 
 92 |         
 93 | 
 94 |       </div>
 95 |       <address>
 96 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
 97 |       </address>
 98 | 
 99 |     </div>
100 | 
101 |     <script src="pydoctor.js" type="text/javascript"></script>
102 | 
103 |   </body>
104 | </html>


--------------------------------------------------------------------------------
/doc/Py5cheSim.html:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="utf-8"?>
  2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  3 |           "DTD/xhtml1-strict.dtd">
  4 | <html>
  5 |   <head>
  6 |     <title>Py5cheSim : API documentation</title>
  7 | 
  8 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  9 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 10 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
 11 |   </head>
 12 |   <body>
 13 | 
 14 |     <nav class="navbar navbar-default">
 15 |       <div class="container">
 16 |         <div class="navbar-header navbar-brand">
 17 |           Py5cheSim
 18 |           <a href="index.html">API Documentation</a>
 19 |         </div>
 20 |       </div>
 21 |     </nav>
 22 | 
 23 |     <div class="container">
 24 | 
 25 |       <div class="page-header">
 26 |         <h1 class="package"><code><code><a href="Py5cheSim.html">Py5cheSim</a></code></code></h1>
 27 |         <div id="showPrivate">
 28 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
 29 |         </div>
 30 |       </div>
 31 | 
 32 |       <div class="categoryHeader">
 33 |         package documentation
 34 |       </div>
 35 | 
 36 |       <div class="extrasDocstring">
 37 |         
 38 |         <p></p>
 39 |       </div>
 40 | 
 41 |       <div class="moduleDocstring">
 42 |         <div><p class="undocumented">Undocumented</p></div>
 43 |       </div>
 44 | 
 45 |       <div id="splitTables">
 46 |         <table class="children sortable" id="id1">
 47 |   
 48 |   <tr class="module">
 49 |     
 50 |     <td>Module</td>
 51 |     <td><code><a href="Py5cheSim.Cell.html">Cell</a></code></td>
 52 |     <td><span>This module contains the Cell class.</span></td>
 53 |   </tr><tr class="module">
 54 |     
 55 |     <td>Module</td>
 56 |     <td><code><a href="Py5cheSim.InterSliceSch.html">InterSliceSch</a></code></td>
 57 |     <td><span>This module contains the basic Inter Slice Scheduler class. All possible inter slice schedulers should inherit from this.</span></td>
 58 |   </tr><tr class="module">
 59 |     
 60 |     <td>Module</td>
 61 |     <td><code><a href="Py5cheSim.IntraSliceSch.html">IntraSliceSch</a></code></td>
 62 |     <td><span>This module contains the basic Intra Slice Scheduler class. All possible intra slice schedulers should inherit from this.</span></td>
 63 |   </tr><tr class="module">
 64 |     
 65 |     <td>Module</td>
 66 |     <td><code><a href="Py5cheSim.Results.html">Results</a></code></td>
 67 |     <td><span>This module contains auxiliary simulation classes and methods along with results processing.</span></td>
 68 |   </tr><tr class="module">
 69 |     
 70 |     <td>Module</td>
 71 |     <td><code><a href="Py5cheSim.Scheds_Inter.html">Scheds_Inter</a></code></td>
 72 |     <td><span>This module contains different implemented inter slice schedulers. New schedulers should be implemented here following the current structure.</span></td>
 73 |   </tr><tr class="module">
 74 |     
 75 |     <td>Module</td>
 76 |     <td><code><a href="Py5cheSim.Scheds_Intra.html">Scheds_Intra</a></code></td>
 77 |     <td><span>This module contains different implemented intra slice schedulers. New schedulers should be implemented here following the current structure.</span></td>
 78 |   </tr><tr class="module">
 79 |     
 80 |     <td>Module</td>
 81 |     <td><code><a href="Py5cheSim.Slice.html">Slice</a></code></td>
 82 |     <td><span>This module contains the Slice class.</span></td>
 83 |   </tr><tr class="module">
 84 |     
 85 |     <td>Module</td>
 86 |     <td><code><a href="Py5cheSim.UE.html">UE</a></code></td>
 87 |     <td><span>This module contains the UE, Packet Flow, Packet, PcktQueue, Bearer and RadioLink clases. This clases are oriented to describe UE traffic profile, and UE relative concepts</span></td>
 88 |   </tr><tr class="module">
 89 |     
 90 |     <td>Module</td>
 91 |     <td><code><a href="Py5cheSim.simulation.html">simulation</a></code></td>
 92 |     <td><span>This is the simulation script. Simulation, cell and traffic profile parameters can be set here.</span></td>
 93 |   </tr>
 94 | </table>
 95 |         
 96 | 
 97 |           
 98 |       </div>
 99 | 
100 |       <div id="childList">
101 | 
102 |         
103 | 
104 |       </div>
105 |       <address>
106 |         <a href="index.html">API Documentation</a> for Py5cheSim, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> 21.2.2 at 2021-09-05 13:11:47.
107 |       </address>
108 | 
109 |     </div>
110 | 
111 |     <script src="pydoctor.js" type="text/javascript"></script>
112 | 
113 |   </body>
114 | </html>


--------------------------------------------------------------------------------
/doc/apidocs.css:
--------------------------------------------------------------------------------
  1 | body {
  2 |     overflow-y: scroll;
  3 | }
  4 | 
  5 | .navbar {
  6 |     margin-bottom: 0px;
  7 | }
  8 | 
  9 | .page-header {
 10 |     margin-top: 22px;
 11 |     position: sticky;
 12 |     top: 0;
 13 |     display: flex;
 14 |     flex-wrap: wrap;
 15 |     justify-content: space-between;
 16 |     align-items: baseline;
 17 |     background-color: #fff;
 18 |     margin-bottom: 3px;
 19 |     border-bottom: 0;
 20 |     box-shadow: 0px 0px 8px 8px #fff;
 21 | }
 22 | .page-header h1 {
 23 |     margin-bottom: 0;
 24 | }
 25 | 
 26 | .categoryHeader {
 27 |     font-size: 24px;
 28 |     color: #777;
 29 |     margin-bottom: 1.8em;
 30 | }
 31 | 
 32 | a[name] {
 33 |     position: relative;
 34 |     bottom: 80px;
 35 |     font-size: 0;
 36 | }
 37 | 
 38 | ul {
 39 |     margin-top: 10px;
 40 |     padding-left: 10px;
 41 | }
 42 | 
 43 | li {
 44 |     padding-top: 5px;
 45 |     padding-bottom: 5px;
 46 | }
 47 | 
 48 | li a {
 49 |     text-decoration: none;
 50 | }
 51 | 
 52 | ul {
 53 |     margin-left: 10px;
 54 | }
 55 | 
 56 | ul ul {
 57 |     border-left-color: #e1f5fe;
 58 |     border-left-width: 1px;
 59 |     border-left-style: solid;
 60 | }
 61 | 
 62 | ul ul ul {
 63 |     border-left-color: #b3e5fc;
 64 | }
 65 | 
 66 | ul ul ul ul {
 67 |     border-left-color: #81d4fa;
 68 | }
 69 | 
 70 | ul ul ul ul ul {
 71 |     border-left-color: #4fc3f7;
 72 | }
 73 | 
 74 | ul ul ul ul ul ul {
 75 |     border-left-color: #29b6f6;
 76 | }
 77 | 
 78 | ul ul ul ul ul ul ul {
 79 |     border-left-color: #03a9f4;
 80 | }
 81 | 
 82 | ul ul ul ul ul ul ul {
 83 |     border-left-color: #039be5;
 84 | }
 85 | 
 86 | .pre {
 87 |     white-space: pre;
 88 | }
 89 | 
 90 | .undocumented {
 91 |     font-style: italic;
 92 |     color: #9e9e9e;
 93 | }
 94 | 
 95 | .functionBody p {
 96 |     margin-top: 6px;
 97 |     margin-bottom: 6px;
 98 | }
 99 | 
100 | #splitTables > p {
101 |     margin-bottom: 5px;
102 | }
103 | 
104 | #splitTables > table, .fieldTable {
105 |     margin-bottom: 20px;
106 |     width: 100%;
107 |     border: 0;
108 | }
109 | 
110 | #splitTables > table {
111 |     border: 1px solid #eee;
112 | }
113 | 
114 | #splitTables > table tr {
115 |     border-bottom-color: #eee;
116 |     border-bottom-width: 1px;
117 |     border-bottom-style: solid;
118 | }
119 | 
120 | #splitTables > table tr td, .fieldTable tr td {
121 |     padding: 5px;
122 | }
123 | 
124 | #splitTables > table tr td {
125 |     border-left-color: #eee;
126 |     border-left-width: 1px;
127 |     border-left-style: solid;
128 | }
129 | 
130 | #splitTables > table tr td:nth-child(1), .fieldTable tr td:nth-child(1) {
131 |     border-left: none;
132 |     width: 150px;
133 | }
134 | 
135 | #splitTables > table tr td:nth-child(2), .fieldTable tr td.fieldArg {
136 |     width: 200px;
137 | }
138 | 
139 | tr.package {
140 |     background-color: #fff3e0;
141 | }
142 | 
143 | tr.module {
144 |     background-color: #fff8e1;
145 | }
146 | 
147 | tr.class, tr.classvariable, tr.baseclassvariable {
148 |     background-color: #fffde7;
149 | }
150 | 
151 | tr.instancevariable, tr.baseinstancevariable, tr.variable, tr.attribute, tr.property {
152 |     background-color: #f3e5f5;
153 | }
154 | 
155 | tr.interface {
156 |     background-color: #fbe9e7;
157 | }
158 | 
159 | tr.method, tr.function, tr.basemethod, tr.baseclassmethod, tr.classmethod {
160 |     background-color: #f1f8e9;
161 | }
162 | 
163 | tr.private {
164 |     background-color: #f1f1f1;
165 | }
166 | 
167 | .fieldTable {
168 |     margin-top: 10px;
169 | }
170 | 
171 | .fieldName {
172 |     font-weight: bold;
173 | }
174 | 
175 | 
176 | #childList > div {
177 |     margin: 10px;
178 |     padding: 10px;
179 |     padding-bottom: 5px;
180 | }
181 | 
182 | .functionBody {
183 |     margin-left: 15px;
184 | }
185 | 
186 | .functionBody > #part {
187 |     font-style: italic;
188 | }
189 | 
190 | .functionBody > #part > a {
191 |     text-decoration: none;
192 | }
193 | 
194 | .functionBody .interfaceinfo {
195 |     font-style: italic;
196 |     margin-bottom: 3px;
197 | }
198 | 
199 | .functionBody > .undocumented {
200 | 
201 |     margin-top: 6px;
202 |     margin-bottom: 6px;
203 | }
204 | 
205 | /*
206 | - Links to class/function/etc names are nested like this:
207 |     <code><a>label</a></code>
208 |   This applies to inline docstring content marked up as code,
209 |   for example L{foo} in epytext or `bar` in restructuredtext,
210 |   but also to links that are present in summary tables.
211 | - 'functionHeader' is used for lines like `def func():` and `var =`
212 | */
213 | code, .pre, #childList > div .functionHeader,
214 | #splitTables > table tr td:nth-child(2), .fieldTable tr td.fieldArg {
215 |     font-family: Menlo, Monaco, Consolas, "Courier New", monospace;
216 | }
217 | code, #childList > div .functionHeader, .fieldTable tr td.fieldArg {
218 |     font-size: 90%;
219 |     color: #222222;
220 | }
221 | code > a {
222 |     color:#c7254e;
223 |     background-color:#f9f2f4;
224 | }
225 | /* top navagation bar */
226 | .page-header > h1 {
227 |     margin-top: 0;
228 | }
229 | .page-header > h1 > code {
230 |     color: #971c3a;
231 | }
232 | 
233 | /*
234 | This defines the code style, it's black on light gray.
235 | It also overwrite the default values inherited from bootstrap min
236 | */
237 | code {
238 |     padding:2px 4px;
239 |     background-color: #f4f4f4;
240 |     border-radius:4px
241 | }
242 | 
243 | 
244 | a.functionSourceLink {
245 |     font-weight: normal;
246 | }
247 | 
248 | 
249 | #childList > div {
250 |     border-left-color: #03a9f4;
251 |     border-left-width: 1px;
252 |     border-left-style: solid;
253 |     background: #fafafa;
254 | }
255 | 
256 | .moduleDocstring {
257 |     margin: 20px;
258 | }
259 | 
260 | #partOf {
261 |     margin-top: -13px;
262 |     margin-bottom: 19px;
263 | }
264 | 
265 | .fromInitPy {
266 |     font-style: italic;
267 | }
268 | 
269 | pre {
270 |     padding-left: 0px;
271 | }
272 | 
273 | /* Private stuff */
274 | 
275 | body.private-hidden #splitTables .private,
276 | body.private-hidden #childList .private,
277 | body.private-hidden #summaryTree .private {
278 |     display: none;
279 | }
280 | 
281 | #showPrivate {
282 |     padding: 10px;
283 | }
284 | 
285 | #current-docs-container {
286 |     font-style: italic;
287 |     padding-top: 11px;
288 | }
289 | 
290 | /* Deprecation stuff */
291 | 
292 | .deprecationNotice {
293 |     margin: 10px;
294 | }
295 | 
296 | /* Syntax highlighting for source code */
297 | 
298 | .py-string {
299 |     color: #337ab7;
300 | }
301 | .py-comment {
302 |     color: #309078;
303 |     font-style: italic;
304 | }
305 | .py-keyword {
306 |     font-weight: bold;
307 | }
308 | .py-defname {
309 |     color: #a947b8;
310 |     font-weight: bold;
311 | }
312 | .py-builtin {
313 |     color: #fc7844;
314 |     font-weight: bold;
315 | }
316 | 
317 | /* Doctest */
318 | 
319 | pre.py-doctest {
320 |     padding: .5em;
321 | }
322 | .py-prompt, .py-more {
323 |     color: #a8a8a8;
324 | }
325 | .py-output {
326 |     color: #c7254e;
327 | }
328 | 
329 | /* Admonitions */
330 | 
331 | div.rst-admonition p.rst-admonition-title:after {
332 |     content: ":";
333 | }
334 | 
335 | div.rst-admonition p.rst-admonition-title {
336 |     margin: 0;
337 |     padding: 0.1em 0 0.35em 0em;
338 |     font-weight: bold;
339 | }
340 | 
341 | div.rst-admonition p.rst-admonition-title {
342 |     color: #333333;
343 | }
344 | 
345 | div.rst-admonition {
346 |     padding: 8px;
347 |     margin-bottom: 20px;
348 |     background-color: #EEE;
349 |     border: 1px solid #CCC;
350 |     border-radius: 4px;
351 | }
352 | 
353 | div.warning, div.attention, div.danger, div.error, div.caution {
354 |     background-color: #ffcf9cb0;
355 |     border: 1px solid #ffbbaa;
356 | }
357 | 
358 | div.danger p.rst-admonition-title, div.error p.rst-admonition-title, div.caution p.rst-admonition-title {
359 |     color: #b94a48;
360 | }
361 | 
362 | div.tip p.rst-admonition-title, div.hint p.rst-admonition-title, div.important p.rst-admonition-title{
363 |     color: #3a87ad;
364 | }
365 | 
366 | div.tip, div.hint, div.important {
367 |     background-color: #d9edf7;
368 |     border-color: #bce8f1;
369 | }
370 | 


--------------------------------------------------------------------------------
/doc/classIndex.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Class Hierarchy</title>
 7 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 8 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 9 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
10 |   </head>
11 |   <body>
12 |     <nav class="navbar navbar-default">
13 |       <div class="container">
14 |         <div class="navbar-header navbar-brand">
15 |           Py5cheSim
16 |           <a href="index.html">API Documentation</a>
17 |         </div>
18 |       </div>
19 |     </nav>
20 | 
21 |     <div class="container">
22 | 
23 |       <div class="page-header">
24 |         <h1>Class Hierarchy</h1>
25 |         <div id="showPrivate">
26 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
27 |         </div>
28 |       </div>
29 | 
30 |       <ul id="summaryTree">
31 |       <li><code>InterSliceSch.InterSliceScheduler</code><ul><li><a name="Py5cheSim.Scheds_Inter.PF_Scheduler"></a><code><a href="Py5cheSim.Scheds_Inter.PF_Scheduler.html">Py5cheSim.Scheds_Inter.PF_Scheduler</a></code> - <span>This class implements Proportional Fair inter slice scheduling algorithm.</span></li><li><a name="Py5cheSim.Scheds_Inter.RRplus_Scheduler"></a><code><a href="Py5cheSim.Scheds_Inter.RRplus_Scheduler.html">Py5cheSim.Scheds_Inter.RRplus_Scheduler</a></code> - <span>This class implements Round Robin Plus inter slice scheduling algorithm.</span></li></ul></li><li><code>IntraSliceSch.IntraSliceScheduler</code><ul><li><a name="Py5cheSim.Scheds_Intra.PF_Scheduler"></a><code><a href="Py5cheSim.Scheds_Intra.PF_Scheduler.html">Py5cheSim.Scheds_Intra.PF_Scheduler</a></code> - <span>This class implements Proportional Fair intra slice scheduling algorithm.</span></li><li><a name="Py5cheSim.Scheds_Intra.TDD_Scheduler"></a><code><a href="Py5cheSim.Scheds_Intra.TDD_Scheduler.html">Py5cheSim.Scheds_Intra.TDD_Scheduler</a></code> - <span>This class implements TDD intra slice scheduling.</span></li></ul></li><li><a name="Py5cheSim.Cell.Cell"></a><code><a href="Py5cheSim.Cell.Cell.html">Py5cheSim.Cell.Cell</a></code> - <span>Cell class has cell relative parameters and collect kpi ststistics.</span></li><li><a name="Py5cheSim.InterSliceSch.InterSliceScheduler"></a><code><a href="Py5cheSim.InterSliceSch.InterSliceScheduler.html">Py5cheSim.InterSliceSch.InterSliceScheduler</a></code> - <span>Basic inter slice scheduler. It implements Round Robin algorithm.</span></li><li><a name="Py5cheSim.IntraSliceSch.Format"></a><code><a href="Py5cheSim.IntraSliceSch.Format.html">Py5cheSim.IntraSliceSch.Format</a></code> - <span class="undocumented">Undocumented</span></li><li><a name="Py5cheSim.IntraSliceSch.IntraSliceScheduler"></a><code><a href="Py5cheSim.IntraSliceSch.IntraSliceScheduler.html">Py5cheSim.IntraSliceSch.IntraSliceScheduler</a></code> - <span>Basic intra slice scheduler. It implements Round Robin algorithm.</span><ul><li><a name="Py5cheSim.IntraSliceSch.LTE_scheduler"></a><code><a href="Py5cheSim.IntraSliceSch.LTE_scheduler.html">Py5cheSim.IntraSliceSch.LTE_scheduler</a></code> - <span>Basic intra slice LTE scheduler. It implements Round Robin algorithm for scheduling in a LTE Slice.</span></li></ul></li><li><a name="Py5cheSim.IntraSliceSch.TBqueue"></a><code><a href="Py5cheSim.IntraSliceSch.TBqueue.html">Py5cheSim.IntraSliceSch.TBqueue</a></code> - <span>This class is used to model scheduler TB queue.</span></li><li><a name="Py5cheSim.IntraSliceSch.TransportBlock"></a><code><a href="Py5cheSim.IntraSliceSch.TransportBlock.html">Py5cheSim.IntraSliceSch.TransportBlock</a></code> - <span>This class is used to describe TB properties and behabiour.</span></li><li><a name="Py5cheSim.Results.UEgroup"></a><code><a href="Py5cheSim.Results.UEgroup.html">Py5cheSim.Results.UEgroup</a></code> - <span>This class is used to describe traffic profile and requirements of group of UE which the simulation will run for. It is assumed that all UEs shares the same traffic profile and service requirements, and will be served by the same slice.</span></li><li><a name="Py5cheSim.Scheds_Intra.TBqueueTDD"></a><code><a href="Py5cheSim.Scheds_Intra.TBqueueTDD.html">Py5cheSim.Scheds_Intra.TBqueueTDD</a></code> - <span>This class is used to model scheduler TB queue in TDD scheduler.</span></li><li><a name="Py5cheSim.Slice.Slice"></a><code><a href="Py5cheSim.Slice.Slice.html">Py5cheSim.Slice.Slice</a></code> - <span>This class has Slice relative parameters and is used to implement the mapping between service requirements and slice configuration.</span></li><li><a name="Py5cheSim.UE.Bearer"></a><code><a href="Py5cheSim.UE.Bearer.html">Py5cheSim.UE.Bearer</a></code> - <span>This class is used to model Bearers properties and behabiour.</span></li><li><a name="Py5cheSim.UE.Format"></a><code><a href="Py5cheSim.UE.Format.html">Py5cheSim.UE.Format</a></code> - <span class="undocumented">Undocumented</span></li><li><a name="Py5cheSim.UE.Packet"></a><code><a href="Py5cheSim.UE.Packet.html">Py5cheSim.UE.Packet</a></code> - <span>This class is used to model packets properties and behabiour.</span></li><li><a name="Py5cheSim.UE.PacketFlow"></a><code><a href="Py5cheSim.UE.PacketFlow.html">Py5cheSim.UE.PacketFlow</a></code> - <span>This class is used to describe UE traffic profile for the simulation.</span></li><li><a name="Py5cheSim.UE.PcktQueue"></a><code><a href="Py5cheSim.UE.PcktQueue.html">Py5cheSim.UE.PcktQueue</a></code> - <span>This class is used to model application and bearer buffers.</span></li><li><a name="Py5cheSim.UE.RadioLink"></a><code><a href="Py5cheSim.UE.RadioLink.html">Py5cheSim.UE.RadioLink</a></code> - <span>This class is used to model radio link properties and behabiour.</span></li><li><a name="Py5cheSim.UE.UE"></a><code><a href="Py5cheSim.UE.UE.html">Py5cheSim.UE.UE</a></code> - <span>This class is used to model UE behabiour and relative properties</span></li></ul>
32 | 
33 |     </div>
34 | 
35 |     <script src="pydoctor.js" type="text/javascript"></script>
36 | 
37 |   </body>
38 | </html>


--------------------------------------------------------------------------------
/doc/index.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>API Documentation for Py5cheSim</title>
 7 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 8 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 9 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
10 |   </head>
11 |   <body>
12 | 
13 |     <nav class="navbar navbar-default">
14 |       <div class="container">
15 |         <div class="navbar-header navbar-brand">
16 |           Py5cheSim
17 |           <a href="index.html">API Documentation</a>
18 |         </div>
19 |       </div>
20 |     </nav>
21 | 
22 |     <div class="container">
23 |       <h2>
24 |         Get Started
25 |       </h2>
26 |       <ul>
27 |         <li>
28 |           A listing of <a href="moduleIndex.html">all modules and
29 |           packages</a>, organized by package hierarchy.
30 |         </li>
31 |         <li>
32 |           A listing of <a href="classIndex.html">all classes</a>,
33 |           organized by inheritance hierarchy.
34 |         </li>
35 |         <li>
36 |           A listing of <a href="nameIndex.html">all functions, classes,
37 |           modules and packages</a>, ordered by name.
38 |         </li>
39 |         
40 |         
41 |         <li>Start at <code><a href="Py5cheSim.html">Py5cheSim</a></code>, the root package.</li>
42 |         
43 |       </ul>
44 |       <h2>
45 |         About
46 |       </h2>
47 |       <p>
48 |         This documentation was automatically generated by
49 |         <a href="https://github.com/twisted/pydoctor/">pydoctor</a>
50 |         21.2.2
51 |         at 2021-09-05 13:11:47.
52 |       </p>
53 | 
54 |     </div>
55 | 
56 |   </body>
57 | </html>


--------------------------------------------------------------------------------
/doc/moduleIndex.html:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 3 |           "DTD/xhtml1-strict.dtd">
 4 | <html>
 5 |   <head>
 6 |     <title>Module Index</title>
 7 |     <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
 8 |     <link rel="stylesheet" type="text/css" href="bootstrap.min.css" />
 9 |     <link rel="stylesheet" type="text/css" href="apidocs.css" />
10 |   </head>
11 |   <body>
12 |     <nav class="navbar navbar-default">
13 |       <div class="container">
14 |         <div class="navbar-header navbar-brand">
15 |           Py5cheSim
16 |           <a href="index.html">API Documentation</a>
17 |         </div>
18 |       </div>
19 |     </nav>
20 | 
21 |     <div class="container">
22 | 
23 |       <div class="page-header">
24 |         <h1>Module Index</h1>
25 |         <div id="showPrivate">
26 |           <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
27 |         </div>
28 |       </div>
29 | 
30 |       <ul id="summaryTree"><li><code><a href="Py5cheSim.html">Py5cheSim</a></code> - <span class="undocumented">No package docstring; 9/9 modules documented</span><ul><li><code><a href="Py5cheSim.Cell.html">Py5cheSim.Cell</a></code> - <span>This module contains the Cell class.</span></li><li><code><a href="Py5cheSim.InterSliceSch.html">Py5cheSim.InterSliceSch</a></code> - <span>This module contains the basic Inter Slice Scheduler class. All possible inter slice schedulers should inherit from this.</span></li><li><code><a href="Py5cheSim.IntraSliceSch.html">Py5cheSim.IntraSliceSch</a></code> - <span>This module contains the basic Intra Slice Scheduler class. All possible intra slice schedulers should inherit from this.</span></li><li><code><a href="Py5cheSim.Results.html">Py5cheSim.Results</a></code> - <span>This module contains auxiliary simulation classes and methods along with results processing.</span></li><li><code><a href="Py5cheSim.Scheds_Inter.html">Py5cheSim.Scheds_Inter</a></code> - <span>This module contains different implemented inter slice schedulers. New schedulers should be implemented here following the current structure.</span></li><li><code><a href="Py5cheSim.Scheds_Intra.html">Py5cheSim.Scheds_Intra</a></code> - <span>This module contains different implemented intra slice schedulers. New schedulers should be implemented here following the current structure.</span></li><li><code><a href="Py5cheSim.Slice.html">Py5cheSim.Slice</a></code> - <span>This module contains the Slice class.</span></li><li><code><a href="Py5cheSim.UE.html">Py5cheSim.UE</a></code> - <span>This module contains the UE, Packet Flow, Packet, PcktQueue, Bearer and RadioLink clases. This clases are oriented to describe UE traffic profile, and UE relative concepts</span></li><li><code><a href="Py5cheSim.simulation.html">Py5cheSim.simulation</a></code> - <span>This is the simulation script. Simulation, cell and traffic profile parameters can be set here.</span></li></ul></li></ul>
31 | 
32 |     </div>
33 | 
34 |     <script src="pydoctor.js" type="text/javascript"></script>
35 | 
36 |   </body>
37 | </html>


--------------------------------------------------------------------------------
/doc/objects.inv:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ClaudinaRattaro/Py5cheSim/1b757ffc4d026c980d3b6fd13f1e1c9b2cbc5737/doc/objects.inv


--------------------------------------------------------------------------------
/doc/pydoctor.js:
--------------------------------------------------------------------------------
 1 | function initPrivate() {
 2 |     var params = (new URL(document.location)).searchParams;
 3 |     if (!params || !parseInt(params.get('private'))) {
 4 |         var show = false;
 5 |         var hash = document.location.hash;
 6 |         if (hash != '') {
 7 |             var anchor = document.querySelector('a[name="' + hash.substring(1) + '"]');
 8 |             show = anchor && anchor.parentNode.classList.contains('private');
 9 |         }
10 |         if (!show) {
11 |             document.body.classList.add("private-hidden");
12 |         }
13 |     }
14 |     updatePrivate();
15 | }
16 | function togglePrivate() {
17 |     document.body.classList.toggle("private-hidden");
18 |     updatePrivate();
19 | }
20 | function updatePrivate() {
21 |     var hidden = document.body.classList.contains('private-hidden');
22 |     document.querySelector('#showPrivate button').innerText =
23 |         hidden ? 'Show Private API' : 'Hide Private API';
24 |     if (history) {
25 |         var search = hidden ? document.location.pathname : '?private=1';
26 |         history.replaceState(null, '', search + document.location.hash);
27 |     }
28 | }
29 | initPrivate();
30 | 


--------------------------------------------------------------------------------
/simulation.py:
--------------------------------------------------------------------------------
  1 | """This is the simulation script.
  2 | Simulation, cell and traffic profile parameters can be set here.
  3 | """
  4 | import os
  5 | import sys
  6 | import simpy
  7 | from UE import *
  8 | from Cell import *
  9 | from Results import *
 10 | 
 11 | #------------------------------------------------------------------------------------------------------
 12 | #              Cell & Simulation parameters
 13 | #------------------------------------------------------------------------------------------------------
 14 | 
 15 | bw = [10]# MHz (FR1: 5, 10, 15, 20, 25, 30, 40, 50, 60, 80, 90, 100; FR2: 50, 100, 200, 400)
 16 | """List containing each CC's bandwidth for the simulation. """
 17 | fr = 'FR1' # FR1 or FR2
 18 | """String with frequency range (FR) to use. 'FR1' for FR1, or 'FR2' for FR2."""
 19 | band = 'B1'
 20 | """String with used band for simulation. In TDD mode it is important to set correctly a band from the next list: n257, n258, n260, n261."""
 21 | tdd = False
 22 | """Boolean indicating if the cell operates in TDD mode."""
 23 | buf = 81920 #10240 #
 24 | """Integer with the maximum Bytes the UE Bearer buffer can tolerate before dropping packets."""
 25 | schedulerInter = 'PF11'# RRp for improved Round Robin, PFXX for Proportional Fair
 26 | """String indicating the Inter Slice Scheduler to use. For only one Slice simulations use ''.
 27 | If the simulation includes more than one slice, set '' for Round Robin, 'RRp' for Round Robin Plus,
 28 | or 'PFXY' for Proportional Fair with X=numExp and Y=denExp."""
 29 | #                   Simulation parameters
 30 | t_sim = 60000 # (ms)
 31 | """Simulation duration in milliseconds."""
 32 | debMode = True # to show queues information by TTI during simulation
 33 | """Boolean indicating if debugging mode is active. In that case, an html log file will be generated with schedulers operation.
 34 | Note that in simulations with a high number of UEs this file can turn quite heavy."""
 35 | measInterv = 1000.0 # interval between meassures
 36 | """Time interval (in milliseconds) between meassures for statistics reports."""
 37 | interSliceSchGr = 3000.0 # interSlice scheduler time granularity
 38 | """Inter slice scheduler time granularity in milliseconds."""
 39 | 
 40 | #-----------------------------------------------------------------
 41 | #              Simulation process activation
 42 | #-----------------------------------------------------------------
 43 | 
 44 | env = simpy.Environment()
 45 | """Environment instance needed by simpy for runing PEM methods"""
 46 | cell1 = Cell('c1',bw,fr,debMode,buf,tdd,interSliceSchGr,schedulerInter)
 47 | """Cell instance for running the simulation"""
 48 | interSliceSche1 = cell1.interSliceSched
 49 | """interSliceScheduler instance"""
 50 | 
 51 | #           DIFFERENT TRAFFIC PROFILES SETTING
 52 | 
 53 | # A few examples ...
 54 | 
 55 | #UEgroup1 = UEgroup(1,3,100000,8000,3,1,'eMBB',10,'','RR','',1,cell1,t_sim,measInterv,env,'S37')
 56 | #UEgroup1 = UEgroup(0,5,0,150,0,60,'m-MTC-2',10,'','RR','',1,cell1,t_sim,measInterv,env,'D37')
 57 | #UEgroup1 = UEgroup(0,4,0,2000,0,5000,'eMBB-1',20,'','','',1,cell1,t_sim,measInterv,env,'S25')
 58 | #UEgroup2 = UEgroup(0,15,0,350,0,10,'eMBB-2',20,'','PF11','',1,cell1,t_sim,measInterv,env,'S20')
 59 | UEgroup2 = UEgroup(0,10,0,350,0,6000,'mMTC-1',20,'','RR','',1,cell1,t_sim,measInterv,env,'S5')
 60 | #UEgroup3 = UEgroup(0,8,0,1500,0,6,'URLLC-1',5,'','PF11','',1,cell1,t_sim,measInterv,env,'S25')
 61 | # UEgroup1 = UEgroup(3,0,10000,0,2,0,'LTE',20,'','RR','',1,cell1,t_sim,measInterv,env,'S37')
 62 | UEgroup1 = UEgroup(3,0,50000,0,1,0,'eMBB',20,'','','SU',4,cell1,t_sim,measInterv,env,'S37')
 63 | """Group of users with defined traffic profile, capabilities and service requirements for which the sumulation will run.
 64 | 
 65 | More than one can be instantiated in one simulation.
 66 | For each one of them, the UEgroup instance must be added in the UEgroups list.
 67 | 
 68 | UEgroupN = UEgroup(nuDL,nuUL,pszDL,pszUL,parrDL,parrUL,label,dly,avlty,schedulerType,mimo_mode,layers,cell,hdr,t_sim,measInterv,env,sinr):
 69 | 
 70 | label: must contain substring according to the type of service: eMBB, mMTC, URLLC\n
 71 | schedulerType: RR: Rounf Robin, PF: Proportional Fair (10, 11)\n
 72 | mimo_mode: SU, MU\n
 73 | layers: in SU-MIMO is the number of layers/UE, in MU-MIMO is the number of simultaneous UE to serve with the same resources\n
 74 | sinr: is a string starting starting with S if all ues have the same sinr or D if not. The value next will be the initial sinr of each ue or the maximum."""
 75 | 
 76 | #UEgroup2 = UEgroup(3,3,800000,300,1,10,'eMBB-1',10,'','RR','',1,cell1,t_sim,measInterv,env,'D37')
 77 | 
 78 | # Set UEgroups list according to the defined groups!!!
 79 | UEgroups = [UEgroup1,UEgroup2]#,UEgroup3]#,UEgroup4]
 80 | """UE group list for the configured simulation"""
 81 | #           Slices creation
 82 | for ueG in UEgroups:
 83 |     interSliceSche1.createSlice(ueG.req['reqDelay'],
 84 |     ueG.req['reqThroughputDL'],
 85 |     ueG.req['reqThroughputUL'],
 86 |     ueG.req['reqAvailability'],
 87 |     ueG.num_usersDL,
 88 |     ueG.num_usersUL,
 89 |     band,
 90 |     debMode,
 91 |     ueG.mmMd,
 92 |     ueG.lyrs,
 93 |     ueG.label,
 94 |     ueG.sch)
 95 | 
 96 | #      Schedulers activation (inter/intra)
 97 | 
 98 | procCell = env.process(cell1.updateStsts(env,interv=measInterv,tSim=t_sim))
 99 | procInter = env.process(interSliceSche1.resAlloc(env))
100 | for ueG in UEgroups:
101 |     ueG.activateSliceScheds(interSliceSche1,env)
102 | 
103 | #----------------------------------------------------------------
104 | env.run(until=t_sim)
105 | #----------------------------------------------------------------
106 | 
107 | #      Closing statistic and debugging files
108 | 
109 | for slice in list(cell1.slicesStsts.keys()):
110 |     cell1.slicesStsts[slice]['DL'].close()
111 |     cell1.slicesStsts[slice]['UL'].close()
112 | for slice in list(interSliceSche1.slices.keys()):
113 |         interSliceSche1.slices[slice].schedulerDL.dbFile.close()
114 |         if slice != 'LTE':
115 |             interSliceSche1.slices[slice].schedulerUL.dbFile.close()
116 | 
117 | #----------------------------------------------------------------
118 | #                          RESULTS
119 | #----------------------------------------------------------------
120 | # Show average PLR and Throughput in any case simulation and plots
121 | for UEg in UEgroups:
122 |     print (Format.CBOLD+Format.CBLUE+'\n--------------------------------------------------'+Format.CEND)
123 |     print (Format.CBOLD+Format.CBLUE+'                 SLICE: '+UEg.label+'                  '+Format.CEND)
124 |     print (Format.CBOLD+Format.CBLUE+'--------------------------------------------------\n'+Format.CEND)
125 |     UEg.printSliceResults(interSliceSche1,t_sim,bw,measInterv)
126 | print (Format.CBOLD+Format.CBLUE+'\n--------------------------------------------------'+Format.CEND)
127 | 


--------------------------------------------------------------------------------