rule specifically to monitor a single bit for rising edge. More...

#include <rising_bit.h>

Inheritance diagram for sme::rules::rising_bit:

Public Member Functions
	rising_bit (uint8_t _bit)
	Construct a new rising bit object.

virtual	~rising_bit ()
	Destroy the rising bit object.

virtual void	process_rule (uint64_t _old_value, uint64_t &_new_value)
	process rule evaluation between old and new values.

Public Member Functions inherited from sme::I_pattern_rule
	I_pattern_rule ()
	Interface parent constructor for a new i pattern rule object.

virtual	~I_pattern_rule ()
	Destroy the i pattern rule object.

virtual void	process_rule (std::uint64_t _old_value, std::uint64_t &_new_value)=0
	process rule evaluation between old and new values.

void	action (std::function< void()> _action)
	Binds a void(void) lambda as the callback action to this rule.

_always_inline bool	is_active ()
	reports if rule is active for processing.

_always_inline bool	is_bound ()
	has the lambda callback been bound.

Public Attributes
uint8_t	m_bit
	The bit which is to change state.

Additional Inherited Members
Protected Attributes inherited from sme::I_pattern_rule
std::function< void()>	m_lambda
	placeholder for lambda

bool	m_is_active
	stores is active

Detailed Description

rule specifically to monitor a single bit for rising edge.

Constructor & Destructor Documentation

sme::rules::rising_bit::rising_bit ( uint8_t _bit )

inline

Construct a new rising bit object.

Parameters

_bit	to monitor (0 base relative to target (register or field))

virtual sme::rules::rising_bit::~rising_bit ( )

inlinevirtual

Destroy the rising bit object.

virtual void sme::rules::rising_bit::process_rule	(	uint64_t	_old_value,
		uint64_t &	_new_value
	)

inlinevirtual

process rule evaluation between old and new values.

Parameters

_old_value	value of content prior to read or write
_new_value	value of content post read or write

uint8_t sme::rules::rising_bit::m_bit

The bit which is to change state.

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

/disk2/mp/builds/mono-124635/src/devices/c++-api/extensions/src/sme/pattern_rules/rising_bit.h