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
Menge::Agents::ProfileSelector Class Referenceabstract

The base class for agent profile assignment strategies. More...

#include <ProfileSelector.h>

Inheritance diagram for Menge::Agents::ProfileSelector:
Menge::Element Menge::Agents::ConstProfileSelector

Public Member Functions

 ProfileSelector ()
 Constructor.
 
virtual AgentInitializergetProfile () const =0
 Select an agent profile based on internal mechanisms. More...
 
virtual bool cacheProfiles (HASH_MAP< std::string, AgentInitializer * > profiles)=0
 Caches the agent initializers defined in the specification. More...
 
- Public Member Functions inherited from Menge::Element
void destroy ()
 This supplants the destructor. More...
 
virtual BFSM::TaskgetTask ()
 Return an optional task associated with this element. More...
 
virtual SceneGraph::GLNodegetSGNode ()
 Returns an optional visualization element associated with the element. More...
 

Protected Member Functions

virtual ~ProfileSelector ()
 Virtual destructor.
 

Detailed Description

The base class for agent profile assignment strategies.

This is an abstract class, primarily defining the mechanism for selecting an agent profile to assign to a newly created agent.

Member Function Documentation

virtual bool Menge::Agents::ProfileSelector::cacheProfiles ( HASH_MAP< std::string, AgentInitializer * >  profiles)
pure virtual

Caches the agent initializers defined in the specification.

Although the ProfileSelector can cache pointers to the profiles for internal convenience, it does not own the memory and should not delete them.

Parameters
profilesA mapping from profile name to initializer.
Returns
True if successful, false otherwise.

Implemented in Menge::Agents::ConstProfileSelector.

virtual AgentInitializer* Menge::Agents::ProfileSelector::getProfile ( ) const
pure virtual

Select an agent profile based on internal mechanisms.

Returns
A const pointer to an agent initializer.

Implemented in Menge::Agents::ConstProfileSelector.


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