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

Factory for the OffsetPropertyEffect. More...

#include <AgentPropertyEffect.h>

Inheritance diagram for Menge::OffsetAgentPropertyEffectFactory:
Menge::AgentPropertyEffectFactory< OffsetPropertyManipulator > Menge::EventEffectFactory Menge::ElementFactory< EventEffect >

Public Member Functions

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

Protected Member Functions

EventEffectinstance () const
 Create an instance of this class's effect. More...
 
- Protected Member Functions inherited from Menge::AgentPropertyEffectFactory< OffsetPropertyManipulator >
virtual bool setFromXML (EventEffect *effect, TiXmlElement *node, const std::string &behaveFldr) const
 Given a pointer to an AgentPropertyEffect instance, sets the appropriate fields from the provided XML node. More...
 
- Protected Member Functions inherited from Menge::ElementFactory< EventEffect >
virtual ~ElementFactory ()
 Destructor.
 

Additional Inherited Members

- Protected Attributes inherited from Menge::AgentPropertyEffectFactory< OffsetPropertyManipulator >
size_t _propertyID
 The identifier for the "property" string attribute.
 
size_t _generatorID
 The identifier for the float distribution attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< EventEffect >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

Factory for the OffsetPropertyEffect.

Member Function Documentation

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

A description of the effect.

Each effect factory must override this function.

Returns
A string containing the effect description.

Implements Menge::ElementFactory< EventEffect >.

EventEffect* Menge::OffsetAgentPropertyEffectFactory::instance ( ) const
inlineprotectedvirtual

Create an instance of this class's effect.

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

Returns
A pointer to a newly instantiated EventEffect class.

Implements Menge::ElementFactory< EventEffect >.

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

The name of the effect.

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

Returns
A string containing the unique effect name.

Implements Menge::ElementFactory< EventEffect >.


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