control/json/event.hpp

8  *     http://www.apache.org/licenses/LICENSE-2.0
13  * See the License for the specific language governing permissions and
36  * @class Event - Represents a configured fan control event
39  * also optional. An event object can be used to enable a specific change to
49 class Event : public ConfigBase  class
55     Event() = delete;
56     Event(const Event&) = delete;
57     Event(Event&&) = delete;
58     Event& operator=(const Event&) = delete;
59     Event& operator=(Event&&) = delete;
60     ~Event() = default;
64      * Parses and populates a configuration event from JSON object data
66      * @param[in] jsonObj - JSON object
67      * @param[in] mgr - Manager of this event
68      * @param[in] zones - Reference to the configured zones
70     Event(const json& jsonObj, Manager* mgr,
74      * @brief Enable the event
76      * Performs the necessary tasks to enable the event such as enabling all the
77      * event triggers, etc...
102      * @param[in] groups - All groups available for events
113      * @param[in] loadGroups - Whether to load the groups or not
124      * @param[in] group - Group object to get configured
125      * @param[in] jsonObj - JSON object for the group
132      * @brief Parse and set the event's groups(OPTIONAL)
134      * @param[in] jsonObj - JSON object for the event
135      * @param[in] profiles - List of profiles to validate groups against
136      * @param[out] groups - List of groups to be configured
138      * Sets the list of groups associated with the event
147      * @return json - A JSON object of groups and actions
152     /* The event's manager */
155     /* List of groups associated with the event */
161     /* List of actions for this event */
164     /* List of trigger type and enablement functions for this event */
171      * @brief Parse and set the event's actions(OPTIONAL)
173      * @param[in] jsonObj - JSON object for the event
175      * Sets the list of actions to perform for the event
180      * @brief Parse and set the event's triggers
182      * @param[in] jsonObj - JSON object for the event
184      * Sets the list of triggers for the event