The simulator database entry for the Helbing 2000 simulator. More...

#include <HelbingDBEntry.h>

Inheritance diagram for Helbing::DBEntry:

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
SimSystem *	getSimulatorSystem (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)

BaseAgentContext *	getAgentContext (SimSystem *system)

float	simDuration () const

Protected Member Functions
virtual BaseAgentContext *	contextFromSystem (SimSystem *system)
	Returns a pointer to an agent context appropriate to the corresponding simulator. More...

Protected Member Functions inherited from Menge::SimulatorDBEntry
Agents::SimulatorInterface *	initSimulator (const std::string &sceneFileName, bool VERBOSE)

BFSM::FSM *	initFSM (const std::string &behaveFile, Agents::SimulatorInterface *sim, bool VERBOSE)

bool	finalize (Agents::SimulatorInterface sim, BFSM::FSM fsm)

virtual SimSystem *	createSimSystem (bool visualize, float duration)

Additional Inherited Members
Protected Attributes inherited from Menge::SimulatorDBEntry
Agents::SimulatorInterface *	_sim

BFSM::FSM *	_fsm

Detailed Description

The simulator database entry for the Helbing 2000 simulator.

Member Function Documentation

std::string Helbing::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 Helbing::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.

BaseAgentContext * Helbing::DBEntry::contextFromSystem ( SimSystem * system )

protectedvirtual

Returns a pointer to an agent context appropriate to the corresponding simulator.

If the provided system is not, in fact, a pointer to a SimSystem for the appropriate simulator type, this function will report failure. Furthermore, the default implementation is to return a BaseAgentContext. If the simulator comes with a novel context, this function should be overridden in the derived SimulatorDBEntry.

Parameters

system The system which tracks the agents. This should be the same system which was returned by a call to SimulatorDBEntryBase::getSimulatorSystem.