kcenon::monitoring::range_trigger Class Reference

Trigger based on value being within or outside a range. More...

#include <alert_triggers.h>

Inheritance diagram for kcenon::monitoring::range_trigger:

Collaboration diagram for kcenon::monitoring::range_trigger:

Public Member Functions
	range_trigger (double min_value, double max_value, bool inside_range)
	Construct a range trigger.
bool	evaluate (double value) const override
	Evaluate the trigger condition.
std::string	type_name () const override
	Get trigger type name.
std::string	description () const override
	Get human-readable description.
Public Member Functions inherited from kcenon::monitoring::alert_trigger
virtual	~alert_trigger ()=default

Private Attributes
double	min_value_
double	max_value_
bool	inside_range_

Detailed Description

Trigger based on value being within or outside a range.

Definition at line 178 of file alert_triggers.h.

Constructor & Destructor Documentation

range_trigger()

kcenon::monitoring::range_trigger::range_trigger ( double min_value, double max_value, bool inside_range )

inline

Construct a range trigger.

Parameters

min_value	Minimum value of range
max_value	Maximum value of range
inside_range	True to trigger when inside, false when outside

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 186 of file alert_triggers.h.

        : min_value_(min_value)
        , max_value_(max_value)
        , inside_range_(inside_range) {}

Member Function Documentation

description()

std::string kcenon::monitoring::range_trigger::description ( ) const

inlineoverridevirtual

Get human-readable description.

Returns

Description string

Implements kcenon::monitoring::alert_trigger.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 200 of file alert_triggers.h.

                                           {
        if (inside_range_) {
            return "value in [" + std::to_string(min_value_) + ", " +
                   std::to_string(max_value_) + "]";
        }
        return "value outside [" + std::to_string(min_value_) + ", " +
               std::to_string(max_value_) + "]";
    }

References inside_range_, max_value_, and min_value_.

evaluate()

bool kcenon::monitoring::range_trigger::evaluate ( double value ) const

inlineoverridevirtual

Evaluate the trigger condition.

Parameters

value

Current metric value

Returns

True if trigger condition is met

Implements kcenon::monitoring::alert_trigger.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 191 of file alert_triggers.h.

                                               {
        bool in_range = (value >= min_value_ && value <= max_value_);
        return inside_range_ ? in_range : !in_range;
    }

References inside_range_, max_value_, and min_value_.

type_name()

std::string kcenon::monitoring::range_trigger::type_name ( ) const

inlineoverridevirtual

Get trigger type name.

Returns

Type name string

Implements kcenon::monitoring::alert_trigger.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 196 of file alert_triggers.h.

                                         {
        return "range";
    }

Member Data Documentation

inside_range_

bool kcenon::monitoring::range_trigger::inside_range_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 212 of file alert_triggers.h.

Referenced by description(), and evaluate().

max_value_

double kcenon::monitoring::range_trigger::max_value_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 211 of file alert_triggers.h.

Referenced by description(), and evaluate().

min_value_

double kcenon::monitoring::range_trigger::min_value_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/alert/alert_triggers.h.

Definition at line 210 of file alert_triggers.h.

Referenced by description(), and evaluate().

---

The documentation for this class was generated from the following file:

• include/kcenon/monitoring/alert/alert_triggers.h