Menge Plugin Examples
A Collection of Example Plugins for the Menge Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Static Protected Attributes | Friends | List of all members
OpenSteer::Simulator Class Reference

The simulator definition for the OpenSteer pedestrian model. More...

#include <OpenSteerSimulator.h>

Inheritance diagram for OpenSteer::Simulator:

Public Member Functions

 Simulator ()
 Constructor.
 
virtual bool hasExpTarget ()
 Reports if there are non-common Experiment parameters that this simulator requires in the XML file. More...
 
virtual bool isExpTarget (const std::string &tagName)
 Reports if the given Experiment attribute tag name belongs to this simulator. More...
 
virtual bool setExpParam (const std::string &paramName, const std::string &value) throw ( Agents::XMLParamException )
 Given an Experiment parameter name and value, sets the appropriate simulator parameter. More...
 

Static Protected Attributes

static float REACTION_TIME = 0.5f
 The reaction time used to define the driving force.
 
static float LEAK_THROUGH = 0.1f
 The probability that a higher priority behavior will be skipped.
 
static float MAX_FORCE = 8.f
 The maximum allowable magnitude for steering forces.
 
static bool USE_ALLOC_PRIORITY = true
 Determines what steering strategy is applied. If true, uses the original 87 Reynold's allocation priority. If false, uses the 99 OpenSteer approach.
 
static float PRIORITY_ALLOCATION = 2.5f * Simulator::MAX_FORCE
 The total amount of allocation used in the 87 priority allocation approach.
 

Friends

class Agent
 

Detailed Description

The simulator definition for the OpenSteer pedestrian model.

Member Function Documentation

virtual bool OpenSteer::Simulator::hasExpTarget ( )
inlinevirtual

Reports if there are non-common Experiment parameters that this simulator requires in the XML file.

Returns
By default, the simulator base ONLY uses common parameters. Always returns false.
virtual bool OpenSteer::Simulator::isExpTarget ( const std::string &  tagName)
inlinevirtual

Reports if the given Experiment attribute tag name belongs to this simulator.

Parameters
tagNamethe name of the considered tag
Returns
By default, the simulator base ONLY uses common parameters. Always returns false.
bool OpenSteer::Simulator::setExpParam ( const std::string &  paramName,
const std::string &  value 
)
throw (Agents::XMLParamException
)
virtual

Given an Experiment parameter name and value, sets the appropriate simulator parameter.

Parameters
paramNameA string containing the parameter name for the experiment.
valueA string containing the value for the parameter.
Returns
whether or not parameters were successfully set

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