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

The factory for creating the GoalCondition. More...

#include <CondGoal.h>

Inheritance diagram for Menge::BFSM::GoalCondFactory:
Menge::BFSM::ConditionFactory Menge::ElementFactory< Condition >

Public Member Functions

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

Protected Member Functions

virtual Conditioninstance () const
 Create an instance of this class's condition. More...
 
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 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 _distanceID
 The identifier for the "distance" float attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< Condition >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

The factory for creating the GoalCondition.

Member Function Documentation

virtual const char* Menge::BFSM::GoalCondFactory::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< Condition >.

virtual Condition* Menge::BFSM::GoalCondFactory::instance ( ) const
inlineprotectedvirtual

Create an instance of this class's condition.

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

Returns
A pointer to a newly instantiated Action class.

Implements Menge::ElementFactory< Condition >.

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

The name of the condition.

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

Returns
A string containing the unique condition name.

Implements Menge::ElementFactory< Condition >.

bool Menge::BFSM::GoalCondFactory::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).

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