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

The simulator database entry for the PedVO simulator. More...

#include <PedVODBEntry.h>

Inheritance diagram for PedVO::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
Menge::Agents::SimulatorInterface
getNewSimulator ()
 Returns a pointer to this model's Simulator instance. More...
 
virtual
Menge::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)
 Returns a simulator system that can be attached to a SceneGraph::GLScene and advanced by a Viewer. More...
 
void populateScene (SimSystem *system, SceneGraph::GLScene *scene)
 Populates the given GLScene with visualization entities tracked in the system. More...
 
BaseAgentContextgetAgentContext (SimSystem *system)
 Returns a pointer to an agent context appropriate to the corresponding simulator. More...
 
float simDuration () const
 Reports the current run-time of an instantiated simulation. More...
 

Protected Member Functions

virtual Menge::BaseAgentContextcontextFromSystem (Menge::SimSystem *simSystem)
 Returns a pointer to an agent context appropriate to the corresponding simulator. More...
 
- Protected Member Functions inherited from Menge::SimulatorDBEntry
Agents::SimulatorInterfaceinitSimulator (const std::string &sceneFileName, bool VERBOSE)
 Creates the simulator. More...
 
BFSM::FSMinitFSM (const std::string &behaveFile, Agents::SimulatorInterface *sim, bool VERBOSE)
 Creates the finite state machine and finalizes simulator and fsm. More...
 
bool finalize (Agents::SimulatorInterface *sim, BFSM::FSM *fsm)
 Finalizes the finite state machine and simulator in preparation for execution. More...
 
virtual SimSystemcreateSimSystem (bool visualize, float duration)
 Creates an instance of a SimSystem to populate. More...
 

Additional Inherited Members

- Protected Attributes inherited from Menge::SimulatorDBEntry
Agents::SimulatorInterface_sim
 A pointer to the simulator. The database entry is not responsible for deleting it unless there is an error in initialization.
 
BFSM::FSM_fsm
 A pointer to the behavior finite state machine. The database entry is not responsible for deleting it unless there is an error in initialization.
 

Detailed Description

The simulator database entry for the PedVO simulator.

Member Function Documentation

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

Menge::BaseAgentContext * PedVO::DBEntry::contextFromSystem ( Menge::SimSystem simSystem)
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
simSystemThe system which tracks the agents. This should be the same system which was returned by a call to SimulatorDBEntry::getSimulatorSystem.
Returns
A pointer to the appropriate agent context. If the system is of the wrong type (or if there is any other problem), NULL is returned.

Reimplemented from Menge::SimulatorDBEntry.

Menge::Agents::AgentInitializer * PedVO::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.

Menge::Agents::SimulatorInterface * PedVO::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 PedVO::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 PedVO::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: