diff options
Diffstat (limited to 'monitor/fan.hpp')
| -rw-r--r-- | monitor/fan.hpp | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/monitor/fan.hpp b/monitor/fan.hpp index f22bd9f..d765650 100644 --- a/monitor/fan.hpp +++ b/monitor/fan.hpp @@ -134,15 +134,28 @@ class Fan return _name; } + /** + * @brief Finds the target speed of this fan + * + * Finds the target speed from the list of sensors that make up this + * fan. At least one sensor should contain a target speed value. + * + * @return - The target speed found from the list of sensors on the fan + */ + uint64_t findTargetSpeed(); + private: /** - * @brief Returns the target speed of the sensor + * @brief Returns the target speed of the fan + * + * Retrieves the target speed using the given sensor which may or may + * not contain a target speed value. The sensor determines what its + * target speed is. * - * If the sensor itself doesn't have a target, it finds - * the target speed from another sensor. + * @param[in] sensor - The sensor to use in getting the target speed * - * @param[in] sensor - the sensor to get the target speed for + * @return - The target speed of the fan */ uint64_t getTargetSpeed(const TachSensor& sensor); |
