Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(575)

Unified Diff: src/lte/test/lte-ffr-simple.h

Issue 315450043: LTE module corrections for doxygen warnings (Closed)
Patch Set: Created 7 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/lte/test/epc-test-s1u-uplink.cc ('k') | src/lte/test/lte-ffr-simple.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/lte/test/lte-ffr-simple.h
===================================================================
--- a/src/lte/test/lte-ffr-simple.h
+++ b/src/lte/test/lte-ffr-simple.h
@@ -34,6 +34,9 @@
/**
+ * \ingroup lte-test
+ * \ingroup tests
+ *
* \brief Simple Frequency Reuse algorithm implementation which uses only 1 sub-band.
* Used to test Downlink Power Allocation. When Simple FR receives UE measurements
* it immediately call functions to change PdschConfigDedicated (i.e. P_A) value for
@@ -49,12 +52,29 @@
virtual ~LteFfrSimple ();
- // inherited from Object
+ /**
+ * \brief Get the type ID.
+ * \return the object TypeId
+ */
static TypeId GetTypeId ();
+ /**
+ * \brief Change PDSCH config dedicated function
+ * \param change trace fired upon change of PdschConfigDedicated if true
+ */
void ChangePdschConfigDedicated (bool change);
+ /**
+ * \brief Set PDSCH config dedicated function
+ * \param pdschConfigDedicated LteRrcSap::PdschConfigDedicated object
+ */
void SetPdschConfigDedicated (LteRrcSap::PdschConfigDedicated pdschConfigDedicated);
+ /**
+ * \brief Set TPC function
+ * \param tpc TPC
+ * \param num number of TPC
+ * \param acculumatedMode accumulated mode
+ */
void SetTpc (uint32_t tpc, uint32_t num, bool acculumatedMode);
// inherited from LteFfrAlgorithm
@@ -100,41 +120,42 @@
private:
+ /// Update PDSCH config dedicated function
void UpdatePdschConfigDedicated ();
// FFR SAP
- LteFfrSapUser* m_ffrSapUser;
- LteFfrSapProvider* m_ffrSapProvider;
+ LteFfrSapUser* m_ffrSapUser; ///< FFR SAP user
+ LteFfrSapProvider* m_ffrSapProvider; ///< FFR SAP provider
// FFR RRF SAP
- LteFfrRrcSapUser* m_ffrRrcSapUser;
- LteFfrRrcSapProvider* m_ffrRrcSapProvider;
+ LteFfrRrcSapUser* m_ffrRrcSapUser; ///< FFR RRC SAP user
+ LteFfrRrcSapProvider* m_ffrRrcSapProvider; ///< FFR RRC SAP provider
- uint8_t m_dlOffset;
- uint8_t m_dlSubBand;
+ uint8_t m_dlOffset; ///< DL offset
+ uint8_t m_dlSubBand; ///< DL subband
- uint8_t m_ulOffset;
- uint8_t m_ulSubBand;
+ uint8_t m_ulOffset; ///< UL offset
+ uint8_t m_ulSubBand; ///< UL subband
- std::vector <bool> m_dlRbgMap;
- std::vector <bool> m_ulRbgMap;
+ std::vector <bool> m_dlRbgMap; ///< DL RBG map
+ std::vector <bool> m_ulRbgMap; ///< UL RBG map
- std::map <uint16_t, LteRrcSap::PdschConfigDedicated> m_ues;
+ std::map <uint16_t, LteRrcSap::PdschConfigDedicated> m_ues; ///< UEs
// The expected measurement identity
- uint8_t m_measId;
+ uint8_t m_measId; ///< measure ID
- bool m_changePdschConfigDedicated;
+ bool m_changePdschConfigDedicated; ///< PDSCH config dedicate changed?
- LteRrcSap::PdschConfigDedicated m_pdschConfigDedicated;
+ LteRrcSap::PdschConfigDedicated m_pdschConfigDedicated; ///< PDSCH config dedicated
- TracedCallback<uint16_t, uint8_t> m_changePdschConfigDedicatedTrace;
+ TracedCallback<uint16_t, uint8_t> m_changePdschConfigDedicatedTrace; ///< PDSCH config dedicated change trace callback
- //Uplink Power Control
- uint32_t m_tpc;
- uint32_t m_tpcNum;
- bool m_acculumatedMode;
+ // Uplink Power Control
+ uint32_t m_tpc; ///< TPC
+ uint32_t m_tpcNum; ///< number of TPC
+ bool m_accumulatedMode; ///< use accumulated mode?
}; // end of class LteFfrSimple
« no previous file with comments | « src/lte/test/epc-test-s1u-uplink.cc ('k') | src/lte/test/lte-ffr-simple.cc » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b