A rule base class for testing elements in two properties. More...

#include <indiCompRules.hpp>

Inheritance diagram for twoPropRule:

Collaboration diagram for twoPropRule:

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

Public Member Functions
	twoPropRule ()=delete

	twoPropRule (int type)
	Constructor. You must provide the property type to construct a twoPropRule. More...

void	property1 (pcf::IndiProperty *property)
	Set the first property pointer. More...

const pcf::IndiProperty *	property1 ()
	Get the first property pointer. More...

void	element1 (const std::string &el)
	Set the first element name. More...

const std::string &	element1 ()
	Get the first element name. More...

void	property2 (pcf::IndiProperty *property)
	Set the second property pointer. More...

const pcf::IndiProperty *	property2 ()
	Get the second property pointer. More...

void	element2 (const std::string &el)
	Set the second element name. More...

const std::string &	element2 ()
	Get the second element name. More...

virtual boolorerr_t	valid ()
	Check if this rule is valid. 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...

virtual bool	value ()=0
	Get the value of this rule. 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...

Protected Attributes
int	m_type
	The property type, from pcf::IndiProperty::Type. More...

pcf::IndiProperty *	m_property1 {nullptr}
	Pointer to the first property. More...

std::string	m_element1
	The element name within the first property. More...

pcf::IndiProperty *	m_property2 {nullptr}
	Pointer to the second property. More...

std::string	m_element2
	The element name within the second property. 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 base class for testing elements in two properties.

Definition at line 458 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.

Constructor & Destructor Documentation

◆ twoPropRule() [1/2]

twoPropRule::twoPropRule ( )

delete

◆ twoPropRule() [2/2]

twoPropRule::twoPropRule ( int type )

inlineexplicit

Constructor. You must provide the property type to construct a twoPropRule.

Definition at line 479 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.

Referenced by ruleCompRule::ruleCompRule().

◆ 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 ruleCompRule::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().

◆ element1() [1/2]

const std::string& twoPropRule::element1 ( )

inline

Get the first element name.

Returns: the current value of m_element1

Definition at line 521 of file indiCompRules.hpp.

◆ element1() [2/2]

void twoPropRule::element1 ( const std::string & el )

inline

Set the first element name.

Parameters

[in] el the new element name

Definition at line 512 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ element2() [1/2]

const std::string& twoPropRule::element2 ( )

inline

Get the second element name.

Returns: the current value of m_element2

Definition at line 565 of file indiCompRules.hpp.

◆ element2() [2/2]

void twoPropRule::element2 ( const std::string & el )

inline

Set the second element name.

Parameters

[in] el the new element name

Definition at line 556 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ 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 ruleCompRule::valid(), numValRule::value(), txtValRule::value(), swValRule::value(), elCompNumRule::value(), elCompTxtRule::value(), elCompSwRule::value(), and ruleCompRule::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().

◆ property1() [1/2]

const pcf::IndiProperty* twoPropRule::property1 ( )

inline

Get the first property pointer.

Returns: the current value of m_property1

Definition at line 506 of file indiCompRules.hpp.

◆ property1() [2/2]

void twoPropRule::property1 ( pcf::IndiProperty * property )

inline

Set the first property pointer.

Exceptions

mx::err::invalidarg	if `property` is nullptr
mx::err::invalidconfig	if the supplied property has the wrong type

Parameters

[in] property the new property pointer

Definition at line 487 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ property2() [1/2]

const pcf::IndiProperty* twoPropRule::property2 ( )

inline

Get the second property pointer.

Returns: the current value of m_property2

Definition at line 550 of file indiCompRules.hpp.

◆ property2() [2/2]

void twoPropRule::property2 ( pcf::IndiProperty * property )

inline

Set the second property pointer.

Exceptions

mx::err::invalidarg	if `property` is nullptr
mx::err::invalidconfig	if the supplied property has the wrong type

Parameters

[in] property the new property pointer

Definition at line 531 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ valid()

virtual boolorerr_t twoPropRule::valid ( )

inlinevirtual

Check if this rule is valid.

The rule is valid if both property pointers are not null, and the elements are contained within their respective properties.

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 577 of file indiCompRules.hpp.

Referenced by elCompNumRule::value(), elCompTxtRule::value(), and elCompSwRule::value().

◆ value()

virtual bool indiCompRule::value ( )

pure virtualinherited

Get the value of this rule.

Returns: the result of the comparison defined by the rule

Implemented in ruleCompRule, elCompSwRule, elCompTxtRule, elCompNumRule, swValRule, txtValRule, and numValRule.

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

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_element1

std::string twoPropRule::m_element1

protected

The element name within the first property.

Definition at line 467 of file indiCompRules.hpp.

Referenced by element1(), valid(), elCompNumRule::value(), elCompTxtRule::value(), and elCompSwRule::value().

◆ m_element2

std::string twoPropRule::m_element2

protected

The element name within the second property.

Definition at line 471 of file indiCompRules.hpp.

Referenced by element2(), valid(), elCompNumRule::value(), elCompTxtRule::value(), and elCompSwRule::value().

◆ 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_property1

pcf::IndiProperty* twoPropRule::m_property1 {nullptr}

protected

Pointer to the first property.

Definition at line 465 of file indiCompRules.hpp.

Referenced by property1(), valid(), elCompNumRule::value(), elCompTxtRule::value(), and elCompSwRule::value().

◆ m_property2

pcf::IndiProperty* twoPropRule::m_property2 {nullptr}

protected

Pointer to the second property.

Definition at line 469 of file indiCompRules.hpp.

Referenced by property2(), valid(), elCompNumRule::value(), elCompTxtRule::value(), and elCompSwRule::value().

◆ m_type

int twoPropRule::m_type

protected

The property type, from pcf::IndiProperty::Type.

Definition at line 463 of file indiCompRules.hpp.

Referenced by property1(), and property2().

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

apps/stateRuleEngine/indiCompRules.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ boolorerr_t

Constructor & Destructor Documentation

◆ twoPropRule() [1/2]

◆ twoPropRule() [2/2]

Member Function Documentation

◆ comparison() [1/2]

◆ comparison() [2/2]

◆ compBool()

◆ compNum()

◆ compSw()

◆ compTxt()

◆ element1() [1/2]

◆ element1() [2/2]

◆ element2() [1/2]

◆ element2() [2/2]

◆ isError()

◆ message() [1/2]

◆ message() [2/2]

◆ priority() [1/2]

◆ priority() [2/2]

◆ property1() [1/2]

◆ property1() [2/2]

◆ property2() [1/2]

◆ property2() [2/2]

◆ valid()

◆ value()

Member Data Documentation

◆ m_comparison

◆ m_element1

◆ m_element2

◆ m_message

◆ m_priority

◆ m_property1

◆ m_property2

◆ m_type