From c5736432ac09d19cd0e513e11082a7637a196829 Mon Sep 17 00:00:00 2001 From: Matthew Barth Date: Mon, 17 Apr 2017 12:22:50 -0500 Subject: Documentation only, no functional change Added copyrights and comments within headers Change-Id: Iebb17ba34b82a6c80718ad32338105a5245e640c Signed-off-by: Matthew Barth --- src/conditions.hpp | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'src/conditions.hpp') diff --git a/src/conditions.hpp b/src/conditions.hpp index 54a6dc6..b613679 100644 --- a/src/conditions.hpp +++ b/src/conditions.hpp @@ -12,6 +12,22 @@ namespace monitoring namespace condition { +/** + * @brief A condition used to trigger an action when a number of items are at + * or above a given value + * @details A given group of items is updated with their last known item + * value, which then the entire group is checked if there are a given number of + * them at or above a value which would cause the condition to be true + * + * @param[in] items - Group of items + * @param[in] path - Path of a item within the group + * @param[in] count - Number of items needed at or above value + * @param[in] value - Value of items to be at or above + * + * @return Lambda function + * A lambda function to determine if the number of items within the group + * are at or above the given value + */ template auto countAtOrAbove(Group& items, const char* path, size_t count, T&& value) { -- cgit v1.2.1