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 | List of all members
Johansson::DBEntry Class Reference

The simulator database entry for the Johansson 2007 simulator. More...

#include <JohanssonDBEntry.h>

Inheritance diagram for Johansson::DBEntry:
Menge::SimulatorDBEntry

Public Member Functions

virtual ::std::string briefDescription () const
 Gives a brief description of the simulator. More...
 
virtual ::std::string longDescription () const
 Gives a long description of the simulator. More...
 
virtual ::std::string viewerName () const
 Gives a label to apply to the interactive viewer. More...
 
virtual ::std::string commandLineName () const
 Gives a unique name to be used as a command-line parameter. More...
 
virtual
Agents::SimulatorInterface * 
getNewSimulator ()
 Returns a pointer to this model's Simulator instance. More...
 
virtual Agents::AgentInitializer * getAgentInitalizer () const
 Provides an AgentInitializer appropriate to this simulator class. More...
 
- Public Member Functions inherited from Menge::SimulatorDBEntry
SimSystemgetSimulatorSystem (size_t &agentCount, float &simTimeStep, size_t subSteps, float simDuration, const std::string &behaveFile, const std::string &sceneFile, const std::string &outFile, const std::string &scbVersion, bool visualize, bool VERBOSE)
 
void populateScene (SimSystem *system, SceneGraph::GLScene *scene)
 
BaseAgentContextgetAgentContext (SimSystem *system)
 
float simDuration () const
 

Additional Inherited Members

- Protected Member Functions inherited from Menge::SimulatorDBEntry
virtual BaseAgentContextcontextFromSystem (SimSystem *simSystem)
 
Agents::SimulatorInterfaceinitSimulator (const std::string &sceneFileName, bool VERBOSE)
 
BFSM::FSMinitFSM (const std::string &behaveFile, Agents::SimulatorInterface *sim, bool VERBOSE)
 
bool finalize (Agents::SimulatorInterface *sim, BFSM::FSM *fsm)
 
virtual SimSystemcreateSimSystem (bool visualize, float duration)
 
- Protected Attributes inherited from Menge::SimulatorDBEntry
Agents::SimulatorInterface_sim
 
BFSM::FSM_fsm
 

Detailed Description

The simulator database entry for the Johansson 2007 simulator.

Member Function Documentation

std::string Johansson::DBEntry::briefDescription ( ) const
virtual

Gives a brief description of the simulator.

Returns
A brief description of the simulator and pedestrian model.

Implements Menge::SimulatorDBEntry.

virtual ::std::string Johansson::DBEntry::commandLineName ( ) const
inlinevirtual

Gives a unique name to be used as a command-line parameter.

This name MUST satisfy two constraints:

  • It must contain no spaces.
  • It must be unique from that used by all other simulators.
Returns
A single string (with no spaces) that can be used as a command line parameter to uniquely identify this model.

Implements Menge::SimulatorDBEntry.

Agents::AgentInitializer * Johansson::DBEntry::getAgentInitalizer ( ) const
virtual

Provides an AgentInitializer appropriate to this simulator class.

Returns
A pointer to an agent initializer. The caller is responsible for freeing up the memory.

Reimplemented from Menge::SimulatorDBEntry.

Agents::SimulatorInterface * Johansson::DBEntry::getNewSimulator ( )
virtual

Returns a pointer to this model's Simulator instance.

This must be overridden by a derived class

Returns
A newly instantiated simulator instance of a type appropriate for this database entry.

Implements Menge::SimulatorDBEntry.

std::string Johansson::DBEntry::longDescription ( ) const
virtual

Gives a long description of the simulator.

Returns
A long description of the simulator and pedestrian model.

Implements Menge::SimulatorDBEntry.

std::string Johansson::DBEntry::viewerName ( ) const
virtual

Gives a label to apply to the interactive viewer.

Returns
The name for display on the interactive viewer.

Implements Menge::SimulatorDBEntry.


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