Virtual base-class for all rules. More...

#include <indiCompRules.hpp>

Inheritance diagram for indiCompRule:

Collaboration diagram for indiCompRule:

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

Public Member Functions
bool	isError (boolorerr_t rv)
	Check if returned value indicates an error.

virtual	~indiCompRule ()
	Virtual destructor.

virtual ruleComparison	defaultComparison () const
	Get the default comparison for this rule type.

void	priority (const rulePriority &p, double delay=-1)
	Set priority of this rule.

const rulePriority &	priority ()
	Get the rule priority.

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

const std::string &	message (bool settime=false)
	Get the message.

const timespec &	lastMsg ()

double	sinceLastMsg ()
	Get the time since the last message.

bool	timeToSend ()
	Check if it's time to send a message.

void	messageDelay (double md)
	Set the message delay.

double	messageDelay ()
	Get the message delay.

void	messageCount (int mc)
	Set the message count.

int	incMessageCount ()
	Increment the message count.

int	messageCount ()
	Get the message count.

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

const ruleComparison &	comparison ()
	Get the rule comparison.

virtual boolorerr_t	valid ()=0
	Report whether the rule is valid as configured.

virtual bool	value ()=0
	Get the value of this rule.

virtual bool	popRuntimeDiagnostic (std::string &diagnostic)
	Pop one pending runtime diagnostic, if any.

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

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

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

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

Static Public Attributes
static constexpr double	default_info_msg_delay = 0

static constexpr double	default_caution_msg_delay = 60

static constexpr double	default_warning_msg_delay = 30

static constexpr double	default_alert_msg_delay = 5

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

std::string	m_message
	The message used for notifications.

timespec	m_lastMsg { 0, 0 }
	Time the message was last sent.

double	m_messageDelay { 0 }
	Delay between sending messages.

int	m_messageCount { 0 }
	Number of times the message has been sent.

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

Detailed Description

Virtual base-class for all rules.

Provides error handling and comparison functions. Derived classes must implement valid() and value().

Definition at line 183 of file indiCompRules.hpp.

Member Typedef Documentation

◆ boolorerr_t

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

In-band error reporting type.

Definition at line 187 of file indiCompRules.hpp.

Constructor & Destructor Documentation

◆ ~indiCompRule()

virtual indiCompRule::~indiCompRule ( )

inlinevirtual

Virtual destructor.

Definition at line 218 of file indiCompRules.hpp.

Member Function Documentation

◆ comparison() [1/2]

const ruleComparison & indiCompRule::comparison ( )

inline

Get the rule comparison.

Returns: the current rule comparison

Definition at line 387 of file indiCompRules.hpp.

References m_comparison.

Referenced by multiSwitchComboRule::multiSwitchComboRule(), and ruleCompRule::ruleCompRule().

◆ comparison() [2/2]

void indiCompRule::comparison ( const ruleComparison & c )

inline

Set the comparison for this rule.

Parameters

[in] c the new comparison

Definition at line 377 of file indiCompRules.hpp.

References m_comparison.

Referenced by libXWCTest::stateRuleEngineTest::SCENARIO(), SCENARIO(), SCENARIO(), SCENARIO(), and libXWCTest::stateRuleEngineTest::SCENARIO().

◆ compBool()

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

inline

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

References And, Eq, Imply, m_comparison, Nand, Neq, Nimply, Nor, and Or.

Referenced by ruleCompRule::value().

◆ compNum()

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

inline

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

References Eq, Gt, GtEq, Lt, LtEq, m_comparison, and Neq.

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

◆ compSw()

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

inline

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

References Eq, m_comparison, and Neq.

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

◆ compTxt()

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

inline

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

References Eq, m_comparison, and Neq.

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

◆ defaultComparison()

virtual ruleComparison indiCompRule::defaultComparison ( ) const

inlinevirtual

Get the default comparison for this rule type.

Returns: the comparison that should be used when comp is omitted from configuration

Reimplemented in multiSwitchComboRule, and ruleCompRule.

Definition at line 226 of file indiCompRules.hpp.

References Eq.

◆ incMessageCount()

int indiCompRule::incMessageCount ( )

inline

Increment the message count.

Definition at line 364 of file indiCompRules.hpp.

References m_messageCount.

◆ isError()

bool indiCompRule::isError ( boolorerr_t rv )

inline

Check if returned value indicates an error.

Parameters

[in] rv the return value to check

Definition at line 190 of file indiCompRules.hpp.

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

◆ lastMsg()

const timespec & indiCompRule::lastMsg ( )

inline

Definition at line 298 of file indiCompRules.hpp.

References m_lastMsg.

◆ message() [1/2]

const std::string & indiCompRule::message ( bool settime = false )

inline

Get the message.

Optionally sets the message time to now.

Returns: the current message

Parameters

settime If true m_lastMsg is set to now

Definition at line 285 of file indiCompRules.hpp.

References m_lastMsg, and m_message.

◆ message() [2/2]

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

inline

Set the message.

Parameters

[in] m the new message

Definition at line 276 of file indiCompRules.hpp.

References m_message.

Referenced by libXWCTest::stateRuleEngineTest::TEST_CASE().

◆ messageCount() [1/2]

int indiCompRule::messageCount ( )

inline

Get the message count.

Definition at line 371 of file indiCompRules.hpp.

References m_messageCount.

◆ messageCount() [2/2]

void indiCompRule::messageCount ( int mc )

inline

Set the message count.

Parameters

[in] mc the new message count

Definition at line 358 of file indiCompRules.hpp.

References m_messageCount.

Referenced by libXWCTest::stateRuleEngineTest::TEST_CASE().

◆ messageDelay() [1/2]

double indiCompRule::messageDelay ( )

inline

Get the message delay.

Definition at line 352 of file indiCompRules.hpp.

References m_messageDelay.

◆ messageDelay() [2/2]

void indiCompRule::messageDelay ( double md )

inline

Set the message delay.

Parameters

[in] md the new message delay

Definition at line 346 of file indiCompRules.hpp.

References m_messageDelay.

◆ popRuntimeDiagnostic()

virtual bool indiCompRule::popRuntimeDiagnostic ( std::string & diagnostic )

inlinevirtual

Pop one pending runtime diagnostic, if any.

Returns: true when a diagnostic string was returned; false when no diagnostic was pending

Parameters

[out] diagnostic the next pending diagnostic message

Reimplemented in multiSwitchComboRule, and ruleCompRule.

Definition at line 409 of file indiCompRules.hpp.

Referenced by ruleCompRule::popRuntimeDiagnostic().

◆ priority() [1/2]

const rulePriority & indiCompRule::priority ( )

inline

Get the rule priority.

Returns: the current rule priority

Definition at line 270 of file indiCompRules.hpp.

References m_priority.

◆ priority() [2/2]

void indiCompRule::priority	(	const rulePriority &	p,
		double	delay = `-1`
	)

inline

Set priority of this rule.

Also sets the message delay, to default for priority if not set.

Parameters

[in]	p	the new priority
[in]	delay	[opt] the message delay, if < 0 the default is used

Definition at line 234 of file indiCompRules.hpp.

References alert, caution, default_alert_msg_delay, default_caution_msg_delay, default_info_msg_delay, default_warning_msg_delay, info, m_messageDelay, m_priority, and warning.

Referenced by libXWCTest::stateRuleEngineTest::TEST_CASE().

◆ sinceLastMsg()

double indiCompRule::sinceLastMsg ( )

inline

Get the time since the last message.

Definition at line 304 of file indiCompRules.hpp.

References m_lastMsg.

Referenced by timeToSend().

◆ timeToSend()

bool indiCompRule::timeToSend ( )

inline

Check if it's time to send a message.

If the message delay is <= 0, this is based on message count (i.e. has it been sent). Otherwise it's based on the time since last sent

Definition at line 319 of file indiCompRules.hpp.

References m_messageCount, m_messageDelay, and sinceLastMsg().

◆ valid()

virtual boolorerr_t indiCompRule::valid ( )

pure virtual

Report whether the rule is valid as configured.

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

Implemented in onePropRule, twoPropRule, multiSwitchComboRule, and ruleCompRule.

Referenced by ruleCompRule::valid().

◆ value()

virtual bool indiCompRule::value ( )

pure virtual

Get the value of this rule.

Returns: the result of the comparison defined by the rule

protected

The comparison for this rule.

Definition at line 214 of file indiCompRules.hpp.

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

◆ m_lastMsg

timespec indiCompRule::m_lastMsg { 0, 0 }

protected

Time the message was last sent.

Definition at line 207 of file indiCompRules.hpp.

Referenced by lastMsg(), message(), and sinceLastMsg().

◆ m_message

std::string indiCompRule::m_message

protected

The message used for notifications.

Definition at line 205 of file indiCompRules.hpp.

Referenced by message(), and message().

◆ m_messageCount

int indiCompRule::m_messageCount { 0 }

protected

Number of times the message has been sent.

Definition at line 211 of file indiCompRules.hpp.

Referenced by incMessageCount(), messageCount(), messageCount(), and timeToSend().

◆ m_messageDelay

double indiCompRule::m_messageDelay { 0 }

protected

Delay between sending messages.

Definition at line 209 of file indiCompRules.hpp.

Referenced by messageDelay(), messageDelay(), priority(), and timeToSend().

◆ m_priority

rulePriority indiCompRule::m_priority { rulePriority::none }

protected

The reporting priority for this rule.

Definition at line 202 of file indiCompRules.hpp.

Referenced by priority(), and priority().

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

◆ ~indiCompRule()

Member Function Documentation

◆ comparison() [1/2]

◆ comparison() [2/2]

◆ compBool()

◆ compNum()

◆ compSw()

◆ compTxt()

◆ defaultComparison()

◆ incMessageCount()

◆ isError()

◆ lastMsg()

◆ message() [1/2]

◆ message() [2/2]

◆ messageCount() [1/2]

◆ messageCount() [2/2]

◆ messageDelay() [1/2]

◆ messageDelay() [2/2]

◆ popRuntimeDiagnostic()

◆ priority() [1/2]

◆ priority() [2/2]

◆ sinceLastMsg()

◆ timeToSend()

◆ valid()

◆ value()

Member Data Documentation

◆ default_alert_msg_delay

◆ default_caution_msg_delay

◆ default_info_msg_delay

◆ default_warning_msg_delay

◆ m_comparison

◆ m_lastMsg

◆ m_message

◆ m_messageCount

◆ m_messageDelay

◆ m_priority