/usr/include/ns3.27/ns3/lte-rrc-sap.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Authors: Nicola Baldo <nbaldo@cttc.es>
* Lluis Parcerisa <lparcerisa@cttc.cat>
*/
#ifndef LTE_RRC_SAP_H
#define LTE_RRC_SAP_H
#include <stdint.h>
#include <list>
#include <ns3/ptr.h>
#include <ns3/simulator.h>
namespace ns3 {
class LteRlcSapUser;
class LtePdcpSapUser;
class LteRlcSapProvider;
class LtePdcpSapProvider;
class Packet;
/**
* \ingroup lte
*
* \brief Class holding definition common to all UE/eNodeB SAP Users/Providers.
*
* See 3GPP TS 36.331 for reference.
*
* Note that only those values that are (expected to be) used by the
* ns-3 model are mentioned here. The naming of the variables that are
* defined here is the same of 36.331, except for removal of "-" and
* conversion to CamelCase or ALL_CAPS where needed in order to follow
* the ns-3 coding style. Due to the 1-to-1 mapping with TS 36.331,
* detailed doxygen documentation is omitted, so please refer to
* 36.331 for the meaning of these data structures / fields.
*
*/
class LteRrcSap
{
public:
virtual ~LteRrcSap ();
/// Constraint values
static const uint8_t MaxReportCells = 255;
// Information Elements
/// PlmnIdentityInfo structure
struct PlmnIdentityInfo
{
uint32_t plmnIdentity; ///< PLMN identity
};
/// CellAccessRelatedInfo structure
struct CellAccessRelatedInfo
{
PlmnIdentityInfo plmnIdentityInfo; ///< PLMN identity info
uint32_t cellIdentity; ///< cell identity
bool csgIndication; ///< CSG indication
uint32_t csgIdentity; ///< CSG identity
};
/// CellSelectionInfo structure
struct CellSelectionInfo
{
int8_t qRxLevMin; ///< INTEGER (-70..-22), actual value = IE value * 2 [dBm].
int8_t qQualMin; ///< INTEGER (-34..-3), actual value = IE value [dB].
};
/// FreqInfo structure
struct FreqInfo
{
uint32_t ulCarrierFreq; ///< UL carrier frequency
uint8_t ulBandwidth; ///< UL bandwidth
};
/// RlcConfig structure
struct RlcConfig
{
/// the direction choice
enum direction
{
AM,
UM_BI_DIRECTIONAL,
UM_UNI_DIRECTIONAL_UL,
UM_UNI_DIRECTIONAL_DL
} choice; ///< direction choice
};
/// LogicalChannelConfig structure
struct LogicalChannelConfig
{
uint8_t priority; ///< priority
uint16_t prioritizedBitRateKbps; ///< prioritized bit rate Kbps
uint16_t bucketSizeDurationMs; ///< bucket size duration ms
uint8_t logicalChannelGroup; ///< logical channel group
};
/// SoundingRsUlConfigCommon structure
struct SoundingRsUlConfigCommon
{
/// the config action
enum action
{
SETUP, RESET
} type; ///< action type
uint8_t srsBandwidthConfig; ///< SRS bandwidth config
uint8_t srsSubframeConfig; ///< SRS subframe config
};
/// SoundingRsUlConfigDedicated structure
struct SoundingRsUlConfigDedicated
{
/// the config action
enum action
{
SETUP, RESET
} type; ///< action type
uint8_t srsBandwidth; ///< SRS bandwidth
uint16_t srsConfigIndex; ///< SRS config index
};
/// AntennaInfoDedicated structure
struct AntennaInfoDedicated
{
uint8_t transmissionMode; ///< transmission mode
};
/// PdschConfigCommon structure
struct PdschConfigCommon
{
int8_t referenceSignalPower; ///< INTEGER (-60..50),
int8_t pb; ///< INTEGER (0..3),
};
/// PdschConfigDedicated structure
struct PdschConfigDedicated
{
/**
* P_A values, TS 36.331 6.3.2 PDSCH-Config
* ENUMERATED { dB-6, dB-4dot77, dB-3, dB-1dot77, dB0, dB1, dB2, dB3 }
*/
enum db
{
dB_6,
dB_4dot77,
dB_3,
dB_1dot77,
dB0,
dB1,
dB2,
dB3
};
uint8_t pa; ///< P_A value
};
/**
* Convert PDSCH config dedicated function
*
* \param pdschConfigDedicated PdschConfigDedicated
* \returns double value
*/
static double ConvertPdschConfigDedicated2Double (PdschConfigDedicated pdschConfigDedicated)
{
double pa = 0;
switch (pdschConfigDedicated.pa)
{
case PdschConfigDedicated::dB_6:
pa = -6;
break;
case PdschConfigDedicated::dB_4dot77:
pa = -4.77;
break;
case PdschConfigDedicated::dB_3:
pa = -3;
break;
case PdschConfigDedicated::dB_1dot77:
pa = -1.77;
break;
case PdschConfigDedicated::dB0:
pa = 0;
break;
case PdschConfigDedicated::dB1:
pa = 1;
break;
case PdschConfigDedicated::dB2:
pa = 2;
break;
case PdschConfigDedicated::dB3:
pa = 3;
break;
default:
break;
}
return pa;
}
/// PhysicalConfigDedicated structure
struct PhysicalConfigDedicated
{
bool haveSoundingRsUlConfigDedicated; ///< have sounding RS UL config dedicated?
SoundingRsUlConfigDedicated soundingRsUlConfigDedicated; ///< sounding RS UL config dedicated
bool haveAntennaInfoDedicated; ///< have antenna info dedicated?
AntennaInfoDedicated antennaInfo; ///< antenna info
bool havePdschConfigDedicated; ///< have PDSCH config dedicated?
PdschConfigDedicated pdschConfigDedicated; ///< PDSCH config dedicated
};
/// SrbToAddMod structure
struct SrbToAddMod
{
uint8_t srbIdentity; ///< SB identity
LogicalChannelConfig logicalChannelConfig; ///< logical channel config
};
/// DrbToAddMod structure
struct DrbToAddMod
{
uint8_t epsBearerIdentity; ///< EPS bearer identity
uint8_t drbIdentity; ///< DRB identity
RlcConfig rlcConfig; ///< RLC config
uint8_t logicalChannelIdentity; ///< logical channel identify
LogicalChannelConfig logicalChannelConfig; ///< logical channel config
};
/// PreambleInfo structure
struct PreambleInfo
{
uint8_t numberOfRaPreambles; ///< number of RA preambles
};
/// RaSupervisionInfo structure
struct RaSupervisionInfo
{
uint8_t preambleTransMax; ///< preamble transmit maximum
uint8_t raResponseWindowSize; ///< RA response window size
};
/// RachConfigCommon structure
struct RachConfigCommon
{
PreambleInfo preambleInfo; ///< preamble info
RaSupervisionInfo raSupervisionInfo; ///< RA supervision info
};
/// RadioResourceConfigCommon structure
struct RadioResourceConfigCommon
{
RachConfigCommon rachConfigCommon; ///< RACH config common
};
/// RadioResourceConfigCommonSib structure
struct RadioResourceConfigCommonSib
{
RachConfigCommon rachConfigCommon; ///< RACH config common
PdschConfigCommon pdschConfigCommon; ///< PDSCH config common
};
/// RadioResourceConfigDedicated structure
struct RadioResourceConfigDedicated
{
std::list<SrbToAddMod> srbToAddModList; ///< SRB to add mod list
std::list<DrbToAddMod> drbToAddModList; ///< DRB to add mod list
std::list<uint8_t> drbToReleaseList; ///< DRB to release list
bool havePhysicalConfigDedicated; ///< have physical config dedicated?
PhysicalConfigDedicated physicalConfigDedicated; ///< physical config dedicated
};
/// QuantityConfig structure
struct QuantityConfig
{
uint8_t filterCoefficientRSRP; ///< filter coefficient RSRP
uint8_t filterCoefficientRSRQ; ///< filter coefficient RSRQ
};
/// CellsToAddMod structure
struct CellsToAddMod
{
uint8_t cellIndex; ///< cell index
uint16_t physCellId; ///< Phy cell ID
int8_t cellIndividualOffset; ///< cell individual offset
};
/// PhysCellIdRange structure
struct PhysCellIdRange
{
uint16_t start; ///< starting cell ID
bool haveRange; ///< has a range?
uint16_t range; ///< the range
};
/// BlackCellsToAddMod structure
struct BlackCellsToAddMod
{
uint8_t cellIndex; ///< cell index
PhysCellIdRange physCellIdRange; ///< Phy cell ID range
};
/// MeasObjectEutra structure
struct MeasObjectEutra
{
uint32_t carrierFreq; ///< carrier frequency
uint8_t allowedMeasBandwidth; ///< allowed measure bandwidth
bool presenceAntennaPort1; ///< antenna port 1 present?
uint8_t neighCellConfig; ///< neighbor cell config
int8_t offsetFreq; ///< offset frequency
std::list<uint8_t> cellsToRemoveList; ///< cells to remove list
std::list<CellsToAddMod> cellsToAddModList; ///< cells to add mod list
std::list<uint8_t> blackCellsToRemoveList; ///< black cells to remove list
std::list<BlackCellsToAddMod> blackCellsToAddModList; ///< black cells to add mod list
bool haveCellForWhichToReportCGI; ///< have cell for which to report CGI?
uint8_t cellForWhichToReportCGI; ///< cell for which to report CGI
};
/**
* \brief Threshold for event evaluation.
*
* For RSRP-based threshold, the actual value is (value - 140) dBm. While for
* RSRQ-based threshold, the actual value is (value - 40) / 2 dB. This is in
* accordance with section 9.1.4 and 9.1.7 of 3GPP TS 36.133.
*
* \sa ns3::EutranMeasurementMapping
*/
struct ThresholdEutra
{
/// Threshold enumeration
enum
{
THRESHOLD_RSRP, ///< RSRP is used for the threshold.
THRESHOLD_RSRQ ///< RSRQ is used for the threshold.
} choice;
uint8_t range; ///< Value range used in RSRP/RSRQ threshold.
};
/// Specifies criteria for triggering of an E-UTRA measurement reporting event.
struct ReportConfigEutra
{
/// Trigger enumeration
enum
{
EVENT, ///< event report
PERIODICAL ///< periodical report
} triggerType; ///< trigger type
/// Event enumeration
enum
{
EVENT_A1, ///< Event A1: Serving becomes better than absolute threshold.
EVENT_A2, ///< Event A2: Serving becomes worse than absolute threshold.
EVENT_A3, ///< Event A3: Neighbour becomes amount of offset better than PCell.
EVENT_A4, ///< Event A4: Neighbour becomes better than absolute threshold.
EVENT_A5 ///< Event A5: PCell becomes worse than absolute `threshold1` AND Neighbour becomes better than another absolute `threshold2`.
} eventId; ///< Choice of E-UTRA event triggered reporting criteria.
ThresholdEutra threshold1; ///< Threshold for event A1, A2, A4, and A5.
ThresholdEutra threshold2; ///< Threshold for event A5.
/// Indicates whether or not the UE shall initiate the measurement reporting procedure when the leaving condition is met for a cell in `cellsTriggeredList`, as specified in 5.5.4.1 of 3GPP TS 36.331.
bool reportOnLeave;
/// Offset value for Event A3. An integer between -30 and 30. The actual value is (value * 0.5) dB.
int8_t a3Offset;
/// Parameter used within the entry and leave condition of an event triggered reporting condition. The actual value is (value * 0.5) dB.
uint8_t hysteresis;
/// Time during which specific criteria for the event needs to be met in order to trigger a measurement report.
uint16_t timeToTrigger;
/// the report purpose
enum report
{
REPORT_STRONGEST_CELLS,
REPORT_CGI
} purpose; ///< purpose
/// Trigger type enumeration
enum
{
RSRP, ///< Reference Signal Received Power
RSRQ ///< Reference Signal Received Quality
} triggerQuantity; ///< The quantities used to evaluate the triggering condition for the event, see 3GPP TS 36.214.
/// Report type enumeration
enum
{
SAME_AS_TRIGGER_QUANTITY,
BOTH ///< Both the RSRP and RSRQ quantities are to be included in the measurement report.
} reportQuantity; ///< The quantities to be included in the measurement report, always assumed to be BOTH.
/// Maximum number of cells, excluding the serving cell, to be included in the measurement report.
uint8_t maxReportCells;
/// Report interval enumeration
enum
{
MS120,
MS240,
MS480,
MS640,
MS1024,
MS2048,
MS5120,
MS10240,
MIN1,
MIN6,
MIN12,
MIN30,
MIN60,
SPARE3,
SPARE2,
SPARE1
} reportInterval; ///< Indicates the interval between periodical reports.
/// Number of measurement reports applicable, always assumed to be infinite.
uint8_t reportAmount;
/// Report config eutra function
ReportConfigEutra ();
}; // end of struct ReportConfigEutra
/// MeasObjectToAddMod structure
struct MeasObjectToAddMod
{
uint8_t measObjectId; ///< measure object ID
MeasObjectEutra measObjectEutra; ///< measure object eutra
};
/// ReportConfigToAddMod structure
struct ReportConfigToAddMod
{
uint8_t reportConfigId; ///< report config ID
ReportConfigEutra reportConfigEutra; ///< report config eutra
};
/// MeasIdToAddMod structure
struct MeasIdToAddMod
{
uint8_t measId; ///< measure ID
uint8_t measObjectId; ///< measure object ID
uint8_t reportConfigId; ///< report config ID
};
/// MeasGapConfig structure
struct MeasGapConfig
{
/// the action type
enum action
{
SETUP, RESET
} type; ///< action type
/// the gap offest
enum gap
{
GP0, GP1
} gapOffsetChoice; ///< gap offset
uint8_t gapOffsetValue; ///< gap offset value
};
/// MobilityStateParameters structure
struct MobilityStateParameters
{
uint8_t tEvaluation; ///< evaluation
uint8_t tHystNormal; ///< hyst normal
uint8_t nCellChangeMedium; ///< cell change medium
uint8_t nCellChangeHigh; ///< cell change high
};
/// SpeedStateScaleFactors structure
struct SpeedStateScaleFactors
{
// 25 = oDot25, 50 = oDot5, 75 = oDot75, 100 = lDot0
uint8_t sfMedium; ///< scale factor medium
uint8_t sfHigh; ///< scale factor high
};
/// SpeedStatePars structure
struct SpeedStatePars
{
/// the action type
enum action
{
SETUP,
RESET
} type; ///< action type
MobilityStateParameters mobilityStateParameters; ///< mobility state parameters
SpeedStateScaleFactors timeToTriggerSf; ///< time to trigger scale factors
};
/// MeasConfig structure
struct MeasConfig
{
std::list<uint8_t> measObjectToRemoveList; ///< measure object to remove list
std::list<MeasObjectToAddMod> measObjectToAddModList; ///< measure object to add mod list
std::list<uint8_t> reportConfigToRemoveList; ///< report config to remove list
std::list<ReportConfigToAddMod> reportConfigToAddModList; ///< report config to add mod list
std::list<uint8_t> measIdToRemoveList; ///< measure ID to remove list
std::list<MeasIdToAddMod> measIdToAddModList; ///< measure ID to add mod list
bool haveQuantityConfig; ///< have quantity config?
QuantityConfig quantityConfig; ///< quantity config
bool haveMeasGapConfig; ///< have measure gap config?
MeasGapConfig measGapConfig; ///< measure gap config
bool haveSmeasure; ///< have S measure?
uint8_t sMeasure; ///< S measure
bool haveSpeedStatePars; ///< have speed state parameters?
SpeedStatePars speedStatePars; ///< speed state parameters
};
/// CarrierFreqEutra structure
struct CarrierFreqEutra
{
uint32_t dlCarrierFreq; ///< DL carrier frequency
uint32_t ulCarrierFreq; ///< UL carrier frequency
};
/// CarrierBandwidthEutra structure
struct CarrierBandwidthEutra
{
uint8_t dlBandwidth; ///< DL bandwidth
uint8_t ulBandwidth; ///< UL bandwidth
};
/// RachConfigDedicated structure
struct RachConfigDedicated
{
uint8_t raPreambleIndex; ///< RA preamble index
uint8_t raPrachMaskIndex; ///< RA PRACH mask index
};
/// MobilityControlInfo structure
struct MobilityControlInfo
{
uint16_t targetPhysCellId; ///< target Phy cell ID
bool haveCarrierFreq; ///< have carrier frequency?
CarrierFreqEutra carrierFreq; ///< carrier frequency
bool haveCarrierBandwidth; ///< have carrier bandwidth?
CarrierBandwidthEutra carrierBandwidth; ///< carrier bandwidth
uint16_t newUeIdentity; ///< new UE identity
RadioResourceConfigCommon radioResourceConfigCommon; ///< radio resource config common
bool haveRachConfigDedicated; ///< Have RACH config dedicated?
RachConfigDedicated rachConfigDedicated; ///< RACH config dedicated
};
/// ReestabUeIdentity structure
struct ReestabUeIdentity
{
uint16_t cRnti; ///< RNTI
uint16_t physCellId; ///< Phy cell ID
};
/// ReestablishmentCause enumeration
enum ReestablishmentCause
{
RECONFIGURATION_FAILURE,
HANDOVER_FAILURE,
OTHER_FAILURE
};
/// MasterInformationBlock structure
struct MasterInformationBlock
{
uint8_t dlBandwidth; ///< DL bandwidth
uint8_t systemFrameNumber; ///< system frame number
};
/// SystemInformationBlockType1 structure
struct SystemInformationBlockType1
{
CellAccessRelatedInfo cellAccessRelatedInfo; ///< cell access related info
CellSelectionInfo cellSelectionInfo; ///< cell selection info
};
/// SystemInformationBlockType2 structure
struct SystemInformationBlockType2
{
RadioResourceConfigCommonSib radioResourceConfigCommon; ///< radio resource config common
FreqInfo freqInfo; ///< frequency info
};
/// SystemInformation structure
struct SystemInformation
{
bool haveSib2; ///< have SIB2?
SystemInformationBlockType2 sib2; ///< SIB2
};
/// AsConfig structure
struct AsConfig
{
MeasConfig sourceMeasConfig; ///< source measure config
RadioResourceConfigDedicated sourceRadioResourceConfig; ///< source radio resource config
uint16_t sourceUeIdentity; ///< source UE identity
MasterInformationBlock sourceMasterInformationBlock; ///< source master information block
SystemInformationBlockType1 sourceSystemInformationBlockType1; ///< source system information block type 1
SystemInformationBlockType2 sourceSystemInformationBlockType2; ///< source system information block type 2
uint32_t sourceDlCarrierFreq; ///< source DL carrier frequency
};
/// CgiInfo structure
struct CgiInfo
{
uint32_t plmnIdentity; ///< PLMN identity
uint32_t cellIdentity; ///< cell identity
uint16_t trackingAreaCode; ///< tracking area code
std::list<uint32_t> plmnIdentityList; ///< PLMN identity list
};
/// MeasResultEutra structure
struct MeasResultEutra
{
uint16_t physCellId; ///< Phy cell ID
bool haveCgiInfo; ///< have CGI info?
CgiInfo cgiInfo; ///< CGI info
bool haveRsrpResult; ///< have RSRP result
uint8_t rsrpResult; ///< RSRP result
bool haveRsrqResult; ///< have RSRQ result?
uint8_t rsrqResult; ///< RSRQ result
};
/// MeasResultScell structure
struct MeasResultScell
{
uint16_t servFreqId; ///< service frequency ID
bool haveRsrpResult; ///< have RSRP result?
uint8_t rsrpResult; ///< the RSRP result
bool haveRsrqResult; ///< have RSRQ result?
uint8_t rsrqResult; ///< the RSRQ result
};
/// MeasResultBestNeighCell structure
struct MeasResultBestNeighCell
{
uint16_t servFreqId; ///< service frequency ID
uint16_t physCellId; ///< physical cell ID
bool haveRsrpResult; ///< have RSRP result?
uint8_t rsrpResult; ///< the RSRP result
bool haveRsrqResult; ///< have RSRQ result?
uint8_t rsrqResult; ///< the RSRQ result
};
/// MeasResultServFreqList
struct MeasResultServFreqList
{
bool haveMeasurementResultsServingSCells; ///< have measure results serving Scells
std::list<MeasResultScell> measResultScell; ///< measure results Scells
bool haveMeasurementResultsNeighCell; ///< always false since not implemented
std::list<MeasResultBestNeighCell> measResultBestNeighCell; ///< measure result best neighbor cell
};
/// MeasResults structure
struct MeasResults
{
uint8_t measId; ///< measure ID
uint8_t rsrpResult; ///< RSRP result
uint8_t rsrqResult; ///< RSRQ result
bool haveMeasResultNeighCells; ///< have measure result neighbor cells
std::list<MeasResultEutra> measResultListEutra; ///< measure result list eutra
bool haveScellsMeas; ///< has SCells measure
MeasResultServFreqList measScellResultList; ///< measure SCell result list
};
// Messages
/// RrcConnectionRequest structure
struct RrcConnectionRequest
{
uint64_t ueIdentity; ///< UE identity
};
/// RrcConnectionSetup structure
struct RrcConnectionSetup
{
uint8_t rrcTransactionIdentifier; ///< RRC transaction identifier
RadioResourceConfigDedicated radioResourceConfigDedicated; ///< radio resource config dedicated
};
/// RrcConnectionSetupCompleted structure
struct RrcConnectionSetupCompleted
{
uint8_t rrcTransactionIdentifier; ///< RRC transaction identifier
};
/// CellIdentification structure
struct CellIdentification
{
uint32_t physCellId; ///< physical cell ID
uint32_t dlCarrierFreq; ///< ARFCN - valueEUTRA
};
/// AntennaInfoCommon structure
struct AntennaInfoCommon
{
uint16_t antennaPortsCount; ///< antenna ports count
};
/// UlPowerControlCommonSCell structure
struct UlPowerControlCommonSCell
{
uint16_t alpha; ///< alpha value
};
/// PrachConfigSCell structure
struct PrachConfigSCell
{
uint16_t index; ///< the index
};
/// NonUlConfiguration structure
struct NonUlConfiguration
{
// 3GPP TS 36.311 v.11.10 R11 pag.220
/// 1: Cell characteristics
uint16_t dlBandwidth;
/// 2: Physical configuration, general antennaInfoCommon-r10
AntennaInfoCommon antennaInfoCommon;
// 3: Physical configuration, control phich-Config-r10
// Not Implemented
/// 4: Physical configuration, physical channels pdsch-ConfigCommon-r10
PdschConfigCommon pdschConfigCommon;
// 5: tdd-Config-r10
//Not Implemented
};
/// UlConfiguration structure
struct UlConfiguration
{
FreqInfo ulFreqInfo; ///< UL frequency info
UlPowerControlCommonSCell ulPowerControlCommonSCell; ///< 3GPP TS 36.331 v.11.10 R11 pag.223
SoundingRsUlConfigCommon soundingRsUlConfigCommon; ///< sounding RS UL config common
PrachConfigSCell prachConfigSCell; ///< PRACH config SCell
//PushConfigCommon pushConfigCommon; //NOT IMPLEMENTED!
};
/// AntennaInfoUl structure
struct AntennaInfoUl
{
uint8_t transmissionMode; ///< transmission mode
};
/// PuschConfigDedicatedSCell structure
struct PuschConfigDedicatedSCell
{
/// 3GPP TS 36.331 v.11.10 R11 page 216
uint16_t nPuschIdentity;
};
/// UlPowerControlDedicatedSCell structure
struct UlPowerControlDedicatedSCell
{
/// 3GPP TS 36.331 v.11.10 R11 page 234
uint16_t pSrsOffset;
};
/// PhysicalConfigDedicatedSCell structure
struct PhysicalConfigDedicatedSCell
{
// Non-Ul Configuration
bool haveNonUlConfiguration; ///< have non UL configuration?
bool haveAntennaInfoDedicated; ///< have antenna info dedicated?
AntennaInfoDedicated antennaInfo; ///< antenna info dedicated
bool crossCarrierSchedulingConfig; ///< currently implemented as boolean variable --> implementing crossCarrierScheduling is out of the scope of this GSoC proposal
bool havePdschConfigDedicated; ///< have PDSCH config dedicated?
PdschConfigDedicated pdschConfigDedicated; ///< PDSCH config dedicated
// Ul Configuration
bool haveUlConfiguration; ///< have UL configuration?
bool haveAntennaInfoUlDedicated; ///< have antenna info UL dedicated?
AntennaInfoDedicated antennaInfoUl; ///< antenna info UL
PuschConfigDedicatedSCell pushConfigDedicatedSCell; ///< PUSCH config dedicated SCell
UlPowerControlDedicatedSCell ulPowerControlDedicatedSCell; ///< UL power control dedicated SCell
bool haveSoundingRsUlConfigDedicated; ///< have sounding RS UL config dedicated?
SoundingRsUlConfigDedicated soundingRsUlConfigDedicated; ///< sounding RS UL config dedicated
};
/// RadioResourceConfigCommonSCell
struct RadioResourceConfigCommonSCell
{
bool haveNonUlConfiguration; ///< have non UL configuration?
NonUlConfiguration nonUlConfiguration; ///< non UL configuration
bool haveUlConfiguration; ///< have UL configuration
UlConfiguration ulConfiguration; ///< UL configuration
};
/// RadioResourceConfigDedicatedSCell structure
struct RadioResourceConfigDedicatedSCell
{
PhysicalConfigDedicatedSCell physicalConfigDedicatedSCell; ///< physical config dedicated SCell
};
/// SCellToAddMod structure
struct SCellToAddMod
{
uint32_t sCellIndex; ///< SCell index
CellIdentification cellIdentification; ///< cell identification
RadioResourceConfigCommonSCell radioResourceConfigCommonSCell; ///< radio resource config common SCell
bool haveRadioResourceConfigDedicatedSCell; ///< have radio resource config dedicated SCell?
RadioResourceConfigDedicatedSCell radioResourceConfigDedicateSCell; ///< radio resource config dedicated SCell
};
/// NonCriticalExtensionConfiguration structure
struct NonCriticalExtensionConfiguration
{
std::list<SCellToAddMod> sCellsToAddModList; ///< SCell to add mod list
std::list<uint32_t> sCellToReleaseList; ///< SCell to release list
};
/// RrcConnectionReconfiguration structure
struct RrcConnectionReconfiguration
{
uint8_t rrcTransactionIdentifier; ///< RRC transaction identifier
bool haveMeasConfig; ///< have measure config
MeasConfig measConfig; ///< measure config
bool haveMobilityControlInfo; ///< have mobility control info
MobilityControlInfo mobilityControlInfo; ///< mobility control info
bool haveRadioResourceConfigDedicated; ///< have radio resource config dedicated
RadioResourceConfigDedicated radioResourceConfigDedicated; ///< radio resource config dedicated
bool haveNonCriticalExtension; ///< have critical extension?
/// 3GPP TS 36.331 v.11.10 R11 Sec. 6.2.2 pag. 147 (also known as ETSI TS 136 331 v.11.10 Feb-2015)
NonCriticalExtensionConfiguration nonCriticalExtension;
};
/// RrcConnectionReconfigurationCompleted structure
struct RrcConnectionReconfigurationCompleted
{
uint8_t rrcTransactionIdentifier; ///< RRC transaction identifier
};
/// RrcConnectionReestablishmentRequest structure
struct RrcConnectionReestablishmentRequest
{
ReestabUeIdentity ueIdentity; ///< UE identity
ReestablishmentCause reestablishmentCause; ///< reestablishment cause
};
/// RrcConnectionReestablishment structure
struct RrcConnectionReestablishment
{
uint8_t rrcTransactionIdentifier; ///< RRC transaction identifier
RadioResourceConfigDedicated radioResourceConfigDedicated; ///< radio resource config dedicated
};
/// RrcConnectionReestablishmentComplete structure
struct RrcConnectionReestablishmentComplete
{
uint8_t rrcTransactionIdentifier; ///< RRC transaction identifier
};
/// RrcConnectionReestablishmentReject structure
struct RrcConnectionReestablishmentReject
{
};
/// RrcConnectionRelease structure
struct RrcConnectionRelease
{
uint8_t rrcTransactionIdentifier; ///< RRC transaction identifier
};
/// RrcConnectionReject structure
struct RrcConnectionReject
{
uint8_t waitTime; ///< wait time
};
/// HandoverPreparationInfo structure
struct HandoverPreparationInfo
{
AsConfig asConfig; ///< AS config
};
/// MeasurementReport structure
struct MeasurementReport
{
MeasResults measResults; ///< measure results
};
};
/**
* \brief Part of the RRC protocol. This Service Access Point (SAP) is used by
* the UE RRC to send messages to the eNB. Each method defined in this
* class corresponds to the transmission of a message that is defined in
* Section 6.2.2 of TS 36.331.
*/
class LteUeRrcSapUser : public LteRrcSap
{
public:
/// SetupParameters structure
struct SetupParameters
{
LteRlcSapProvider* srb0SapProvider; ///< SRB0 SAP provider
LtePdcpSapProvider* srb1SapProvider; ///< SRB1 SAP provider
};
/**
* \brief Setup function
* \param params the setup parameters
*/
virtual void Setup (SetupParameters params) = 0;
/**
* \brief Send an _RRCConnectionRequest message to the serving eNodeB
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param msg the message
*/
virtual void SendRrcConnectionRequest (RrcConnectionRequest msg) = 0;
/**
* \brief Send an _RRCConnectionSetupComplete_ message to the serving eNodeB
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param msg the message
*/
virtual void SendRrcConnectionSetupCompleted (RrcConnectionSetupCompleted msg) = 0;
/**
* \brief Send an _RRCConnectionReconfigurationComplete_ message to the serving eNodeB
* during an RRC connection reconfiguration procedure
* (Section 5.3.5 of TS 36.331).
* \param msg the message
*/
virtual void SendRrcConnectionReconfigurationCompleted (RrcConnectionReconfigurationCompleted msg) = 0;
/**
* \brief Send an _RRCConnectionReestablishmentRequest_ message to the serving eNodeB
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param msg the message
*/
virtual void SendRrcConnectionReestablishmentRequest (RrcConnectionReestablishmentRequest msg) = 0;
/**
* \brief Send an _RRCConnectionReestablishmentComplete_ message to the serving eNodeB
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param msg the message
*/
virtual void SendRrcConnectionReestablishmentComplete (RrcConnectionReestablishmentComplete msg) = 0;
/**
* \brief Send a _MeasurementReport_ message to the serving eNodeB
* during a measurement reporting procedure
* (Section 5.5.5 of TS 36.331).
* \param msg the message
*/
virtual void SendMeasurementReport (MeasurementReport msg) = 0;
};
/**
* \brief Part of the RRC protocol. This Service Access Point (SAP) is used to
* let the UE RRC receive a message from the eNB RRC. Each method defined
* in this class corresponds to the reception of a message that is
* defined in Section 6.2.2 of TS 36.331.
*/
class LteUeRrcSapProvider : public LteRrcSap
{
public:
/// CompleteSetupParameters structure
struct CompleteSetupParameters
{
LteRlcSapUser* srb0SapUser; ///< SRB0 SAP user
LtePdcpSapUser* srb1SapUser; ///< SRB1 SAP user
};
/**
* \brief Complete setup function
* \param params the complete setup parameters
*/
virtual void CompleteSetup (CompleteSetupParameters params) = 0;
/**
* \brief Receive a _SystemInformation_ message from the serving eNodeB
* during a system information acquisition procedure
* (Section 5.2.2 of TS 36.331).
* \param msg the message
*/
virtual void RecvSystemInformation (SystemInformation msg) = 0;
/**
* \brief Receive an _RRCConnectionSetup_ message from the serving eNodeB
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param msg the message
*/
virtual void RecvRrcConnectionSetup (RrcConnectionSetup msg) = 0;
/**
* \brief Receive an _RRCConnectionReconfiguration_ message from the serving eNodeB
* during an RRC connection reconfiguration procedure
* (Section 5.3.5 of TS 36.331).
* \param msg the message
*/
virtual void RecvRrcConnectionReconfiguration (RrcConnectionReconfiguration msg) = 0;
/**
* \brief Receive an _RRCConnectionReestablishment_ message from the serving eNodeB
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param msg the message
*/
virtual void RecvRrcConnectionReestablishment (RrcConnectionReestablishment msg) = 0;
/**
* \brief Receive an _RRCConnectionReestablishmentReject_ message from the serving eNodeB
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param msg the message
*/
virtual void RecvRrcConnectionReestablishmentReject (RrcConnectionReestablishmentReject msg) = 0;
/**
* \brief Receive an _RRCConnectionRelease_ message from the serving eNodeB
* during an RRC connection release procedure
* (Section 5.3.8 of TS 36.331).
* \param msg the message
*/
virtual void RecvRrcConnectionRelease (RrcConnectionRelease msg) = 0;
/**
* \brief Receive an _RRCConnectionReject_ message from the serving eNodeB
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param msg the message
*/
virtual void RecvRrcConnectionReject (RrcConnectionReject msg) = 0;
};
/**
* \brief Part of the RRC protocol. This Service Access Point (SAP) is used by
* the eNB RRC to send messages to the UE RRC. Each method defined in
* this class corresponds to the transmission of a message that is
* defined in Section 6.2.2 of TS 36.331.
*/
class LteEnbRrcSapUser : public LteRrcSap
{
public:
/// SetupUeParameters structure
struct SetupUeParameters
{
LteRlcSapProvider* srb0SapProvider; ///< SRB0 SAP provider
LtePdcpSapProvider* srb1SapProvider; ///< SRB1 SAP provider
};
/**
* \brief Setup UE function
* \param rnti the RNTI
* \param params the setup UE parameters
*/
virtual void SetupUe (uint16_t rnti, SetupUeParameters params) = 0;
/**
* \brief Remove UE function
* \param rnti the RNTI
*/
virtual void RemoveUe (uint16_t rnti) = 0;
/**
* \brief Send a _SystemInformation_ message to all attached UEs
* during a system information acquisition procedure
* (Section 5.2.2 of TS 36.331).
* \param cellId cell ID
* \param msg the message
*/
virtual void SendSystemInformation (uint16_t cellId, SystemInformation msg) = 0;
/**
* \brief Send an _RRCConnectionSetup_ message to a UE
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param rnti the RNTI of the destination UE
* \param msg the message
*/
virtual void SendRrcConnectionSetup (uint16_t rnti, RrcConnectionSetup msg) = 0;
/**
* \brief Send an _RRCConnectionReconfiguration_ message to a UE
* during an RRC connection reconfiguration procedure
* (Section 5.3.5 of TS 36.331).
* \param rnti the RNTI of the destination UE
* \param msg the message
*/
virtual void SendRrcConnectionReconfiguration (uint16_t rnti, RrcConnectionReconfiguration msg) = 0;
/**
* \brief Send an _RRCConnectionReestablishment_ message to a UE
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param rnti the RNTI of the destination UE
* \param msg the message
*/
virtual void SendRrcConnectionReestablishment (uint16_t rnti, RrcConnectionReestablishment msg) = 0;
/**
* \brief Send an _RRCConnectionReestablishmentReject_ message to a UE
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param rnti the RNTI of the destination UE
* \param msg the message
*/
virtual void SendRrcConnectionReestablishmentReject (uint16_t rnti, RrcConnectionReestablishmentReject msg) = 0;
/**
* \brief Send an _RRCConnectionRelease_ message to a UE
* during an RRC connection release procedure
* (Section 5.3.8 of TS 36.331).
* \param rnti the RNTI of the destination UE
* \param msg the message
*/
virtual void SendRrcConnectionRelease (uint16_t rnti, RrcConnectionRelease msg) = 0;
/**
* \brief Send an _RRCConnectionReject_ message to a UE
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param rnti the RNTI of the destination UE
* \param msg the message
*/
virtual void SendRrcConnectionReject (uint16_t rnti, RrcConnectionReject msg) = 0;
/**
* \brief Encode handover prepration information
* \param msg HandoverPreparationInfo
* \returns the packet
*/
virtual Ptr<Packet> EncodeHandoverPreparationInformation (HandoverPreparationInfo msg) = 0;
/**
* \brief Decode handover prepration information
* \param p the packet
* \returns HandoverPreparationInfo
*/
virtual HandoverPreparationInfo DecodeHandoverPreparationInformation (Ptr<Packet> p) = 0;
/**
* \brief Encode handover command
* \param msg RrcConnectionReconfiguration
* \returns the packet
*/
virtual Ptr<Packet> EncodeHandoverCommand (RrcConnectionReconfiguration msg) = 0;
/**
* \brief Decode handover command
* \param p the packet
* \returns RrcConnectionReconfiguration
*/
virtual RrcConnectionReconfiguration DecodeHandoverCommand (Ptr<Packet> p) = 0;
};
/**
* \brief Part of the RRC protocol. This Service Access Point (SAP) is used to
* let the eNB RRC receive a message from a UE RRC. Each method defined
* in this class corresponds to the reception of a message that is
* defined in Section 6.2.2 of TS 36.331.
*/
class LteEnbRrcSapProvider : public LteRrcSap
{
public:
/// CompleteSetupUeParameters structure
struct CompleteSetupUeParameters
{
LteRlcSapUser* srb0SapUser; ///< SRB0 SAP user
LtePdcpSapUser* srb1SapUser; ///< SRB1 SAP user
};
/**
* \brief Complete setup UE function
* \param rnti the RNTI of UE which sent the message
* \param params CompleteSetupUeParameters
*/
virtual void CompleteSetupUe (uint16_t rnti, CompleteSetupUeParameters params) = 0;
/**
* \brief Receive an _RRCConnectionRequest_ message from a UE
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param rnti the RNTI of UE which sent the message
* \param msg the message
*/
virtual void RecvRrcConnectionRequest (uint16_t rnti,
RrcConnectionRequest msg) = 0;
/**
* \brief Receive an _RRCConnectionSetupComplete_ message from a UE
* during an RRC connection establishment procedure
* (Section 5.3.3 of TS 36.331).
* \param rnti the RNTI of UE which sent the message
* \param msg the message
*/
virtual void RecvRrcConnectionSetupCompleted (uint16_t rnti,
RrcConnectionSetupCompleted msg) = 0;
/**
* \brief Receive an _RRCConnectionReconfigurationComplete_ message from a UE
* during an RRC connection reconfiguration procedure
* (Section 5.3.5 of TS 36.331).
* \param rnti the RNTI of UE which sent the message
* \param msg the message
*/
virtual void RecvRrcConnectionReconfigurationCompleted (uint16_t rnti,
RrcConnectionReconfigurationCompleted msg) = 0;
/**
* \brief Receive an _RRCConnectionReestablishmentRequest_ message from a UE
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param rnti the RNTI of UE which sent the message
* \param msg the message
*/
virtual void RecvRrcConnectionReestablishmentRequest (uint16_t rnti,
RrcConnectionReestablishmentRequest msg) = 0;
/**
* \brief Receive an _RRCConnectionReestablishmentComplete_ message from a UE
* during an RRC connection re-establishment procedure
* (Section 5.3.7 of TS 36.331).
* \param rnti the RNTI of UE which sent the message
* \param msg the message
*/
virtual void RecvRrcConnectionReestablishmentComplete (uint16_t rnti,
RrcConnectionReestablishmentComplete msg) = 0;
/**
* \brief Receive a _MeasurementReport_ message from a UE
* during a measurement reporting procedure
* (Section 5.5.5 of TS 36.331).
* \param rnti the RNTI of UE which sent the message
* \param msg the message
*/
virtual void RecvMeasurementReport (uint16_t rnti, MeasurementReport msg) = 0;
};
////////////////////////////////////
// templates
////////////////////////////////////
/**
* Template for the implementation of the LteUeRrcSapUser as a member
* of an owner class of type C to which all methods are forwarded
*
*/
template <class C>
class MemberLteUeRrcSapUser : public LteUeRrcSapUser
{
public:
/**
* Constructor
*
* \param owner the owner class
*/
MemberLteUeRrcSapUser (C* owner);
// inherited from LteUeRrcSapUser
virtual void Setup (SetupParameters params);
virtual void SendRrcConnectionRequest (RrcConnectionRequest msg);
virtual void SendRrcConnectionSetupCompleted (RrcConnectionSetupCompleted msg);
virtual void SendRrcConnectionReconfigurationCompleted (RrcConnectionReconfigurationCompleted msg);
virtual void SendRrcConnectionReestablishmentRequest (RrcConnectionReestablishmentRequest msg);
virtual void SendRrcConnectionReestablishmentComplete (RrcConnectionReestablishmentComplete msg);
virtual void SendMeasurementReport (MeasurementReport msg);
private:
MemberLteUeRrcSapUser ();
C* m_owner; ///< the owner class
};
template <class C>
MemberLteUeRrcSapUser<C>::MemberLteUeRrcSapUser (C* owner)
: m_owner (owner)
{
}
template <class C>
MemberLteUeRrcSapUser<C>::MemberLteUeRrcSapUser ()
{
}
template <class C>
void
MemberLteUeRrcSapUser<C>::Setup (SetupParameters params)
{
m_owner->DoSetup (params);
}
template <class C>
void
MemberLteUeRrcSapUser<C>::SendRrcConnectionRequest (RrcConnectionRequest msg)
{
m_owner->DoSendRrcConnectionRequest (msg);
}
template <class C>
void
MemberLteUeRrcSapUser<C>::SendRrcConnectionSetupCompleted (RrcConnectionSetupCompleted msg)
{
m_owner->DoSendRrcConnectionSetupCompleted (msg);
}
template <class C>
void
MemberLteUeRrcSapUser<C>::SendRrcConnectionReconfigurationCompleted (RrcConnectionReconfigurationCompleted msg)
{
m_owner->DoSendRrcConnectionReconfigurationCompleted (msg);
}
template <class C>
void
MemberLteUeRrcSapUser<C>::SendRrcConnectionReestablishmentRequest (RrcConnectionReestablishmentRequest msg)
{
m_owner->DoSendRrcConnectionReestablishmentRequest (msg);
}
template <class C>
void
MemberLteUeRrcSapUser<C>::SendRrcConnectionReestablishmentComplete (RrcConnectionReestablishmentComplete msg)
{
m_owner->DoSendRrcConnectionReestablishmentComplete (msg);
}
template <class C>
void
MemberLteUeRrcSapUser<C>::SendMeasurementReport (MeasurementReport msg)
{
m_owner->DoSendMeasurementReport (msg);
}
/**
* Template for the implementation of the LteUeRrcSapProvider as a member
* of an owner class of type C to which all methods are forwarded
*
*/
template <class C>
class MemberLteUeRrcSapProvider : public LteUeRrcSapProvider
{
public:
/**
* Constructor
*
* \param owner the owner class
*/
MemberLteUeRrcSapProvider (C* owner);
// methods inherited from LteUeRrcSapProvider go here
virtual void CompleteSetup (CompleteSetupParameters params);
virtual void RecvSystemInformation (SystemInformation msg);
virtual void RecvRrcConnectionSetup (RrcConnectionSetup msg);
virtual void RecvRrcConnectionReconfiguration (RrcConnectionReconfiguration msg);
virtual void RecvRrcConnectionReestablishment (RrcConnectionReestablishment msg);
virtual void RecvRrcConnectionReestablishmentReject (RrcConnectionReestablishmentReject msg);
virtual void RecvRrcConnectionRelease (RrcConnectionRelease msg);
virtual void RecvRrcConnectionReject (RrcConnectionReject msg);
private:
MemberLteUeRrcSapProvider ();
C* m_owner; ///< the owner class
};
template <class C>
MemberLteUeRrcSapProvider<C>::MemberLteUeRrcSapProvider (C* owner)
: m_owner (owner)
{
}
template <class C>
MemberLteUeRrcSapProvider<C>::MemberLteUeRrcSapProvider ()
{
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::CompleteSetup (CompleteSetupParameters params)
{
m_owner->DoCompleteSetup (params);
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::RecvSystemInformation (SystemInformation msg)
{
Simulator::ScheduleNow (&C::DoRecvSystemInformation, m_owner, msg);
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::RecvRrcConnectionSetup (RrcConnectionSetup msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionSetup, m_owner, msg);
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::RecvRrcConnectionReconfiguration (RrcConnectionReconfiguration msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionReconfiguration, m_owner, msg);
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::RecvRrcConnectionReestablishment (RrcConnectionReestablishment msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionReestablishment, m_owner, msg);
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::RecvRrcConnectionReestablishmentReject (RrcConnectionReestablishmentReject msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionReestablishmentReject, m_owner, msg);
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::RecvRrcConnectionRelease (RrcConnectionRelease msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionRelease, m_owner, msg);
}
template <class C>
void
MemberLteUeRrcSapProvider<C>::RecvRrcConnectionReject (RrcConnectionReject msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionReject, m_owner, msg);
}
/**
* Template for the implementation of the LteEnbRrcSapUser as a member
* of an owner class of type C to which all methods are forwarded
*
*/
template <class C>
class MemberLteEnbRrcSapUser : public LteEnbRrcSapUser
{
public:
/**
* Constructor
*
* \param owner the owner class
*/
MemberLteEnbRrcSapUser (C* owner);
// inherited from LteEnbRrcSapUser
virtual void SetupUe (uint16_t rnti, SetupUeParameters params);
virtual void RemoveUe (uint16_t rnti);
virtual void SendSystemInformation (uint16_t cellId, SystemInformation msg);
virtual void SendRrcConnectionSetup (uint16_t rnti, RrcConnectionSetup msg);
virtual void SendRrcConnectionReconfiguration (uint16_t rnti, RrcConnectionReconfiguration msg);
virtual void SendRrcConnectionReestablishment (uint16_t rnti, RrcConnectionReestablishment msg);
virtual void SendRrcConnectionReestablishmentReject (uint16_t rnti, RrcConnectionReestablishmentReject msg);
virtual void SendRrcConnectionRelease (uint16_t rnti, RrcConnectionRelease msg);
virtual void SendRrcConnectionReject (uint16_t rnti, RrcConnectionReject msg);
virtual Ptr<Packet> EncodeHandoverPreparationInformation (HandoverPreparationInfo msg);
virtual HandoverPreparationInfo DecodeHandoverPreparationInformation (Ptr<Packet> p);
virtual Ptr<Packet> EncodeHandoverCommand (RrcConnectionReconfiguration msg);
virtual RrcConnectionReconfiguration DecodeHandoverCommand (Ptr<Packet> p);
private:
MemberLteEnbRrcSapUser ();
C* m_owner; ///< the owner class
};
template <class C>
MemberLteEnbRrcSapUser<C>::MemberLteEnbRrcSapUser (C* owner)
: m_owner (owner)
{
}
template <class C>
MemberLteEnbRrcSapUser<C>::MemberLteEnbRrcSapUser ()
{
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SetupUe (uint16_t rnti, SetupUeParameters params)
{
m_owner->DoSetupUe (rnti, params);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::RemoveUe (uint16_t rnti)
{
m_owner->DoRemoveUe (rnti);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SendSystemInformation (uint16_t cellId, SystemInformation msg)
{
m_owner->DoSendSystemInformation (cellId, msg);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SendRrcConnectionSetup (uint16_t rnti, RrcConnectionSetup msg)
{
m_owner->DoSendRrcConnectionSetup (rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SendRrcConnectionReconfiguration (uint16_t rnti, RrcConnectionReconfiguration msg)
{
m_owner->DoSendRrcConnectionReconfiguration (rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SendRrcConnectionReestablishment (uint16_t rnti, RrcConnectionReestablishment msg)
{
m_owner->DoSendRrcConnectionReestablishment (rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SendRrcConnectionReestablishmentReject (uint16_t rnti, RrcConnectionReestablishmentReject msg)
{
m_owner->DoSendRrcConnectionReestablishmentReject (rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SendRrcConnectionRelease (uint16_t rnti, RrcConnectionRelease msg)
{
m_owner->DoSendRrcConnectionRelease (rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapUser<C>::SendRrcConnectionReject (uint16_t rnti, RrcConnectionReject msg)
{
m_owner->DoSendRrcConnectionReject (rnti, msg);
}
template <class C>
Ptr<Packet>
MemberLteEnbRrcSapUser<C>::EncodeHandoverPreparationInformation (HandoverPreparationInfo msg)
{
return m_owner->DoEncodeHandoverPreparationInformation (msg);
}
template <class C>
LteRrcSap::HandoverPreparationInfo
MemberLteEnbRrcSapUser<C>::DecodeHandoverPreparationInformation (Ptr<Packet> p)
{
return m_owner->DoDecodeHandoverPreparationInformation (p);
}
template <class C>
Ptr<Packet>
MemberLteEnbRrcSapUser<C>::EncodeHandoverCommand (RrcConnectionReconfiguration msg)
{
return m_owner->DoEncodeHandoverCommand (msg);
}
template <class C>
LteRrcSap::RrcConnectionReconfiguration
MemberLteEnbRrcSapUser<C>::DecodeHandoverCommand (Ptr<Packet> p)
{
return m_owner->DoDecodeHandoverCommand (p);
}
/**
* Template for the implementation of the LteEnbRrcSapProvider as a member
* of an owner class of type C to which all methods are forwarded
*
*/
template <class C>
class MemberLteEnbRrcSapProvider : public LteEnbRrcSapProvider
{
public:
/**
* Constructor
*
* \param owner
*/
MemberLteEnbRrcSapProvider (C* owner);
// methods inherited from LteEnbRrcSapProvider go here
virtual void CompleteSetupUe (uint16_t rnti, CompleteSetupUeParameters params);
virtual void RecvRrcConnectionRequest (uint16_t rnti, RrcConnectionRequest msg);
virtual void RecvRrcConnectionSetupCompleted (uint16_t rnti, RrcConnectionSetupCompleted msg);
virtual void RecvRrcConnectionReconfigurationCompleted (uint16_t rnti, RrcConnectionReconfigurationCompleted msg);
virtual void RecvRrcConnectionReestablishmentRequest (uint16_t rnti, RrcConnectionReestablishmentRequest msg);
virtual void RecvRrcConnectionReestablishmentComplete (uint16_t rnti, RrcConnectionReestablishmentComplete msg);
virtual void RecvMeasurementReport (uint16_t rnti, MeasurementReport msg);
private:
MemberLteEnbRrcSapProvider ();
C* m_owner; ///< the owner class
};
template <class C>
MemberLteEnbRrcSapProvider<C>::MemberLteEnbRrcSapProvider (C* owner)
: m_owner (owner)
{
}
template <class C>
MemberLteEnbRrcSapProvider<C>::MemberLteEnbRrcSapProvider ()
{
}
template <class C>
void
MemberLteEnbRrcSapProvider<C>::CompleteSetupUe (uint16_t rnti, CompleteSetupUeParameters params)
{
m_owner->DoCompleteSetupUe (rnti, params);
}
template <class C>
void
MemberLteEnbRrcSapProvider<C>::RecvRrcConnectionRequest (uint16_t rnti, RrcConnectionRequest msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionRequest, m_owner, rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapProvider<C>::RecvRrcConnectionSetupCompleted (uint16_t rnti, RrcConnectionSetupCompleted msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionSetupCompleted, m_owner, rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapProvider<C>::RecvRrcConnectionReconfigurationCompleted (uint16_t rnti, RrcConnectionReconfigurationCompleted msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionReconfigurationCompleted, m_owner, rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapProvider<C>::RecvRrcConnectionReestablishmentRequest (uint16_t rnti, RrcConnectionReestablishmentRequest msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionReestablishmentRequest, m_owner, rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapProvider<C>::RecvRrcConnectionReestablishmentComplete (uint16_t rnti, RrcConnectionReestablishmentComplete msg)
{
Simulator::ScheduleNow (&C::DoRecvRrcConnectionReestablishmentComplete, m_owner, rnti, msg);
}
template <class C>
void
MemberLteEnbRrcSapProvider<C>::RecvMeasurementReport (uint16_t rnti, MeasurementReport msg)
{
Simulator::ScheduleNow (&C::DoRecvMeasurementReport, m_owner, rnti, msg);
}
} // namespace ns3
#endif // LTE_RRC_SAP_H
|