Menge::Agents::BergKDTreeFactory Class Reference

Factory for the BergKDTree. More...

#include <SpatialQueryKDTree.h>

Inheritance diagram for Menge::Agents::BergKDTreeFactory:

Public Member Functions
virtual const char *	name () const
	The name of the spatial query implemenation. More...
virtual const char *	description () const
	A description of the spatial query. More...
Public Member Functions inherited from Menge::Agents::SpatialQueryFactory
	SpatialQueryFactory ()
	Constructor.
Public Member Functions inherited from Menge::ElementFactory< SpatialQuery >
	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...
SpatialQuery *	createInstance (TiXmlElement *node, const std::string &behaveFldr) const
	Parses the xml data. More...

Protected Member Functions
SpatialQuery *	instance () const
	Create an instance of this class's spatial query implementation. More...
Protected Member Functions inherited from Menge::Agents::SpatialQueryFactory
virtual bool	setFromXML (SpatialQuery *sQuery, TiXmlElement *node, const std::string &behaveFldr) const
	Given a pointer to a SpatialQuery instance, sets the appropriate fields from the provided XML node. More...
Protected Member Functions inherited from Menge::ElementFactory< SpatialQuery >
virtual	~ElementFactory ()
	Destructor.
virtual bool	setFromXML (SpatialQuery *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...

Additional Inherited Members
Protected Attributes inherited from Menge::Agents::SpatialQueryFactory
size_t	_testVisID
	The identifier for the "test_visibility" bool attribute.
Protected Attributes inherited from Menge::ElementFactory< SpatialQuery >
AttributeSet	_attrSet
	The attribute set for this factory.

Detailed Description

Factory for the BergKDTree.

Member Function Documentation

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

inlinevirtual

A description of the spatial query.

Each spatial query factory must override this function.

Returns

A string containing the spatial query description.

Implements Menge::ElementFactory< SpatialQuery >.

SpatialQuery* Menge::Agents::BergKDTreeFactory::instance ( ) const

inlineprotectedvirtual

Create an instance of this class's spatial query implementation.

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

Returns

A pointer to a newly instantiated SpatialQuery class.

Implements Menge::ElementFactory< SpatialQuery >.

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

inlinevirtual

The name of the spatial query implemenation.

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

Returns

A string containing the unique spatial query name.

Implements Menge::ElementFactory< SpatialQuery >.

---

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

• src/menge/MengeCore/Agents/SpatialQueries/SpatialQueryKDTree.h