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

The factory for creating the SpaceCondition. More...

#include <CondSpace.h>

Inheritance diagram for Menge::BFSM::SpaceCondFactory:
Menge::BFSM::ConditionFactory Menge::ElementFactory< Condition > Menge::BFSM::AABBCondFactory Menge::BFSM::CircleCondFactory Menge::BFSM::OBBCondFactory

Public Member Functions

 SpaceCondFactory ()
 Constructor.
 
- Public Member Functions inherited from Menge::ElementFactory< Condition >
 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...
 
Condition * createInstance (TiXmlElement *node, const std::string &behaveFldr) const
 Parses the xml data. More...
 

Protected Member Functions

virtual bool setFromXML (Condition *condition, TiXmlElement *node, const std::string &behaveFldr) const
 Given a pointer to an Condition instance, sets the appropriate fields from the provided XML node. More...
 
- Protected Member Functions inherited from Menge::ElementFactory< Condition >
virtual ~ElementFactory ()
 Destructor.
 
virtual Condition * instance () const =0
 Create an instance of this class's condition. More...
 
virtual bool setFromXML (Condition *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 _insideID
 The identifier for the "inside" bool attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< Condition >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

The factory for creating the SpaceCondition.

Member Function Documentation

bool Menge::BFSM::SpaceCondFactory::setFromXML ( Condition condition,
TiXmlElement *  node,
const std::string &  behaveFldr 
) const
protectedvirtual

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

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

Parameters
conditionA pointer to the condition whose attributes are to be set.
nodeThe XML node containing the condition attributes.
behaveFldrThe path to the behavior file. If the condition 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 in Menge::BFSM::OBBCondFactory, Menge::BFSM::AABBCondFactory, and Menge::BFSM::CircleCondFactory.


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