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 Attributes | Friends | List of all members
Menge::NamedStateMemberTarget Class Reference

Defines the target of an event effect based on membership relationship to a single named state. More...

#include <StateMemberTarget.h>

Inheritance diagram for Menge::NamedStateMemberTarget:
Menge::AgentEventTarget Menge::EventTarget Menge::Element

Public Member Functions

 NamedStateMemberTarget ()
 Default constructor.
 
virtual void finalize ()
 Allows the event target to finish initializing itself from its parsed state to its running state. More...
 
virtual void update ()
 Gives the target a chance to update its knowledge of the target entities. More...
 
- Public Member Functions inherited from Menge::AgentEventTarget
std::vector< Agents::BaseAgent * >
::iterator 
begin ()
 Returns an iterator to the beginning of the target's elements.
 
std::vector< Agents::BaseAgent * >
::iterator 
end ()
 Returns an iterator to the end of the target's elements.
 
- Public Member Functions inherited from Menge::EventTarget
 EventTarget ()
 Constructor.
 
- 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 Attributes

std::string _stateName
 The name of the state to operate on.
 
BFSM::State_state
 The state to operate on.
 
bool _inState
 Deterimines if membership in the specified state (true) or non-membership (false) makes an agent a target.
 
- Protected Attributes inherited from Menge::AgentEventTarget
std::vector< Agents::BaseAgent * > _elements
 The agents targeted by the event effect.
 
- Protected Attributes inherited from Menge::EventTarget
float _lastUpdate
 The global time that the target was last updated.
 

Friends

class NamedStateMemberTargetFactory
 

Detailed Description

Defines the target of an event effect based on membership relationship to a single named state.

Member Function Documentation

void Menge::NamedStateMemberTarget::finalize ( )
virtual

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

Exceptions
EventExceptionif there is a problem finalizing.

Reimplemented from Menge::EventTarget.

void Menge::NamedStateMemberTarget::update ( )
virtual

Gives the target a chance to update its knowledge of the target entities.

If a sub-class needs to do particular computation to evaluate the target, it should be implemented here.

Reimplemented from Menge::EventTarget.


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