The factory for agent property event effects. More...

#include <AgentPropertyEffect.h>

Inheritance diagram for Menge::AgentPropertyEffectFactory< Manipulator >:

Public Member Functions
	AgentPropertyEffectFactory ()
	Constructor.

Public Member Functions inherited from Menge::ElementFactory< EventEffect >
	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...

EventEffect *	createInstance (TiXmlElement *node, const std::string &behaveFldr) const
	Parses the xml data. More...

Protected Member Functions
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.

virtual EventEffect *	instance () const =0
	Create an instance of this class's condition. More...

Protected Attributes
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

template<class Manipulator>
class Menge::AgentPropertyEffectFactory< Manipulator >

The factory for agent property event effects.

Member Function Documentation

template<class Manipulator>

virtual bool Menge::AgentPropertyEffectFactory< Manipulator >::setFromXML	(	EventEffect *	effect,
		TiXmlElement *	node,
		const std::string &	behaveFldr
	)		const

inlineprotectedvirtual

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

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

Parameters

effect	A pointer to the effect whose attributes are to be set.
node	The XML node containing the event effect 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.

Returns: A boolean reporting success (true) or failure (false).

Reimplemented from Menge::ElementFactory< EventEffect >.

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

src/menge/MengeCore/Agents/Events/AgentPropertyEffect.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class Manipulator> class Menge::AgentPropertyEffectFactory< Manipulator >

Member Function Documentation

template<class Manipulator>
class Menge::AgentPropertyEffectFactory< Manipulator >