[1323] downlinkHandling.h: more verbose comments for variable explanation

Author: dhutererprats

src/simulation/communication/downlinkHandling/downlinkHandling.h

@@ -49,16 +49,27 @@ class DownlinkHandling : public DataNodeBase {
 
     BSKLogger bskLogger;                                           //!< BSK logging interface
 
+    /*! @brief Return 1 if link-quality inputs were valid on the last update, else 0 */
     uint32_t getCurrentLinkActive() const {return this->downlinkOutBuffer.linkActive;}
+    /*! @brief Return selected receiver index on the last update (0=no receiver, 1/2=receiver path) */
     uint32_t getCurrentReceiverIndex() const {return this->downlinkOutBuffer.receiverIndex;}
+    /*! @brief Return last module time step [s] */
     double getCurrentTimeStep() const {return this->downlinkOutBuffer.timeStep;}
+    /*! @brief Return last computed bit-error-rate (BER) [-] */
     double getCurrentBer() const {return this->downlinkOutBuffer.ber;}
+    /*! @brief Return last computed packet-error-rate (PER) [-] */
     double getCurrentPer() const {return this->downlinkOutBuffer.per;}
+    /*! @brief Return last packet drop probability within retry cap [-] */
     double getCurrentPacketDropProb() const {return this->downlinkOutBuffer.packetDropProb;}
+    /*! @brief Return last expected attempts per packet under retry cap [-] */
     double getCurrentExpectedAttemptsPerPacket() const {return this->downlinkOutBuffer.expectedAttemptsPerPacket;}
+    /*! @brief Return last data-removal rate from storage [bit/s] */
     double getCurrentStorageRemovalRate() const {return this->downlinkOutBuffer.storageRemovalRate;}
+    /*! @brief Return last successfully delivered data rate [bit/s] */
     double getCurrentDeliveredDataRate() const {return this->downlinkOutBuffer.deliveredDataRate;}
+    /*! @brief Return last dropped data rate after retries [bit/s] */
     double getCurrentDroppedDataRate() const {return this->downlinkOutBuffer.droppedDataRate;}
+    /*! @brief Return estimated remaining bits in selected data partition [bit] */
     double getCurrentEstimatedRemainingDataBits() const {return this->downlinkOutBuffer.estimatedRemainingDataBits;}
 
 private: