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

Modifies the agent's obstacle set by SETTING the given obstacle set value (i.e. overriding the old value with the new). More...

#include <ObstacleAction.h>

Inheritance diagram for Menge::BFSM::SetObstacleSetAction:
Menge::BFSM::ObstacleAction Menge::BFSM::Action Menge::Element

Public Member Functions

virtual size_t newValue (size_t value)
 Computes the new property value given the original property value. More...
 
- Public Member Functions inherited from Menge::BFSM::ObstacleAction
 ObstacleAction ()
 Constructor.
 
virtual ~ObstacleAction ()
 Virtual destructor.
 
virtual void onEnter (Agents::BaseAgent *agent)
 Upon entering the state, this is called – it is the main work of the action. More...
 
- Public Member Functions inherited from Menge::BFSM::Action
 Action ()
 Constructor.
 
void onLeave (Agents::BaseAgent *agent)
 The work to do upon state exit. More...
 
- 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...
 

Additional Inherited Members

- Protected Member Functions inherited from Menge::BFSM::ObstacleAction
virtual void leaveAction (Agents::BaseAgent *agent)
 The work to do upon state exit. More...
 
- Protected Member Functions inherited from Menge::BFSM::Action
virtual ~Action ()
 Virtual destructor.
 
- Protected Attributes inherited from Menge::BFSM::ObstacleAction
size_t _setOperand
 The set operand to apply to the agents obstacle set.
 
std::map< size_t, size_t > _originalMap
 A mapping from agent id to the agent's obstacle set value before the action was applied.
 
SimpleLock _lock
 Lock for guaranteeing thread-safety.
 
- Protected Attributes inherited from Menge::BFSM::Action
bool _undoOnExit
 Determines if the action undoes itself on exiting the state.
 

Detailed Description

Modifies the agent's obstacle set by SETTING the given obstacle set value (i.e. overriding the old value with the new).

Member Function Documentation

size_t Menge::BFSM::SetObstacleSetAction::newValue ( size_t  value)
virtual

Computes the new property value given the original property value.

Parameters
valueThe original obstacle set value.
Returns
The new value.

Implements Menge::BFSM::ObstacleAction.


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