Index: src/lte/test/lte-test-pf-ff-mac-scheduler.h |
=================================================================== |
--- a/src/lte/test/lte-test-pf-ff-mac-scheduler.h |
+++ b/src/lte/test/lte-test-pf-ff-mac-scheduler.h |
@@ -30,49 +30,93 @@ |
/** |
-* This system test program creates different test cases with a single eNB and |
-* several UEs, all having the same Radio Bearer specification. In each test |
-* case, the UEs see the same SINR from the eNB; different test cases are |
-* implemented obtained by using different SINR values and different numbers of |
-* UEs. The test consists on checking that the obtained throughput performance |
-* is equal among users is consistent with the definition of proportional |
-* fair scheduling |
-*/ |
+ * \ingroup lte-test |
+ * \ingroup tests |
+ * |
+ * \brief This system test program creates different test cases with a single eNB and |
+ * several UEs, all having the same Radio Bearer specification. In each test |
+ * case, the UEs see the same SINR from the eNB; different test cases are |
+ * implemented obtained by using different SINR values and different numbers of |
+ * UEs. The test consists on checking that the obtained throughput performance |
+ * is equal among users is consistent with the definition of proportional |
+ * fair scheduling |
+ */ |
class LenaPfFfMacSchedulerTestCase1 : public TestCase |
{ |
public: |
+ /** |
+ * Constructor |
+ * |
+ * \param nUser the number of UE nodes |
+ * \param dist the distance between nodes |
+ * \param thrRefDl the DL throughput reference |
+ * \param thrRefUl the UL throughput reference |
+ * \param errorModelEnabled if true the error model is enabled |
+ */ |
LenaPfFfMacSchedulerTestCase1 (uint16_t nUser, double dist, double thrRefDl, double thrRefUl, bool errorModelEnabled); |
virtual ~LenaPfFfMacSchedulerTestCase1 (); |
private: |
+ /** |
+ * Build name string |
+ * \param nUser the number of UE nodes |
+ * \param dist the distnace between nodes |
+ * \returns the name string |
+ */ |
static std::string BuildNameString (uint16_t nUser, double dist); |
virtual void DoRun (void); |
- uint16_t m_nUser; |
- double m_dist; |
- double m_thrRefDl; |
- double m_thrRefUl; |
- bool m_errorModelEnabled; |
+ uint16_t m_nUser; ///< number of UE nodes |
+ double m_dist; ///< the distance between nodes |
+ double m_thrRefDl; ///< the DL throughput reference |
+ double m_thrRefUl; ///< the UL throughput reference |
+ bool m_errorModelEnabled; ///< is error model enabled? |
}; |
+/** |
+ * \ingroup lte-test |
+ * \ingroup tests |
+ * |
+ * \brief Lena PfFf Mac Scheduler Test Case 2 |
+ */ |
class LenaPfFfMacSchedulerTestCase2 : public TestCase |
{ |
public: |
+ /** |
+ * Constructor |
+ * |
+ * \param dist the distance between nodes |
+ * \param estThrPfDl the estimated DL throughput PF |
+ * \param estThrPfUl the estimated UL throughput PF |
+ * \param errorModelEnabled if true the error model is enabled |
+ */ |
LenaPfFfMacSchedulerTestCase2 (std::vector<double> dist, std::vector<uint32_t> estThrPfDl, std::vector<uint32_t> estThrPfUl, bool errorModelEnabled); |
virtual ~LenaPfFfMacSchedulerTestCase2 (); |
private: |
+ /** |
+ * Build name string |
+ * \param nUser the number of UE nodes |
+ * \param dist the distnace between nodes |
+ * \returns the name string |
+ */ |
static std::string BuildNameString (uint16_t nUser, std::vector<double> dist); |
virtual void DoRun (void); |
- uint16_t m_nUser; |
- std::vector<double> m_dist; |
- std::vector<uint32_t> m_estThrPfDl; |
- std::vector<uint32_t> m_estThrPfUl; |
- bool m_errorModelEnabled; |
+ uint16_t m_nUser; ///< number of UE nodes |
+ std::vector<double> m_dist; ///< the distance between nodes |
+ std::vector<uint32_t> m_estThrPfDl; ///< the estimated DL throughput PF |
+ std::vector<uint32_t> m_estThrPfUl; ///< the estimated UL throughput PF |
+ bool m_errorModelEnabled; ///< is error model enabled? |
}; |
+/** |
+ * \ingroup lte-test |
+ * \ingroup tests |
+ * |
+ * \brief Lena PfFf Mac Scheduler Test Suite |
+ */ |
class LenaTestPfFfMacSchedulerSuite : public TestSuite |
{ |