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

various doxygen updates

Browse Source
This commit is contained in:
Tom Henderson
2020-03-04 13:43:20 -08:00
parent b278e6be20
commit 2fde925da7
14 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/buildings/model/mobility-building-info.h
View File

@@ -76,9 +76,9 @@ public:
*
* \return true if the MobilityBuildingInfo instance is outdoor, false otherwise
*
* \deprecated This method will go away in future release of ns-3.
* Calling \c IsInside () method of \c MobilityBuildingInfo class
* will suffice the need to determine if a node is inside or outside
* \deprecated This method will go away in a future release of ns-3.
* Calling \c IsIndoor () method of \c MobilityBuildingInfo class
* will satisfy the need to determine if a node is inside or outside
* a building.
*/
NS_DEPRECATED

2
src/lte/test/lte-test-carrier-aggregation.cc
View File

@@ -370,7 +370,7 @@ CarrierAggregationTestCase::DoRun (void)
Simulator::Run ();
/**
* Check that the assignation is done in a RR fashion
* Check that the assignment is done in a RR fashion
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;

2
src/lte/test/lte-test-cqa-ff-mac-scheduler.cc
View File

@@ -456,7 +456,7 @@ LenaCqaFfMacSchedulerTestCase1::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "round robin" manner
* Check that the uplink assignment is done in a "round robin" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);

12
src/lte/test/lte-test-fdbet-ff-mac-scheduler.cc
View File

@@ -283,7 +283,7 @@ LenaFdBetFfMacSchedulerTestCase1::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "FD blind equal throughput" manner
* Check that the downlink assignment is done in a "FD blind equal throughput" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;
@@ -297,7 +297,7 @@ LenaFdBetFfMacSchedulerTestCase1::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)dlDataRxed.at (i) << " thr " << (double)dlDataRxed.at (i) / statsDuration << " ref " << m_thrRefDl);
}
/**
* Check that the assignation is done in a "FD blind equal throughput" manner among users
* Check that the assignment is done in a "FD blind equal throughput" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI
@@ -308,7 +308,7 @@ LenaFdBetFfMacSchedulerTestCase1::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "FD blind equal throughput" manner
* Check that the uplink assignment is done in a "FD blind equal throughput" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> ulDataRxed;
@@ -322,7 +322,7 @@ LenaFdBetFfMacSchedulerTestCase1::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)ulDataRxed.at (i) << " thr " << (double)ulDataRxed.at (i) / statsDuration << " ref " << m_thrRefUl);
}
/**
* Check that the assignation is done in a "FD blind equal throughput" manner among users
* Check that the assignment is done in a "FD blind equal throughput" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI
@@ -472,7 +472,7 @@ LenaFdBetFfMacSchedulerTestCase2::DoRun (void)
estTotalThr = m_nUser * (1 / estTotalThr);
estUeThr = estTotalThr / m_nUser;
/**
* Check that the assignation is done in a "FD blind equal throughput" manner among users
* Check that the assignment is done in a "FD blind equal throughput" manner among users
* with different SINRs: the bandwidth should be distributed equally in long term
*/
for (int i = 0; i < m_nUser; i++)
@@ -486,7 +486,7 @@ LenaFdBetFfMacSchedulerTestCase2::DoRun (void)
}
/**
* Check that the assignation in uplink is done in a round robin manner.
* Check that the assignment in uplink is done in a round robin manner.
*/
NS_LOG_INFO ("UL - Test with " << m_nUser);

8
src/lte/test/lte-test-fdmt-ff-mac-scheduler.cc
View File

@@ -266,7 +266,7 @@ LenaFdMtFfMacSchedulerTestCase::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "frequency domain maximum throughput" manner
* Check that the downlink assignment is done in a "frequency domain maximum throughput" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;
@@ -280,7 +280,7 @@ LenaFdMtFfMacSchedulerTestCase::DoRun (void)
}
/**
* Check that the assignation is done in a "frequency domain maximum throughput" manner among users
* Check that the assignment is done in a "frequency domain maximum throughput" manner among users
* with maximum SINRs: without fading, current FD MT always assign all resources to one UE
*/
@@ -302,7 +302,7 @@ LenaFdMtFfMacSchedulerTestCase::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "proportional fair" manner
* Check that the uplink assignment is done in a "proportional fair" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> ulDataRxed;
@@ -316,7 +316,7 @@ LenaFdMtFfMacSchedulerTestCase::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)ulDataRxed.at (i) << " thr " << (double)ulDataRxed.at (i) / statsDuration << " ref " << m_thrRefUl);
}
/**
* Check that the assignation is done in a "proportional fair" manner among users
* Check that the assignment is done in a "proportional fair" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI

6
src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.cc
View File

@@ -434,7 +434,7 @@ LenaFdTbfqFfMacSchedulerTestCase1::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "token bank fair queue" manner
* Check that the downlink assignment is done in a "token bank fair queue" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
@@ -456,7 +456,7 @@ LenaFdTbfqFfMacSchedulerTestCase1::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "round robin" manner
* Check that the uplink assignment is done in a "round robin" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
@@ -687,7 +687,7 @@ LenaFdTbfqFfMacSchedulerTestCase2::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "token bank fair queue" manner
* Check that the downlink assignment is done in a "token bank fair queue" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s)");

2
src/lte/test/lte-test-harq.cc
View File

@@ -246,7 +246,7 @@ LenaHarqTestCase::DoRun (void)
Simulator::Run ();
/**
* Check that the assignation is done in a RR fashion
* Check that the assignment is done in a RR fashion
*/
NS_LOG_INFO ("\tTest on downlink data shared channels (PDSCH)");
NS_LOG_INFO ("Test with " << m_nUser << " user(s) at distance " << m_dist << " expected Thr " << m_throughputRef);

12
src/lte/test/lte-test-pf-ff-mac-scheduler.cc
View File

@@ -305,7 +305,7 @@ LenaPfFfMacSchedulerTestCase1::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "proportional fair" manner
* Check that the downlink assignment is done in a "proportional fair" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;
@@ -318,7 +318,7 @@ LenaPfFfMacSchedulerTestCase1::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)dlDataRxed.at (i) << " thr " << (double)dlDataRxed.at (i) / statsDuration << " ref " << m_thrRefDl);
}
/**
* Check that the assignation is done in a "proportional fair" manner among users
* Check that the assignment is done in a "proportional fair" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI
@@ -329,7 +329,7 @@ LenaPfFfMacSchedulerTestCase1::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "proportional fair" manner
* Check that the uplink assignment is done in a "proportional fair" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> ulDataRxed;
@@ -343,7 +343,7 @@ LenaPfFfMacSchedulerTestCase1::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)ulDataRxed.at (i) << " thr " << (double)ulDataRxed.at (i) / statsDuration << " ref " << m_thrRefUl);
}
/**
* Check that the assignation is done in a "proportional fair" manner among users
* Check that the assignment is done in a "proportional fair" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI
@@ -487,7 +487,7 @@ LenaPfFfMacSchedulerTestCase2::DoRun (void)
}
/**
* Check that the assignation is done in a "proportional fair" manner among users
* Check that the assignment is done in a "proportional fair" manner among users
* with different SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user.
*/
@@ -500,7 +500,7 @@ LenaPfFfMacSchedulerTestCase2::DoRun (void)
}
/**
* Check that the assignation in uplink is done in a round robin manner.
* Check that the assignment in uplink is done in a round robin manner.
*/
NS_LOG_INFO ("UL - Test with " << m_nUser);

6
src/lte/test/lte-test-pss-ff-mac-scheduler.cc
View File

@@ -434,7 +434,7 @@ LenaPssFfMacSchedulerTestCase1::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "token bank fair queue" manner
* Check that the downlink assignment is done in a "token bank fair queue" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
@@ -456,7 +456,7 @@ LenaPssFfMacSchedulerTestCase1::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "round robin" manner
* Check that the uplink assignment is done in a "round robin" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
@@ -680,7 +680,7 @@ LenaPssFfMacSchedulerTestCase2::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "token bank fair queue" manner
* Check that the downlink assignment is done in a "token bank fair queue" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s)");

2
src/lte/test/lte-test-rr-ff-mac-scheduler.cc
View File

@@ -266,7 +266,7 @@ LenaRrFfMacSchedulerTestCase::DoRun (void)
Simulator::Run ();
/**
* Check that the assignation is done in a RR fashion
* Check that the assignment is done in a RR fashion
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;

12
src/lte/test/lte-test-tdbet-ff-mac-scheduler.cc
View File

@@ -288,7 +288,7 @@ LenaTdBetFfMacSchedulerTestCase1::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "TD blind equal throughput" manner
* Check that the downlink assignment is done in a "TD blind equal throughput" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;
@@ -302,7 +302,7 @@ LenaTdBetFfMacSchedulerTestCase1::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)dlDataRxed.at (i) << " thr " << (double)dlDataRxed.at (i) / statsDuration << " ref " << m_thrRefDl);
}
/**
* Check that the assignation is done in a "TD blind equal throughput" manner among users
* Check that the assignment is done in a "TD blind equal throughput" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI
@@ -313,7 +313,7 @@ LenaTdBetFfMacSchedulerTestCase1::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "TD blind equal throughput" manner
* Check that the uplink assignment is done in a "TD blind equal throughput" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> ulDataRxed;
@@ -327,7 +327,7 @@ LenaTdBetFfMacSchedulerTestCase1::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)ulDataRxed.at (i) << " thr " << (double)ulDataRxed.at (i) / statsDuration << " ref " << m_thrRefUl);
}
/**
* Check that the assignation is done in a "TD blind equal throughput" manner among users
* Check that the assignment is done in a "TD blind equal throughput" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI
@@ -477,7 +477,7 @@ LenaTdBetFfMacSchedulerTestCase2::DoRun (void)
estTotalThr = m_nUser * (1 / estTotalThr);
estUeThr = estTotalThr / m_nUser;
/**
* Check that the assignation is done in a "TD blind equal throughput" manner among users
* Check that the assignment is done in a "TD blind equal throughput" manner among users
* with different SINRs: the bandwidth should be distributed equally in long term
*/
for (int i = 0; i < m_nUser; i++)
@@ -491,7 +491,7 @@ LenaTdBetFfMacSchedulerTestCase2::DoRun (void)
}
/**
* Check that the assignation in uplink is done in a round robin manner.
* Check that the assignment in uplink is done in a round robin manner.
*/
NS_LOG_INFO ("UL - Test with " << m_nUser);

8
src/lte/test/lte-test-tdmt-ff-mac-scheduler.cc
View File

@@ -268,7 +268,7 @@ LenaTdMtFfMacSchedulerTestCase::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "time domain maximum throughput" manner
* Check that the downlink assignment is done in a "time domain maximum throughput" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;
@@ -282,7 +282,7 @@ LenaTdMtFfMacSchedulerTestCase::DoRun (void)
}
/**
* Check that the assignation is done in a "time domain maximum throughput" manner among users
* Check that the assignment is done in a "time domain maximum throughput" manner among users
* with maximum SINRs: without fading, current FD MT always assign all resources to one UE
*/
@@ -304,7 +304,7 @@ LenaTdMtFfMacSchedulerTestCase::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "proportional fair" manner
* Check that the uplink assignment is done in a "proportional fair" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> ulDataRxed;
@@ -318,7 +318,7 @@ LenaTdMtFfMacSchedulerTestCase::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)ulDataRxed.at (i) << " thr " << (double)ulDataRxed.at (i) / statsDuration << " ref " << m_thrRefUl);
}
/**
* Check that the assignation is done in a "proportional fair" manner among users
* Check that the assignment is done in a "proportional fair" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI

6
src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.cc
View File

@@ -433,7 +433,7 @@ LenaTdTbfqFfMacSchedulerTestCase1::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "token bank fair queue" manner
* Check that the downlink assignment is done in a "token bank fair queue" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
@@ -455,7 +455,7 @@ LenaTdTbfqFfMacSchedulerTestCase1::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "round robin" manner
* Check that the uplink assignment is done in a "round robin" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
@@ -685,7 +685,7 @@ LenaTdTbfqFfMacSchedulerTestCase2::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "token bank fair queue" manner
* Check that the downlink assignment is done in a "token bank fair queue" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s)");

8
src/lte/test/lte-test-tta-ff-mac-scheduler.cc
View File

@@ -271,7 +271,7 @@ LenaTtaFfMacSchedulerTestCase::DoRun (void)
Simulator::Run ();
/**
* Check that the downlink assignation is done in a "Throughput to Average" manner
* Check that the downlink assignment is done in a "Throughput to Average" manner
*/
NS_LOG_INFO ("DL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> dlDataRxed;
@@ -285,7 +285,7 @@ LenaTtaFfMacSchedulerTestCase::DoRun (void)
}
/**
* Check that the assignation is done in a "Throughput to Average" manner among users
* Check that the assignment is done in a "Throughput to Average" manner among users
* with maximum SINRs: without fading, current FD MT always assign all resources to one UE
*/
@@ -307,7 +307,7 @@ LenaTtaFfMacSchedulerTestCase::DoRun (void)
}
/**
* Check that the uplink assignation is done in a "proportional fair" manner
* Check that the uplink assignment is done in a "proportional fair" manner
*/
NS_LOG_INFO ("UL - Test with " << m_nUser << " user(s) at distance " << m_dist);
std::vector <uint64_t> ulDataRxed;
@@ -321,7 +321,7 @@ LenaTtaFfMacSchedulerTestCase::DoRun (void)
NS_LOG_INFO ("\tUser " << i << " imsi " << imsi << " bytes rxed " << (double)ulDataRxed.at (i) << " thr " << (double)ulDataRxed.at (i) / statsDuration << " ref " << m_thrRefUl);
}
/**
* Check that the assignation is done in a "proportional fair" manner among users
* Check that the assignment is done in a "proportional fair" manner among users
* with equal SINRs: the bandwidth should be distributed according to the
* ratio of the estimated throughput per TTI of each user; therefore equally
* partitioning the whole bandwidth achievable from a single users in a TTI