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::AddObstacleyActFactory Class Reference

Factory for the ObstacleActFactory. More...

#include <ObstacleAction.h>

Inheritance diagram for Menge::BFSM::AddObstacleyActFactory:
Menge::BFSM::ObstacleActFactory Menge::BFSM::ActionFactory Menge::ElementFactory< Action >

Public Member Functions

 AddObstacleyActFactory ()
 Constructor.
 
virtual const char * name () const
 The name of the action. More...
 
virtual const char * description () const
 A description of the action. More...
 
- Public Member Functions inherited from Menge::BFSM::ObstacleActFactory
 ObstacleActFactory ()
 Constructor.
 
- Public Member Functions inherited from Menge::BFSM::ActionFactory
 ActionFactory ()
 Constructor.
 
- Public Member Functions inherited from Menge::ElementFactory< Action >
 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...
 
Action * createInstance (TiXmlElement *node, const std::string &behaveFldr) const
 Parses the xml data. More...
 

Protected Member Functions

Actioninstance () const
 Create an instance of this class's action. More...
 
- Protected Member Functions inherited from Menge::BFSM::ObstacleActFactory
virtual bool setFromXML (Action *action, TiXmlElement *node, const std::string &behaveFldr) const
 Given a pointer to an Action instance, sets the appropriate fields from the provided XML node. More...
 
- Protected Member Functions inherited from Menge::ElementFactory< Action >
virtual ~ElementFactory ()
 Destructor.
 
virtual bool setFromXML (Action *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::ObstacleActFactory
size_t _operandID
 The identifier for the "operand" size_t attribute.
 
- Protected Attributes inherited from Menge::BFSM::ActionFactory
size_t _exitResetID
 The identifier for the "exit_reset" boolean attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< Action >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

Factory for the ObstacleActFactory.

Member Function Documentation

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

A description of the action.

Each action factory must override this function.

Returns
A string containing the action description.

Implements Menge::ElementFactory< Action >.

Action* Menge::BFSM::AddObstacleyActFactory::instance ( ) const
inlineprotectedvirtual

Create an instance of this class's action.

All ActionFactory sub-classes must override this by creating (on the heap) a new instance of its corresponding action type. The various field values of the instance will be set in a subsequent call to ActionFactory::setFromXML. The caller of this function takes ownership of the memory.

Returns
A pointer to a newly instantiated Action class.

Implements Menge::ElementFactory< Action >.

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

The name of the action.

The action's name must be unique among all registered actions. Each action factory must override this function.

Returns
A string containing the unique action name.

Implements Menge::ElementFactory< Action >.


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