Emergency 20 Dokumentation  4.2.0
qsf::ai::reactionrules::GlobalEventStartEnd Class Reference

#include <GlobalEventRules.h>

Inheritance diagram for qsf::ai::reactionrules::GlobalEventStartEnd:
qsf::ai::reactionrules::StandardRule qsf::ai::ReactionRule qsf::ai::reactionrules::GlobalEventStartEndAnimated

Public Member Functions

 GlobalEventStartEnd ()
 
virtual void serialize (BinarySerializer &serializer)
 
virtual void deserialize (const boost::property_tree::ptree &tree)
 
virtual void serialize (boost::property_tree::ptree &tree) const
 
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
 
- Public Member Functions inherited from qsf::ai::ReactionRule
 ReactionRule ()
 
 ReactionRule (const ReactionRule &src)
 
virtual ~ReactionRule ()
 
virtual ReactionRuleclone () const =0
 
virtual bool wantsHandlingDespiteOfLowerPriority () const
 
const std::string & getName () const
 
uint32 getId () const
 
Percentage getProbability () const
 
void setProbability (Percentage probability)
 
action::Priority getPriority () const
 

Protected Member Functions

virtual bool onEventStart (const EvaluationParameters &parameters, const PerceptionEvent &event)
 
virtual void onEventEnd (const EvaluationParameters &parameters, const PerceptionEvent &event)
 
- 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

Base class for reactions on global events actually consisting out of two events, a start-event and an end-event, with dedicated IDs. Derived classes should override onEventStart and onEventEnd and implement the respective actions there. onEventEnd is only called if onEventStart returnd true.

Sensor-Configuration: No sensor required.

Additional JSON configuration tags: EndEventId

Constructor & Destructor Documentation

qsf::ai::reactionrules::GlobalEventStartEnd::GlobalEventStartEnd ( )

Member Function Documentation

virtual void qsf::ai::reactionrules::GlobalEventStartEnd::deserialize ( const boost::property_tree::ptree tree)
virtual
virtual bool qsf::ai::reactionrules::GlobalEventStartEnd::handle ( const EvaluationParameters parameters)
virtual

Implements qsf::ai::ReactionRule.

virtual void qsf::ai::reactionrules::GlobalEventStartEnd::onEventEnd ( const EvaluationParameters parameters,
const PerceptionEvent event 
)
protectedvirtual
virtual bool qsf::ai::reactionrules::GlobalEventStartEnd::onEventStart ( const EvaluationParameters parameters,
const PerceptionEvent event 
)
protectedvirtual
virtual void qsf::ai::reactionrules::GlobalEventStartEnd::serialize ( BinarySerializer serializer)
virtual

Reimplemented from qsf::ai::ReactionRule.

virtual void qsf::ai::reactionrules::GlobalEventStartEnd::serialize ( boost::property_tree::ptree tree) const
virtual

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