pion::platform::RuleChain Class Reference

List of all members.

---

Detailed Description

Definition at line 37 of file RuleChain.hpp.

Public Member Functions
	RuleChain (void)
	default constructor for a RuleChain
virtual	~RuleChain ()
	virtual destructor: this class is meant to be extended
virtual void	setConfig (const pion::platform::Vocabulary &v, const xmlNodePtr config_ptr)
virtual void	updateVocabulary (const pion::platform::Vocabulary &v)
bool	operator() (const pion::platform::EventPtr &e) const
Classes
class	EmptyTermException
	exception thrown if the configuration does not define a Term for a Comparison More...
class	EmptyTypeException
	exception thrown if the configuration does not define a Comparison type More...
class	EmptyValueException
	exception thrown if the configuration does not define a Term for a Comparison More...
class	UnknownTermException
	exception thrown if unable to find the configured Vocabulary Term More...

---

Member Function Documentation

bool pion::platform::RuleChain::operator()

(

const pion::platform::EventPtr &

e

)

const [inline]

Checks to see if an Event passes the RuleChain configuration

Parameters:

e

pointer to the Event to process

Returns:

true if the Event passes the RuleChain, false if not

Definition at line 141 of file RuleChain.hpp.

void pion::platform::RuleChain::setConfig	(	const pion::platform::Vocabulary &	v,
		const xmlNodePtr	config_ptr
	)			[virtual]

sets configuration parameters for this RuleChain

Parameters:

	v	the Vocabulary that this RuleChain will use to describe Terms
	config_ptr	pointer to a list of XML nodes containing RuleChain configuration parameters

Definition at line 40 of file RuleChain.cpp.

References pion::platform::Comparison::configure(), pion::platform::ConfigManager::findConfigNodeByName(), pion::platform::Vocabulary::findTerm(), pion::platform::ConfigManager::getConfigOption(), pion::platform::ConfigManager::getConfigOptionEmptyOk(), pion::platform::Comparison::parseComparisonType(), pion::platform::Comparison::requiresValue(), and pion::platform::Vocabulary::UNDEFINED_TERM_REF.

Referenced by pion::platform::DatabaseInserter::setConfig(), and pion::plugins::FilterReactor::setConfig().

void pion::platform::RuleChain::updateVocabulary

(

const pion::platform::Vocabulary &

v

)

[virtual]

this updates the Vocabulary information used by this RuleChain; it should be called whenever the global Vocabulary is updated

Parameters:

v

the Vocabulary that this RuleChain will use to describe Terms

Definition at line 108 of file RuleChain.cpp.

Referenced by pion::plugins::FilterReactor::updateVocabulary().

---

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

• platform/include/pion/platform/RuleChain.hpp
• platform/src/RuleChain.cpp

---