The factory for the ConstStateSelector. More...

#include <ConstStateSelector.h>

Inheritance diagram for Menge::Agents::ConstStateSelectorFactory:

Public Member Functions
	ConstStateSelectorFactory ()
	Constructor.

virtual const char *	name () const
	The name of the state selector type. More...

virtual const char *	description () const
	A description of the state selector. More...

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

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

Protected Member Functions
StateSelector *	instance () const
	Create an instance of this class's state selector implementation. More...

virtual bool	setFromXML (StateSelector sel, TiXmlElement node, const std::string &specFldr) const
	Given a pointer to a StateSelector instance, sets the appropriate fields from the provided XML node. More...

Protected Member Functions inherited from Menge::ElementFactory< StateSelector >
virtual	~ElementFactory ()
	Destructor.

virtual bool	setFromXML (StateSelector 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	_nameID
	The identifier for the "name" string parameter.

Protected Attributes inherited from Menge::ElementFactory< StateSelector >
AttributeSet	_attrSet
	The attribute set for this factory.

Detailed Description

The factory for the ConstStateSelector.

Member Function Documentation

virtual const char* Menge::Agents::ConstStateSelectorFactory::description ( ) const

inlinevirtual

A description of the state selector.

Each state selector factory must override this function.

Returns: A string containing the state selector description.

Implements Menge::ElementFactory< StateSelector >.

StateSelector* Menge::Agents::ConstStateSelectorFactory::instance ( ) const

inlineprotectedvirtual

Create an instance of this class's state selector implementation.

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

Returns: A pointer to a newly instantiated StateSelector class.

Implements Menge::ElementFactory< StateSelector >.

virtual const char* Menge::Agents::ConstStateSelectorFactory::name ( ) const

inlinevirtual

The name of the state selector type.

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

Returns: A string containing the unique state selector name.

Implements Menge::ElementFactory< StateSelector >.

bool Menge::Agents::ConstStateSelectorFactory::setFromXML	(	StateSelector *	sel,
		TiXmlElement *	node,
		const std::string &	specFldr
	)		const

protectedvirtual

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

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

Parameters

sel	A pointer to the state selector whose attributes are to be set.
node	The XML node containing the goal attributes.
specFldr	The path to the specification 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:

src/menge/MengeCore/Agents/StateSelectors/ConstStateSelector.h
src/menge/MengeCore/Agents/StateSelectors/ConstStateSelector.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation