A rule to compare two rules. More...

#include <indiCompRules.hpp>

Inheritance diagram for ruleCompRule:

Collaboration diagram for ruleCompRule:

Public Types
typedef std::variant< bool, std::string >	boolorerr_t
	In-band error reporting type. More...

Public Member Functions
void	rule1 (indiCompRule *r)
	Set the pointer to the first rule. More...

const indiCompRule *	rule1 ()
	Get the pointer to the first rule. More...

void	rule2 (indiCompRule *r)
	Set the pointer to the second rule. More...

const indiCompRule *	rule2 ()
	Get the pointer to the first rule. More...

virtual boolorerr_t	valid ()
	Check if this rule is valid. More...

virtual bool	value ()
	Get the value of this rule. More...

bool	isError (boolorerr_t rv)
	Check if returned value indicates an error. More...

void	priority (const rulePriority &p)
	Set priority of this rule. More...

const rulePriority &	priority ()
	Get the rule priority. More...

void	message (const std::string &m)
	Set the message. More...

const std::string &	message ()
	Get the message. More...

void	comparison (const ruleComparison &c)
	Set the comparison for this rule. More...

const ruleComparison &	comparison ()
	Get the rule comparison. More...

boolorerr_t	compTxt (const std::string &str1, const std::string &str2)
	Compare two strings. More...

boolorerr_t	compSw (const pcf::IndiElement::SwitchStateType &sw1, const pcf::IndiElement::SwitchStateType &sw2)
	Compare two switches. More...

boolorerr_t	compNum (const double &num1, const double &num2, const double &tol)
	Compare two numbers. More...

boolorerr_t	compBool (const bool &b1, const bool &b2)
	Compare two booleans. More...

Static Public Attributes
static constexpr char	name [] = "ruleComp"
	Name of this rule, used by config system. More...

Protected Attributes
indiCompRule *	m_rule1 {nullptr}
	rule one More...

indiCompRule *	m_rule2 {nullptr}
	rule two More...

rulePriority	m_priority {rulePriority::none}
	The reporting priority for this rule. More...

std::string	m_message
	The message used for notifications. More...

ruleComparison	m_comparison {ruleComparison::Eq}
	The comparison for this rule. More...

Detailed Description

A rule to compare two rules.

Definition at line 1000 of file indiCompRules.hpp.

Member Typedef Documentation

◆ boolorerr_t

typedef std::variant<bool, std::string> indiCompRule::boolorerr_t

inherited

In-band error reporting type.

Definition at line 142 of file indiCompRules.hpp.

Member Function Documentation

◆ comparison() [1/2]

const ruleComparison& indiCompRule::comparison ( )

inlineinherited

Get the rule comparison.

Returns: the current rule comparison

Definition at line 208 of file indiCompRules.hpp.

◆ comparison() [2/2]

void indiCompRule::comparison ( const ruleComparison & c )

inlineinherited

Set the comparison for this rule.

Parameters

[in] c the new comparison

Definition at line 198 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ compBool()

boolorerr_t indiCompRule::compBool	(	const bool &	b1,
		const bool &	b2
	)

inlineinherited

Compare two booleans.

Returns: true if the comparison is true; false if the comparison is false; std::string with error message if the comparison is not valid

Parameters

[in]	b1	the first bool to compare
[in]	b2	the second bool to compare

Definition at line 331 of file indiCompRules.hpp.

Referenced by value().

◆ compNum()

boolorerr_t indiCompRule::compNum	(	const double &	num1,
		const double &	num2,
		const double &	tol
	)

inlineinherited

Compare two numbers.

The comparison is (num1 comp num2), e.g. (num1 < num2). A tolerance is included for floating point equality.

Returns: true if the comparison is true; false if the comparison is false; std::string with error message if the comparison is not valid

Parameters

[in]	num1	the first number to compare
[in]	num2	the second number to compare
[in]	tol	the tolerance for the comparison

Definition at line 289 of file indiCompRules.hpp.

Referenced by numValRule::value(), and elCompNumRule::value().

◆ compSw()

boolorerr_t indiCompRule::compSw	(	const pcf::IndiElement::SwitchStateType &	sw1,
		const pcf::IndiElement::SwitchStateType &	sw2
	)

inlineinherited

Compare two switches.

Switch comparison can only be Eq or Neq.

Returns: true if the comparison is true; false if the comparison is false; std::string with error message if the comparison is not valid

Parameters

[in]	sw1	the first switch to compare
[in]	sw2	the first switch to compare

Definition at line 260 of file indiCompRules.hpp.

Referenced by swValRule::value(), and elCompSwRule::value().

◆ compTxt()

boolorerr_t indiCompRule::compTxt	(	const std::string &	str1,
		const std::string &	str2
	)

inlineinherited

Compare two strings.

String comparison can only be Eq or Neq.

Returns: true if the comparison is true; false if the comparison is false; std::string with error message if the comparison is not valid

Parameters

[in]	str1	the first string to compare
[in]	str2	the second string to compare

Definition at line 232 of file indiCompRules.hpp.

Referenced by txtValRule::value(), and elCompTxtRule::value().

◆ isError()

bool indiCompRule::isError ( boolorerr_t rv )

inlineinherited

Check if returned value indicates an error.

Parameters

[in] rv the return value to check

Definition at line 145 of file indiCompRules.hpp.

Referenced by valid(), numValRule::value(), txtValRule::value(), swValRule::value(), elCompNumRule::value(), elCompTxtRule::value(), elCompSwRule::value(), and value().

◆ message() [1/2]

const std::string& indiCompRule::message ( )

inlineinherited

Get the message.

Returns: the current message

Definition at line 192 of file indiCompRules.hpp.

◆ message() [2/2]

void indiCompRule::message ( const std::string & m )

inlineinherited

Set the message.

Parameters

[in] m the new message

Definition at line 183 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ priority() [1/2]

const rulePriority& indiCompRule::priority ( )

inlineinherited

Get the rule priority.

Returns: the current rule priority

Definition at line 177 of file indiCompRules.hpp.

◆ priority() [2/2]

void indiCompRule::priority ( const rulePriority & p )

inlineinherited

Set priority of this rule.

Parameters

[in] p the new priority

Definition at line 168 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ rule1() [1/2]

const indiCompRule* ruleCompRule::rule1 ( )

inline

Get the pointer to the first rule.

Returns: the current value of m_rule1

Definition at line 1024 of file indiCompRules.hpp.

◆ rule1() [2/2]

void ruleCompRule::rule1 ( indiCompRule * r )

inline

Set the pointer to the first rule.

Parameters

[in] r the new pointer to rule1

Definition at line 1015 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ rule2() [1/2]

const indiCompRule* ruleCompRule::rule2 ( )

inline

Get the pointer to the first rule.

Returns: the current value of m_rule2

Definition at line 1039 of file indiCompRules.hpp.

◆ rule2() [2/2]

void ruleCompRule::rule2 ( indiCompRule * r )

inline

Set the pointer to the second rule.

Parameters

[in] r the new pointer to rule2

Definition at line 1030 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ valid()

virtual boolorerr_t ruleCompRule::valid ( )

inlinevirtual

Check if this rule is valid.

The rule is valid if the rule pointers are not nullptr, and if each rule is itself valid.

If not valid, the return value is a std::string with the reason. If valid, the return value is a bool set to true.

Implements indiCompRule.

Definition at line 1050 of file indiCompRules.hpp.

Referenced by value().

◆ value()

virtual bool ruleCompRule::value ( )

inlinevirtual

Get the value of this rule.

First checks if the rule is currently valid. The performs the comparison and returns the result.

Returns: the value of the comparison, true or false

Exceptions

mx::err::invalidconfig	if the rule is not currently valid
mx::err::invalidconfig	on an error from the comparison

Implements indiCompRule.

Definition at line 1090 of file indiCompRules.hpp.

Referenced by audibleAlerts.personality.Operation::__str__(), and audibleAlerts.personality.Transition::compare().

Member Data Documentation

◆ m_comparison

ruleComparison indiCompRule::m_comparison {ruleComparison::Eq}

protectedinherited

The comparison for this rule.

Definition at line 159 of file indiCompRules.hpp.

Referenced by indiCompRule::comparison(), indiCompRule::compBool(), indiCompRule::compNum(), indiCompRule::compSw(), and indiCompRule::compTxt().

◆ m_message

std::string indiCompRule::m_message

protectedinherited

The message used for notifications.

Definition at line 156 of file indiCompRules.hpp.

Referenced by indiCompRule::message().

◆ m_priority

rulePriority indiCompRule::m_priority {rulePriority::none}

protectedinherited

The reporting priority for this rule.

Definition at line 153 of file indiCompRules.hpp.

Referenced by indiCompRule::priority().

◆ m_rule1

indiCompRule* ruleCompRule::m_rule1 {nullptr}

protected

rule one

Definition at line 1009 of file indiCompRules.hpp.

Referenced by rule1(), valid(), and value().

◆ m_rule2

indiCompRule* ruleCompRule::m_rule2 {nullptr}

protected

rule two

Definition at line 1010 of file indiCompRules.hpp.

Referenced by rule2(), valid(), and value().

◆ name

constexpr char ruleCompRule::name[] = "ruleComp"

staticconstexpr

Name of this rule, used by config system.

Definition at line 1006 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

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

apps/stateRuleEngine/indiCompRules.hpp

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ boolorerr_t

Member Function Documentation

◆ comparison() [1/2]

◆ comparison() [2/2]

◆ compBool()

◆ compNum()

◆ compSw()

◆ compTxt()

◆ isError()

◆ message() [1/2]

◆ message() [2/2]

◆ priority() [1/2]

◆ priority() [2/2]

◆ rule1() [1/2]

◆ rule1() [2/2]

◆ rule2() [1/2]

◆ rule2() [2/2]

◆ valid()

◆ value()

Member Data Documentation

◆ m_comparison

◆ m_message

◆ m_priority

◆ m_rule1

◆ m_rule2

◆ name