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 | Protected Attributes | List of all members
Menge::BFSM::ObstacleActFactory Class Reference

Factory for the ObstacleAction. More...

#include <ObstacleAction.h>

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

Public Member Functions

 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...
 
virtual const char * name () const =0
 The name of the action. More...
 
virtual const char * description () const =0
 A description of the action. 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

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 Action * instance () const =0
 Create an instance of this class's condition. More...
 
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...
 

Protected Attributes

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 ObstacleAction.

This is still an abstract class because it doesn't define the name or description. Nor does it define instance.

Member Function Documentation

bool Menge::BFSM::ObstacleActFactory::setFromXML ( Action action,
TiXmlElement *  node,
const std::string &  behaveFldr 
) const
protectedvirtual

Given a pointer to an Action instance, sets the appropriate fields from the provided XML node.

It is assumed that the value of the type attribute is this Action's type. (i.e. ActionFactory::thisFactory has already been called and returned true.) If sub-classes of ActionFactory introduce new Action parameters, then the sub-class should override this method but explicitly call the parent class's version.

Parameters
actionA pointer to the action whose attributes are to be set.
nodeThe XML node containing the action attributes.
behaveFldrThe path to the behavior file. If the action references resources in the file system, it should be defined relative to the behavior file location. This is the folder containing that path.
Returns
A boolean reporting success (true) or failure (false).

Reimplemented from Menge::BFSM::ActionFactory.


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