Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Menge::StatePopIncreaseTrigger Class Reference

A trigger that fires off when a state's population increases. More...

#include <StateEvtTrigger.h>

Inheritance diagram for Menge::StatePopIncreaseTrigger:
Menge::StateEvtTrigger Menge::EventTrigger Menge::Element

Public Member Functions

 StatePopIncreaseTrigger ()
 Constructor.
 
virtual void finalize ()
 Allows the trigger to finish initializing itself from its parsed state to its running state. More...
 
- Public Member Functions inherited from Menge::StateEvtTrigger
 StateEvtTrigger ()
 Constructor.
 
- Public Member Functions inherited from Menge::EventTrigger
 EventTrigger ()
 Constructor.
 
bool conditionMet ()
 Evaluates the condition to see if it has been met. More...
 
void fired ()
 Informs the trigger that the associated event effects have been applied (i.e. the event has been fired).
 
- Public Member Functions inherited from Menge::Element
void destroy ()
 This supplants the destructor. More...
 
virtual BFSM::TaskgetTask ()
 Return an optional task associated with this element. More...
 
virtual SceneGraph::GLNodegetSGNode ()
 Returns an optional visualization element associated with the element. More...
 

Protected Member Functions

virtual bool testCondition ()
 Evaluates the condition to see if it has been met. More...
 

Protected Attributes

size_t _lastPop
 The population last time the state was examined.
 
- Protected Attributes inherited from Menge::StateEvtTrigger
std::string _stateName
 The name of the state.
 
BFSM::State_state
 The state to operate on.
 
- Protected Attributes inherited from Menge::EventTrigger
float _firePeriod
 The minimum time between two successive firings (in simulation seconds).
 
float _lastFire
 The time of the last firing (global simulation time).
 

Detailed Description

A trigger that fires off when a state's population increases.

Member Function Documentation

void Menge::StatePopIncreaseTrigger::finalize ( )
virtual

Allows the trigger to finish initializing itself from its parsed state to its running state.

Exceptions
EventExceptionif there is a problem finalizing.

Reimplemented from Menge::StateEvtTrigger.

bool Menge::StatePopIncreaseTrigger::testCondition ( )
protectedvirtual

Evaluates the condition to see if it has been met.

This must be implemented by all sub-classes.

Returns
True if the condition has been met, false otherwise.

Implements Menge::EventTrigger.


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