The factory for the ConstProfileSelector. More...

#include <ConstProfileSelector.h>

Inheritance diagram for Menge::Agents::ConstProfileSelectorFactory:

Public Member Functions
	ConstProfileSelectorFactory ()
	Constructor.

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

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

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

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

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

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

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

virtual bool	setFromXML (ProfileSelector 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< ProfileSelector >
AttributeSet	_attrSet
	The attribute set for this factory.

Detailed Description

The factory for the ConstProfileSelector.

Member Function Documentation

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

inlinevirtual

A description of the profile selector.

Each profile selector factory must override this function.

Returns: A string containing the profile selector description.

Implements Menge::ElementFactory< ProfileSelector >.

ProfileSelector* Menge::Agents::ConstProfileSelectorFactory::instance ( ) const

inlineprotectedvirtual

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

All ProfileSelectorFactory 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 ProfileSelectorFactory::setFromXML. The caller of this function takes ownership of the memory.

Returns: A pointer to a newly instantiated ProfileSelector class.

Implements Menge::ElementFactory< ProfileSelector >.

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

inlinevirtual

The name of the profile selector type.

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

Returns: A string containing the unique profile selector name.

Implements Menge::ElementFactory< ProfileSelector >.

bool Menge::Agents::ConstProfileSelectorFactory::setFromXML	(	ProfileSelector *	pSel,
		TiXmlElement *	node,
		const std::string &	specFldr
	)		const

protectedvirtual

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

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

Parameters

pSel	A pointer to the profile 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/ProfileSelectors/ConstProfileSelector.h
src/menge/MengeCore/Agents/ProfileSelectors/ConstProfileSelector.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation