Compare the value of a number element to a target. More...

#include <indiCompRules.hpp>

Inheritance diagram for numValRule:

Collaboration diagram for numValRule:

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

Public Member Functions
	numValRule ()
	Default c'tor. More...

void	target (const double &tgt)
	Set the target for the comparison. More...

const double &	target ()
	Get the target. More...

void	tol (const double &t)
	Set the tolerance. More...

const double &	tol ()
	Get the tolerance. More...

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

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

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

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

const std::string &	element ()
	Get the 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...

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 [] = "numVal"
	Name of this rule, used by config system. More...

Protected Attributes
double	m_target {0}
	The target value for comparison. More...

double	m_tol {1e-6}
	The tolerance for the comparison. More...

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

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

std::string	m_element
	The element name within the 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

Compare the value of a number element to a target.

Definition at line 614 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

◆ numValRule()

numValRule::numValRule ( )

inline

Default c'tor.

Definition at line 630 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 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 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().

◆ element() [1/2]

const std::string& onePropRule::element ( )

inlineinherited

Get the element name.

Returns: the current value of m_element

Definition at line 425 of file indiCompRules.hpp.

◆ element() [2/2]

void onePropRule::element ( const std::string & el )

inlineinherited

Set the element name.

Parameters

[in] el the new element name

Definition at line 416 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(), 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().

◆ property() [1/2]

const pcf::IndiProperty* onePropRule::property ( )

inlineinherited

Get the property pointer.

Returns: the current value of m_property

Definition at line 410 of file indiCompRules.hpp.

Referenced by onePropRule::property().

◆ property() [2/2]

void onePropRule::property ( pcf::IndiProperty * property )

inlineinherited

Set the 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 391 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ target() [1/2]

const double& numValRule::target ( )

inline

Get the target.

Returns: the current value of m_target

Definition at line 643 of file indiCompRules.hpp.

◆ target() [2/2]

void numValRule::target ( const double & tgt )

inline

Set the target for the comparison.

Parameters

[in] tgt The new target

Definition at line 634 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ tol() [1/2]

const double& numValRule::tol ( )

inline

Get the tolerance.

Returns: the current value of m_tol

Definition at line 668 of file indiCompRules.hpp.

◆ tol() [2/2]

void numValRule::tol ( const double & t )

inline

Set the tolerance.

This is used for equality comparison to allow for floating point precision and text conversions in INDI. Set to 0 for strict comparison.

Exceptions

mx::err:invalidarg if the new value is negative

Parameters

[in] t the new tolerance

Definition at line 654 of file indiCompRules.hpp.

Referenced by loadRuleConfig().

◆ valid()

virtual boolorerr_t onePropRule::valid ( )

inlinevirtualinherited

Check if this rule is valid.

The rule is valid if the property pointer is not null, and the element is contained within the property.

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

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

◆ value()

virtual bool numValRule::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 682 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_element

std::string onePropRule::m_element

protectedinherited

The element name within the property.

Definition at line 375 of file indiCompRules.hpp.

Referenced by onePropRule::element(), onePropRule::valid(), value(), txtValRule::value(), and swValRule::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_property

pcf::IndiProperty* onePropRule::m_property {nullptr}

protectedinherited

Pointer to the property.

Definition at line 373 of file indiCompRules.hpp.

Referenced by onePropRule::property(), onePropRule::valid(), txtValRule::value(), and swValRule::value().

◆ m_target

double numValRule::m_target {0}

protected

The target value for comparison.

Definition at line 624 of file indiCompRules.hpp.

Referenced by target(), and value().

◆ m_tol

double numValRule::m_tol {1e-6}

protected

The tolerance for the comparison.

Definition at line 625 of file indiCompRules.hpp.

Referenced by tol(), and value().

◆ m_type

int onePropRule::m_type

protectedinherited

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

Definition at line 371 of file indiCompRules.hpp.

Referenced by onePropRule::property().

◆ name

constexpr char numValRule::name[] = "numVal"

staticconstexpr

Name of this rule, used by config system.

Definition at line 620 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

Constructor & Destructor Documentation

◆ numValRule()

Member Function Documentation

◆ comparison() [1/2]

◆ comparison() [2/2]

◆ compBool()

◆ compNum()

◆ compSw()

◆ compTxt()

◆ element() [1/2]

◆ element() [2/2]

◆ isError()

◆ message() [1/2]

◆ message() [2/2]

◆ priority() [1/2]

◆ priority() [2/2]

◆ property() [1/2]

◆ property() [2/2]

◆ target() [1/2]

◆ target() [2/2]

◆ tol() [1/2]

◆ tol() [2/2]

◆ valid()

◆ value()

Member Data Documentation

◆ m_comparison

◆ m_element

◆ m_message

◆ m_priority

◆ m_property

◆ m_target

◆ m_tol

◆ m_type

◆ name