Menge
Modular Pedestrian Simulation Framework for Research and Development
|
Factory for the TeleportAction. More...
#include <TeleportAction.h>
Public Member Functions | |
TeleportActFactory () | |
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::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 | |
Action * | instance () const |
Create an instance of this class's action. More... | |
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... | |
Protected Attributes | |
size_t | _2DGoalID |
The identifier for the "exit_reset" boolean 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. | |
Factory for the TeleportAction.
|
inlinevirtual |
A description of the action.
Each action factory must override this function.
Implements Menge::ElementFactory< Action >.
|
protectedvirtual |
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.
Implements Menge::ElementFactory< Action >.
|
inlinevirtual |
The name of the action.
The action's name must be unique among all registered actions. Each action factory must override this function.
Implements Menge::ElementFactory< Action >.
|
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.
action | A pointer to the action whose attributes are to be set. |
node | The XML node containing the action attributes. |
behaveFldr | The 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. |
Reimplemented from Menge::BFSM::ActionFactory.