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
GCF::Simulator Class Reference

Defines the simulator operating on a GCF::Agent. More...

#include <GCFSimulator.h>

Inheritance diagram for GCF::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 NU_AGENT = 0.3f
 The agent force strenth coefficient (nu)
 
static float MAX_AGENT_DIST = 3.f
 The maximum EFFECTIVE distance between agents at which any force can be generated.
 
static float MAX_AGENT_FORCE = 2.f
 The maximum force applied by an agent.
 
static float AGENT_INTERP_WIDTH = 0.1f
 The distance over which agent forces are interpolated.
 

Friends

class Agent
 

Detailed Description

Defines the simulator operating on a GCF::Agent.

Member Function Documentation

virtual bool GCF::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 GCF::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 GCF::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: