control/json/fan.hpp

25 namespace phosphor::fan::control::json  namespace
31  * @class Fan - Represents a configured fan control fan object
33  * A fan object contains the configured attributes for a fan within the system
34  * that will be controlled by the fan control application. These configuration
36  * fan is included, what sensors make up the fan, the target interface to be
37  * used in setting a target, and any profiles(OPTIONAL) the fan should be
40  * (When no profile for a fan is given, the fan defaults to always be included)
43 class Fan : public ConfigBase  class
51     Fan() = delete;
52     Fan(const Fan&) = delete;
53     Fan(Fan&&) = delete;
54     Fan& operator=(const Fan&) = delete;
55     Fan& operator=(Fan&&) = delete;
56     ~Fan() = default;
60      * Parses and populates a zone fan from JSON object data
64     explicit Fan(const json& jsonObj);
69      * @return Zone this fan belongs in
97      * @brief Get the current fan target
99      * @return - The current target of the fan
114      * @brief Returns the fan's locked targets.
134      * Removes the provided target lock from the list of locks. Fan will unlock
145      * to use in controlling the fan's target
149     /* Target for this fan */
152     /* list of locked targets active on this fan */
157      * dbus to the service providing them that make up the fan
161     /* The zone this fan belongs to */
165      * @brief Parse and set the fan's sensor interface
167      * @param[in] jsonObj - JSON object for the fan
174      * @brief Parse and set the fan's sensor list
176      * @param[in] jsonObj - JSON object for the fan
179      * that make up this fan.
184      * @brief Parse and set the fan's zone
186      * @param[in] jsonObj - JSON object for the fan
188      * Sets the zone this fan is included in.
193 } // namespace phosphor::fan::control::json