updated doxygen of Get/SetDownlinkSubChannels to reflect actual usage
authorNicola Baldo <nbaldo@cttc.es>
Mon, 23 Jul 2012 19:06:32 +0200
changeset 9049 9079248e111b
parent 9048 4aeb9111981b
child 9050 631edd1e6e84
updated doxygen of Get/SetDownlinkSubChannels to reflect actual usage
src/lte/model/lte-enb-phy.h
--- a/src/lte/model/lte-enb-phy.h	Mon Jul 23 18:57:37 2012 +0200
+++ b/src/lte/model/lte-enb-phy.h	Mon Jul 23 19:06:32 2012 +0200
@@ -121,18 +121,20 @@
   /**
    * \brief set the resource blocks (a.k.a. sub channels) to be used in the downlink for transmission
    * 
-   * \param mask a bitmask implemented as a vector. If the i-th value
-   * of mask is equal to 1 (0) it means that the i-th resource block
-   * is used (not used) for transmission in the downlink.
+   * \param mask a vector of integers, if the i-th value is j it means
+   * that the j-th resource block is used for transmission in the
+   * downlink. If there is no i such that the value of the i-th
+   * element is j, it means that RB j is not used.
    */
   void SetDownlinkSubChannels (std::vector<int> mask );
 
 
   /**
    * 
-   * \return a bitmask implemented as a vector. If the i-th value
-   * of mask is equal to 1 (0) it means that the i-th resource block
-   * is used (not used) for transmission in the downlink.
+   * \return  a vector of integers, if the i-th value is j it means
+   * that the j-th resource block is used for transmission in the
+   * downlink. If there is no i such that the value of the i-th
+   * element is j, it means that RB j is not used.
    */
   std::vector<int> GetDownlinkSubChannels (void);