The factory for state event triggers. More...

#include <StateEvtTrigger.h>

Inheritance diagram for Menge::StateEvtTriggerFactory:

Public Member Functions
	StateEvtTriggerFactory ()
	Constructor.

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

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

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

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

Protected Attributes
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 state event triggers.

Member Function Documentation

bool Menge::StateEvtTriggerFactory::setFromXML	(	EventTrigger *	trigger,
		TiXmlElement *	node,
		const std::string &	specFldr
	)		const

protectedvirtual

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

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

Parameters

trigger	A pointer to the event trigger whose attributes are to be set.
node	The XML node containing the event trigger attributes.
specFldr	The path to the specification file. If the EventTrigger references resources in the file system, it should be defined relative to the specification file location. This is the folder containing that path.

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

Reimplemented from Menge::ElementFactory< EventTrigger >.

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

src/menge/MengeCore/Agents/Events/StateEvtTrigger.h
src/menge/MengeCore/Agents/Events/StateEvtTrigger.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation