documented units for TX and noise PSD
authorNicola Baldo <nbaldo@cttc.es>
Tue, 10 May 2011 17:01:21 +0200
changeset 8036 52262ea6db24
parent 8034 6ea379d8e564
child 8037 1fa671f4c423
documented units for TX and noise PSD
src/lte/model/lte-phy.h
src/lte/model/lte-spectrum-value-helper.h
--- a/src/lte/model/lte-phy.h	Tue May 10 13:05:06 2011 +0200
+++ b/src/lte/model/lte-phy.h	Tue May 10 17:01:21 2011 +0200
@@ -131,7 +131,7 @@
 
   /**
    * \brief Compute the TX Power Spectral Density
-   * \return a Ptr to a created SpectrumValue
+   * \return a pointer to a newly allocated SpectrumValue representing the TX Power Spectral Density in W/Hz for each Resource Block
    */
   virtual Ptr<SpectrumValue> CreateTxPowerSpectralDensity () = 0;
 
--- a/src/lte/model/lte-spectrum-value-helper.h	Tue May 10 13:05:06 2011 +0200
+++ b/src/lte/model/lte-spectrum-value-helper.h	Tue May 10 17:01:21 2011 +0200
@@ -105,7 +105,7 @@
    * \param txPower the total power in dBm over the whole bandwidth
    * \param ActiveRbs the list of Active Resource Blocks (PRBs) 
    *
-   * \return a Ptr to a newly created SpectrumValue instance
+   * \return a newly allocated SpectrumValue representing the TX Power Spectral Density in W/Hz for each Resource Block
    */
   static Ptr<SpectrumValue> CreateTxPowerSpectralDensity (uint16_t earfcn, uint8_t bandwdith, double powerTx, std::vector <int> activeRbs);
 
@@ -119,7 +119,7 @@
    * number of resource blocks
    * \param noiseFigure the noise figure in dB w.r.t. a reference temperature of 290K
    * 
-   * \return a Ptr to a newly created SpectrumValue instance
+   * \return a pointer to a newly allocated SpectrumValue representing the TX Power Spectral Density in W/Hz for each Resource Block
    */
   static Ptr<SpectrumValue> CreateNoisePowerSpectralDensity (uint16_t earfcn, uint8_t bandwdith, double noiseFigure);
 
@@ -129,7 +129,7 @@
    * \param noiseFigure  the noise figure in dB  w.r.t. a reference temperature of 290K
    * \param spectrumModel the SpectrumModel instance to be used
    * 
-   * \return a Ptr to a newly created SpectrumValue instance
+   * \return a newly allocated SpectrumValue representing the TX Power Spectral Density in W/Hz for each Resource Block
    */
   static Ptr<SpectrumValue> CreateNoisePowerSpectralDensity (double noiseFigure, Ptr<SpectrumModel> spectrumModel);