dtCore::CollectorUtil Namespace Reference

Classes
struct	GetElementType
	Template Function that is used to get the RefPtr's Element type from the map. More...
Functions
template<class mapType>
bool	AddNode (const std::string &nodeName, typename GetElementType< mapType >::value_type *nodeType, mapType &nodeMap)
	Template function that is used to Add a unique node or object to its respective map.
template<class mapType>
bool	RemoveNode (const std::string &nodeName, mapType &nodeMap)
	Template function that is used to Remove a unique node or object from its respective map.
template<class mapType>
const GetElementType< mapType > ::value_type *	FindNodePointer (const std::string &nodeName, const mapType &nodeMap)
	Template function that is used to find a node or object that is inside a map.
template<class mapType>
GetElementType< mapType > ::value_type *	FindNodePointer (const std::string &nodeName, mapType &nodeMap)
	Template function that is used to find a node or object that is inside a map.

---

Function Documentation

template<class mapType>

bool dtCore::CollectorUtil::AddNode	(	const std::string &	nodeName,
		typename GetElementType< mapType >::value_type *	nodeType,
		mapType &	nodeMap
	)			[inline]

Template function that is used to Add a unique node or object to its respective map.

Parameters:

	nodeName	The name of the Node or Object that is being added to its map
	nodeType	The address of the node or object that you wish to add to its map
	nodeMap	The map that you want to add the node or object to

Returns:

Will return true if the node / object was added; otherwise false will be returned

template<class mapType>

GetElementType<mapType>::value_type* dtCore::CollectorUtil::FindNodePointer	(	const std::string &	nodeName,
		mapType &	nodeMap
	)			[inline]

Template function that is used to find a node or object that is inside a map.

Parameters:

	nodeName	The name of the Node or Object that you wish to find
	nodeMap	The map that you wish to search for the Node / Object

Returns:

Will return a const pointer to the node or object that you were looking for if it is in the map. Otherwise it will return null.

template<class mapType>

const GetElementType<mapType>::value_type* dtCore::CollectorUtil::FindNodePointer	(	const std::string &	nodeName,
		const mapType &	nodeMap
	)			[inline]

Template function that is used to find a node or object that is inside a map.

Parameters:

	nodeName	The name of the Node or Object that you wish to find
	nodeMap	The map that you wish to search for the Node / Object

Returns:

Will return a const pointer to a node or object that you were looking for if it is in the map. Otherwise it will return null.

template<class mapType>

bool dtCore::CollectorUtil::RemoveNode	(	const std::string &	nodeName,
		mapType &	nodeMap
	)			[inline]

Template function that is used to Remove a unique node or object from its respective map.

Parameters:

	nodeName	The name of the Node or Object that is being removed from its map
	nodeMap	The map that you want to remove the node or object from

Returns:

Will return true if the node / object was found AND removed; otherwise false will be returned

---