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::BFSM::NearestGoalSelectorFactory Class Reference

Factory for the NearestGoalSelector. More...

#include <GoalSelectorNearest.h>

Inheritance diagram for Menge::BFSM::NearestGoalSelectorFactory:
Menge::BFSM::SetGoalSelectorFactory Menge::BFSM::GoalSelectorFactory Menge::ElementFactory< GoalSelector >

Public Member Functions

virtual const char * name () const
 The name of the goal selector type. More...
 
virtual const char * description () const
 A description of the goal selector. More...
 
- Public Member Functions inherited from Menge::BFSM::SetGoalSelectorFactory
 SetGoalSelectorFactory ()
 Constructor.
 
- Public Member Functions inherited from Menge::BFSM::GoalSelectorFactory
 GoalSelectorFactory ()
 Constructor.
 
- Public Member Functions inherited from Menge::ElementFactory< GoalSelector >
 ElementFactory ()
 Default constructor.
 
void destroy ()
 This supplants the destructor. More...
 
bool thisFactory (const std::string &typeName) const
 Reports if the xml node defines an element for this factory. More...
 
GoalSelector * createInstance (TiXmlElement *node, const std::string &behaveFldr) const
 Parses the xml data. More...
 

Protected Member Functions

GoalSelectorinstance () const
 Create an instance of this class's goal selector. More...
 
- Protected Member Functions inherited from Menge::BFSM::SetGoalSelectorFactory
virtual bool setFromXML (GoalSelector *selector, TiXmlElement *node, const std::string &behaveFldr) const
 Given a pointer to a GoalSelector instance, sets the appropriate fields from the provided XML node. More...
 
- Protected Member Functions inherited from Menge::ElementFactory< GoalSelector >
virtual ~ElementFactory ()
 Destructor.
 
virtual bool setFromXML (GoalSelector *element, TiXmlElement *node, const std::string &specFldr) const
 Given a pointer to an element instance, sets the appropriate fields from the provided XML node. More...
 

Additional Inherited Members

- Protected Attributes inherited from Menge::BFSM::SetGoalSelectorFactory
size_t _goalSetID
 The identifier for the "goal_set" size_t attribute.
 
- Protected Attributes inherited from Menge::BFSM::GoalSelectorFactory
size_t _persistentID
 The identifier for the "persistent" bool attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< GoalSelector >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

Factory for the NearestGoalSelector.

Member Function Documentation

virtual const char* Menge::BFSM::NearestGoalSelectorFactory::description ( ) const
inlinevirtual

A description of the goal selector.

Each goal selector factory must override this function.

Returns
A string containing the goal selector description.

Implements Menge::ElementFactory< GoalSelector >.

GoalSelector* Menge::BFSM::NearestGoalSelectorFactory::instance ( ) const
inlineprotectedvirtual

Create an instance of this class's goal selector.

Returns
A pointer to a newly instantiated GoalSelector class.

Implements Menge::ElementFactory< GoalSelector >.

virtual const char* Menge::BFSM::NearestGoalSelectorFactory::name ( ) const
inlinevirtual

The name of the goal selector type.

The goal selector's name must be unique among all registered goal selectors. Each goal selector factory must override this function.

Returns
A string containing the unique goal selector name.

Implements Menge::ElementFactory< GoalSelector >.


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