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

The factory for StatePopIncreaseTrigger event triggers. More...

#include <StateEvtTrigger.h>

Inheritance diagram for Menge::StatePopIncTriggerFactory:
Menge::StateEvtTriggerFactory Menge::EventTriggerFactory Menge::ElementFactory< EventTrigger >

Public Member Functions

virtual const char * name () const
 The name of the trigger type. More...
 
virtual const char * description () const
 A description of the event trigger. More...
 
- Public Member Functions inherited from Menge::StateEvtTriggerFactory
 StateEvtTriggerFactory ()
 Constructor.
 
- Public Member Functions inherited from Menge::ElementFactory< EventTrigger >
 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...
 
EventTriggercreateInstance (TiXmlElement *node, const std::string &behaveFldr) const
 Parses the xml data. More...
 

Protected Member Functions

EventTriggerinstance () const
 Create an instance of this class's event trigger implementation. More...
 
- Protected Member Functions inherited from Menge::StateEvtTriggerFactory
virtual bool setFromXML (EventTrigger *trigger, TiXmlElement *node, const std::string &specFldr) const
 Given a pointer to an EventTrigger instance, sets the appropriate fields from the provided XML node. More...
 
- Protected Member Functions inherited from Menge::ElementFactory< EventTrigger >
virtual ~ElementFactory ()
 Destructor.
 

Additional Inherited Members

- Protected Attributes inherited from Menge::StateEvtTriggerFactory
size_t _stateID
 The identifier for the "state" string attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< EventTrigger >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

The factory for StatePopIncreaseTrigger event triggers.

Member Function Documentation

virtual const char* Menge::StatePopIncTriggerFactory::description ( ) const
inlinevirtual

A description of the event trigger.

Each trigger factory must override this function.

Returns
A string containing the trigger description.

Implements Menge::ElementFactory< EventTrigger >.

EventTrigger* Menge::StatePopIncTriggerFactory::instance ( ) const
inlineprotectedvirtual

Create an instance of this class's event trigger implementation.

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

Returns
A pointer to a newly instantiated EventTrigger class.

Implements Menge::ElementFactory< EventTrigger >.

virtual const char* Menge::StatePopIncTriggerFactory::name ( ) const
inlinevirtual

The name of the trigger type.

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

Returns
A string containing the unique trigger name.

Implements Menge::ElementFactory< EventTrigger >.


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