F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

lte: Fix doxygen issues

Browse Source
This commit is contained in:
Zoraze Ali
2018-08-25 21:58:09 -07:00
parent 07bd8e28e7
commit 9499352730
9 changed files with 80 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/lte/model/epc-enb-application.h
View File

@@ -72,12 +72,11 @@ public:
* Constructor
*
* \param lteSocket the socket to be used to send/receive IPv4 packets to/from the LTE radio interface
* \param lteSocket the socket to be used to send/receive IPv6 packets to/from the LTE radio interface
* \param s1uSocket the socket to be used to send/receive packets
* to/from the S1-U interface connected with the SGW
* \param lteSocket6 the socket to be used to send/receive IPv6 packets to/from the LTE radio interface
* \param s1uSocket the socket to be used to send/receive packets to/from the S1-U interface connected with the SGW
* \param enbS1uAddress the IPv4 address of the S1-U interface of this eNB
* \param sgwS1uAddress the IPv4 address at which this eNB will be able to reach its SGW for S1-U communications
* \param cellId the identifier of the enb
* \param cellId the identifier of the eNB
*/
EpcEnbApplication (Ptr<Socket> lteSocket, Ptr<Socket> lteSocket6, Ptr<Socket> s1uSocket, Ipv4Address enbS1uAddress, Ipv4Address sgwS1uAddress, uint16_t cellId);

1
src/lte/model/lte-enb-rrc.cc
View File

@@ -64,6 +64,7 @@ public:
* Constructor
*
* \param rrc ENB RRC
* \param componentCarrierId
*/
EnbRrcMemberLteEnbCmacSapUser (LteEnbRrc* rrc, uint8_t componentCarrierId);

1
src/lte/model/lte-enb-rrc.h
View File

@@ -836,7 +836,6 @@ public:
/**
* \brief Configure cell-specific parameters.
* \param cellId the ID of the cell
*
* Configure cell-specific parameters and propagate them to lower layers.
* The parameters include bandwidth, EARFCN (E-UTRA Absolute Radio Frequency

6
src/lte/model/lte-spectrum-value-helper.h
View File

@@ -50,7 +50,7 @@ public:
/**
* Converts downlink EARFCN to corresponding LTE frequency band number.
*
* \param earfcn the EARFCN
* \param nDl the EARFCN
*
* \return the downlink carrier band
*/
@@ -59,11 +59,11 @@ public:
/**
* Converts uplink EARFCN to corresponding LTE frequency band number.
*
* \param earfcn the EARFCN
* \param nUl the EARFCN
*
* \return the uplink carrier band
*/
static uint16_t GetUplinkCarrierBand (uint32_t nDl);
static uint16_t GetUplinkCarrierBand (uint32_t nUl);
/**
* Calculates the downlink carrier frequency from the E-UTRA Absolute

10
src/lte/test/lte-test-aggregation-throughput-scale.h
View File

@@ -61,10 +61,16 @@ private:
*/
virtual void DoRun ();
/**
* \brief Get throughput function
*
* \param numberOfComponentCarriers Number of component carriers
* \return The total data received (in Megabits)
*/
double GetThroughput (uint8_t numberOfComponentCarriers);
uint16_t m_expectedCellId; //< Cell ID UE is expected to attach to
uint16_t m_actualCellId; //< Cell ID UE has attached to
uint16_t m_expectedCellId; ///< Cell ID UE is expected to attach to
uint16_t m_actualCellId; ///< Cell ID UE has attached to
};
#endif /* LTE_AGGREGATION_THROUGHPUT_SCALE_H */

62
src/lte/test/lte-test-carrier-aggregation-configuration.cc
View File

@@ -61,25 +61,33 @@ using namespace ns3;
* is not static, as reported in BUG 2840.
*/
/// ConfigToCheck structure
struct ConfigToCheck
{
uint16_t m_dlBandwidth;
uint16_t m_ulBandwidth;
uint32_t m_dlEarfcn;
uint32_t m_ulEarfcn;
uint16_t m_dlBandwidth; ///< Downlink bandwidth
uint16_t m_ulBandwidth; ///< Uplink bandwidth
uint32_t m_dlEarfcn; ///< Downlink EARFCN
uint32_t m_ulEarfcn; ///< Uplink EARFCN
};
NS_LOG_COMPONENT_DEFINE ("TestCarrierAggregationConfig");
/**
* \ingroup lte-test
* \ingroup tests
*
* \brief Carrier aggregation configuration test case.
*/
class CarrierAggregationConfigTestCase : public TestCase
{
public:
/**
* Constructor
*
* \param numberOfNodes, Total Number of eNBs and UEs
* \param configToCheck, Vector containing all the configurations to check
* \param simulationDuration, Duration of the simulation
* \param numberOfNodes Total Number of eNBs and UEs
* \param numberOfComponentCarriers Total number of component carriers
* \param configToCheck Vector containing all the configurations to check
* \param simulationDuration Duration of the simulation
*/
CarrierAggregationConfigTestCase (uint32_t numberOfNodes, uint16_t numberOfComponentCarriers, std::vector<ConfigToCheck> configToCheck, Time simulationDuration)
: TestCase (BuildNameString (numberOfNodes, numberOfComponentCarriers, configToCheck, simulationDuration)),
@@ -94,16 +102,37 @@ public:
private:
virtual void DoRun (void);
/**
* Build name string function
*
* \param numberOfNodes Total Number of eNBs and UEs
* \param numberOfComponentCarriers Total number of component carriers
* \param configToCheck Vector containing all the configurations to check
* \param simulationDuration Duration of the simulation
* \returns the name string
*/
std::string BuildNameString (uint32_t numberOfNodes, uint16_t numberOfComponentCarriers, std::vector<ConfigToCheck> configToCheck, Time simulationDuration);
/**
* Evaluate function
*
* \param context The context
* \param ueRrc Pointer to the UE RRC
* \param sCellToAddModList List of the configuration parameters for secondary cell
*/
void Evaluate (std::string context, Ptr<LteUeRrc> ueRrc, std::list<LteRrcSap::SCellToAddMod> sCellToAddModList);
/**
* Equally spaced component carriers function
*
* \return Vector of maps containing the per component carrier configuration
*/
std::vector<std::map<uint16_t, ConfigToCheck> > EquallySpacedCcs ();
uint32_t m_numberOfNodes;
uint16_t m_numberOfComponentCarriers;
std::vector<ConfigToCheck> m_configToCheck;
uint32_t m_connectionCounter;
Time m_simulationDuration;
std::vector<std::map<uint16_t, ConfigToCheck> > m_configToCheckContainer;
uint32_t m_numberOfNodes; ///< Numer of nodes
uint16_t m_numberOfComponentCarriers; ///< Number of component carriers
std::vector<ConfigToCheck> m_configToCheck; ///< Vector containing all the configurations to check
uint32_t m_connectionCounter; ///< Connection counter
Time m_simulationDuration; ///< Simulation duration
std::vector<std::map<uint16_t, ConfigToCheck> > m_configToCheckContainer; ///< Vector of maps containing the per component carrier configuration
};
std::string
@@ -319,7 +348,12 @@ CarrierAggregationConfigTestCase::DoRun ()
Simulator::Destroy ();
}
/**
* \ingroup lte-test
* \ingroup tests
*
* \brief Carrier aggregation configuration test suite.
*/
class CarrierAggregationConfigTestSuite : public TestSuite
{
public:

2
src/lte/test/lte-test-cqi-generation.h
View File

@@ -54,7 +54,7 @@ class LteCqiGenerationTestCase : public TestCase
{
public:
/**
* \Constructor
* Constructor
*
* \param name reference name
* \param usePdcchForCqiGeneration use PDCCH for CQI generation

22
src/lte/test/lte-test-ipv6-routing.cc
View File

@@ -51,6 +51,12 @@
using namespace ns3;
/**
* \ingroup lte-test
* \ingroup tests
*
* \brief Lte Ipv6 routing test case.
*/
class LteIpv6RoutingTestCase : public TestCase
{
public:
@@ -64,29 +70,29 @@ public:
/**
* \brief sent Packets from client's IPv6 interface.
* \param: p packet
* \param: ipv6 Ipv6 object
* \param: interface Ipv6interface from which the packet is transmitted
* \param p packet
* \param ipv6 Ipv6 object
* \param interface Ipv6interface from which the packet is transmitted
*/
void SentAtClient (Ptr<const Packet> p, Ptr<Ipv6> ipv6, uint32_t interface);
/**
* \brief Received Packets at client's IPv6 interface.
* \param: p packet
* \param: ipv6 Ipv6 object
* \param: interface Ipv6interface at which the packet is received
* \param p packet
* \param ipv6 Ipv6 object
* \param interface Ipv6interface at which the packet is received
*/
void ReceivedAtClient (Ptr<const Packet> p, Ptr<Ipv6> ipv6, uint32_t interface);
/**
* \brief Received Packet at pgw from enb.
* \param: p packet
* \param p packet
*/
void EnbToPgw (Ptr<Packet> p);
/**
* \brief Received Packet at pgw from enb.
* \param: p packet
* \param p packet
*/
void TunToPgw (Ptr<Packet> p);

3
src/lte/test/test-lte-handover-delay.cc
View File

@@ -63,6 +63,7 @@ public:
/**
* Constructor
*
*\param numberOfComponentCarriers number of component carriers
* \param useIdealRrc if true, use the ideal RRC
* \param handoverTime the time of handover
* \param delayThreshold the delay threshold
@@ -122,7 +123,7 @@ private:
void EnbHandoverEndOkCallback (std::string context, uint64_t imsi,
uint16_t cellid, uint16_t rnti);
uint8_t m_numberOfComponentCarriers;
uint8_t m_numberOfComponentCarriers; ///< Number of component carriers
bool m_useIdealRrc; ///< use ideal RRC?
Time m_handoverTime; ///< handover time
Time m_delayThreshold; ///< the delay threshold