Emergency 20 Dokumentation  4.2.0
qsf::ai::reactionrules::HandleForwardedLocalEventRule Class Referenceabstract

#include <LocalEventRules.h>

Inheritance diagram for qsf::ai::reactionrules::HandleForwardedLocalEventRule:
qsf::ai::reactionrules::StandardRule qsf::ai::ReactionRule

Public Member Functions

 HandleForwardedLocalEventRule ()
virtual bool handle (const EvaluationParameters &parameters)
- Public Member Functions inherited from qsf::ai::reactionrules::StandardRule
 StandardRule (EvaluationParameters::PerceptionEventSource eventSource)
virtual const char * getRegistrationName () const =0
virtual void deserialize (const boost::property_tree::ptree &tree)
virtual void serialize (boost::property_tree::ptree &tree) const
- Public Member Functions inherited from qsf::ai::ReactionRule
 ReactionRule ()
 ReactionRule (const ReactionRule &src)
virtual ~ReactionRule ()
virtual ReactionRuleclone () const =0
virtual bool wantsHandlingDespiteOfLowerPriority () const
virtual void serialize (BinarySerializer &serializer)
const std::string & getName () const
uint32 getId () const
Percentage getProbability () const
void setProbability (Percentage probability)
action::Priority getPriority () const

Protected Member Functions

virtual bool onLocalEvent (const EvaluationParameters &parameters, const PerceptionEvent &event)=0
- Protected Member Functions inherited from qsf::ai::reactionrules::StandardRule
EvaluationParameters::PerceptionEventIterator checkForEvent (const EvaluationParameters &parameters) const
- Protected Member Functions inherited from qsf::ai::ReactionRule
bool pushEventToEntity (const PerceptionEvent &perceptionEvent) const

Additional Inherited Members

- Static Public Member Functions inherited from qsf::ai::ReactionRule
static bool compareByPriority (const ReactionRule *a, const ReactionRule *b)
- Protected Attributes inherited from qsf::ai::reactionrules::StandardRule
NamedIdentifier mEventId
EvaluationParameters::PerceptionEventSource mEventSource

Detailed Description

HandleForwardedLocalEventRule is the counterpart to ForwardLocalEventRule. It is attached to the entity that's supposed to react on a local event. Implement onLocalEvent to trigger actions on the event. Return true if you actually execute any action.

Sensor-Configuration: no sensor required, events are expected to be sent by a ForwardLocalEventRule and to arrive in the local event-queue.

Constructor & Destructor Documentation

qsf::ai::reactionrules::HandleForwardedLocalEventRule::HandleForwardedLocalEventRule ( )

Member Function Documentation

virtual bool qsf::ai::reactionrules::HandleForwardedLocalEventRule::handle ( const EvaluationParameters parameters)

Implements qsf::ai::ReactionRule.

virtual bool qsf::ai::reactionrules::HandleForwardedLocalEventRule::onLocalEvent ( const EvaluationParameters parameters,
const PerceptionEvent event 
protectedpure virtual

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