Skip to content

Commit 1800b5e

Browse files
committed
rlc: retarget the entity doc comments at the concrete compounds
Several RLC leaf entity comments still said "Bound by default to BearerManagement.rlcUm{Rx,Tx}EntityModuleType" -- per-side parameters that stopped existing in v1.5.1, when entity selection was consolidated onto the per-bearer compound. Point them at the compound that actually binds them (~LteRlcUmEntity, ~NrRlcAmEntity, ...) instead, list both concretes in the RlcUm/RlcAmEntityBase comments now that the NR ones exist, and add the missing ~ cross-reference markers. Comments only.
1 parent bbd8210 commit 1800b5e

15 files changed

Lines changed: 29 additions & 29 deletions

simulations/lte/rlc/omnetpp.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ num-rngs = 2
104104
#
105105
# As Base, but every traffic class is carried over RLC AM, so that the CBR flow
106106
# lands on an AM bearer whichever class it is mapped to. LTE bearers use the LTE
107-
# AM entities (RlcAmEntity with the LteRlcAm* sides) by default.
107+
# AM entities (LteRlcAmEntity) by default.
108108
#
109109
[Config AmBase]
110110
abstract = true

src/simu5g/stack/rlc/LteRlcAmEntity.ned

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ package simu5g.stack.rlc;
1414
//
1515
// RLC AM entity of an LTE data radio bearer: the ~RlcAmEntityBase compound with
1616
// its TX/RX sides bound to the LTE (FI wire format, TS 36.322) entity profiles.
17-
// Selected by BearerManagement via its lteRlcAmEntityModuleType parameter,
18-
// which defaults to this type.
17+
// Selected by BearerManagement for LTE bearers via its lteRlcAmEntityModuleType
18+
// parameter, which defaults to this type.
1919
//
2020
module LteRlcAmEntity extends RlcAmEntityBase
2121
{

src/simu5g/stack/rlc/LteRlcUmEntity.ned

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ package simu5g.stack.rlc;
1414
//
1515
// RLC UM entity of an LTE data radio bearer: the ~RlcUmEntityBase compound with
1616
// its TX/RX sides bound to the LTE (FI wire format, TS 36.322) entity profiles.
17-
// Selected by BearerManagement via its lteRlcUmEntityModuleType parameter,
18-
// which defaults to this type.
17+
// Selected by BearerManagement for LTE bearers via its lteRlcUmEntityModuleType
18+
// parameter, which defaults to this type.
1919
//
2020
module LteRlcUmEntity extends RlcUmEntityBase
2121
{

src/simu5g/stack/rlc/NrRlcAmEntity.ned

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
package simu5g.stack.rlc;
1313

1414
//
15-
// RLC AM entity of an NR data radio bearer: the RlcAmEntityBase compound with its
16-
// TX/RX sides defaulted to the NR (SI/SO wire format, TS 38.322) entity
15+
// RLC AM entity of an NR data radio bearer: the ~RlcAmEntityBase compound with
16+
// its TX/RX sides bound to the NR (SI/SO wire format, TS 38.322) entity
1717
// profiles. Selected by BearerManagement for NR bearers via its
1818
// nrRlcAmEntityModuleType parameter.
1919
//

src/simu5g/stack/rlc/NrRlcUmEntity.ned

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
package simu5g.stack.rlc;
1313

1414
//
15-
// RLC UM entity of an NR data radio bearer: the RlcUmEntityBase compound with its
16-
// TX/RX sides defaulted to the NR (SI/SO wire format, TS 38.322) entity
15+
// RLC UM entity of an NR data radio bearer: the ~RlcUmEntityBase compound with
16+
// its TX/RX sides bound to the NR (SI/SO wire format, TS 38.322) entity
1717
// profiles. Selected by BearerManagement for NR bearers via its
1818
// nrRlcUmEntityModuleType parameter.
1919
//

src/simu5g/stack/rlc/RlcAmEntityBase.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ package simu5g.stack.rlc;
1818
// one per (peer, DRB) pair.
1919
//
2020
// This base type binds no TX/RX entity types; the concrete subclasses do
21-
// (~LteRlcAmEntity), so it is not instantiable on its own.
21+
// (~LteRlcAmEntity, ~NrRlcAmEntity), so it is not instantiable on its own.
2222
//
2323
// The receiving side hands control PDUs to the co-located transmitting side
2424
// over two internal connections:

src/simu5g/stack/rlc/RlcUmEntityBase.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ package simu5g.stack.rlc;
1818
// a bearer with traffic in one direction only simply leaves the other side idle.
1919
//
2020
// This base type binds no TX/RX entity types; the concrete subclasses do
21-
// (~LteRlcUmEntity), so it is not instantiable on its own.
21+
// (~LteRlcUmEntity, ~NrRlcUmEntity), so it is not instantiable on its own.
2222
//
2323
module RlcUmEntityBase
2424
{

src/simu5g/stack/rlc/am/LteRlcAmTxEntity.ned

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ package simu5g.stack.rlc.am;
2121
// t-PollRetransmit, and radio link failure at maxRtxThreshold retransmissions.
2222
// Shares the common RlcAmTxEntityBase shell with the NR profile
2323
// ~NrRlcAmTxEntity, whose ARQ skeleton it deliberately mirrors. Bound by
24-
// default inside the ~RlcAmEntity compound.
24+
// default inside the ~LteRlcAmEntity compound.
2525
//
2626
simple LteRlcAmTxEntity like simu5g.stack.rlc.IRlcAmTxEntity
2727
{

src/simu5g/stack/rlc/am/NrRlcAmRxEntity.ned

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ package simu5g.stack.rlc.am;
1515
// NR (TS 38.322) receiving side of the Acknowledged Mode (AM) of the RLC
1616
// layer: SO byte-coverage reassembly with a per-SDU SN window, t-Reassembly +
1717
// t-StatusProhibit timers. Shares the common RlcAmRxEntityBase shell with the
18-
// LTE profile ~LteRlcAmRxEntity. Bound by default to
19-
// BearerManagement.nrRlcAmEntityModuleType. The NR SO-reassembly statistics
20-
// are declared here so they are recorded only for NR-selected entities.
18+
// LTE profile ~LteRlcAmRxEntity. Bound by default inside the ~NrRlcAmEntity
19+
// compound. The NR SO-reassembly statistics are declared here so they are
20+
// recorded only for NR-selected entities.
2121
//
2222
simple NrRlcAmRxEntity like simu5g.stack.rlc.IRlcAmRxEntity
2323
{

src/simu5g/stack/rlc/am/NrRlcAmTxEntity.ned

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ package simu5g.stack.rlc.am;
1515
// NR (TS 38.322) transmission side of the Acknowledged Mode (AM) of the RLC
1616
// layer: byte-offset (SO) segmentation with re-segmentation on retransmission,
1717
// pollByte/pollPDU-driven status polling. Shares the common RlcAmTxEntityBase
18-
// shell with the LTE profile ~LteRlcAmTxEntity. Bound by default to
19-
// BearerManagement.nrRlcAmEntityModuleType. The NR SO-segmentation
20-
// statistics are declared here so they are recorded only for NR entities.
18+
// shell with the LTE profile ~LteRlcAmTxEntity. Bound by default inside the
19+
// ~NrRlcAmEntity compound. The NR SO-segmentation statistics are declared here
20+
// so they are recorded only for NR entities.
2121
//
2222
simple NrRlcAmTxEntity like simu5g.stack.rlc.IRlcAmTxEntity
2323
{

0 commit comments

Comments
 (0)