pion::plugins::FilterReactor Class Reference

#include <FilterReactor.hpp>

Inherits pion::platform::Reactor.

List of all members.


Detailed Description

FilterReactor: used to filter out unwanted Events

Definition at line 36 of file FilterReactor.hpp.

Public Member Functions

 FilterReactor (void)
 constructs a new FilterReactor object
virtual ~FilterReactor ()
 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)
virtual void process (const pion::platform::EventPtr &e)


Member Function Documentation

void pion::plugins::FilterReactor::process ( const pion::platform::EventPtr e  )  [virtual]

processes an Event by comparing its data to the configured RuleChain. Only Events which pass all Comparisons in the RuleChain will be delivered to the output connections.

Parameters:
e pointer to the Event to process

Reimplemented from pion::platform::Reactor.

Definition at line 49 of file FilterReactor.cpp.

References pion::platform::Reactor::deliverEvent().

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

sets configuration parameters for this Reactor

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

Reimplemented from pion::platform::Reactor.

Definition at line 31 of file FilterReactor.cpp.

References pion::platform::Reactor::ConfigWriteLock, and pion::platform::RuleChain::setConfig().

void pion::plugins::FilterReactor::updateVocabulary ( const pion::platform::Vocabulary v  )  [virtual]

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

Parameters:
v the Vocabulary that this Reactor will use to describe Terms

Reimplemented from pion::platform::Reactor.

Definition at line 41 of file FilterReactor.cpp.

References pion::platform::Reactor::ConfigWriteLock, and pion::platform::RuleChain::updateVocabulary().


The documentation for this class was generated from the following files:
Generated on Wed Apr 13 16:38:36 2011 for pion-platform by  doxygen 1.4.7