ObjectRegistry< T, Key > Class Template Reference

#include <ObjectRegistry.h>

Public Types
typedef std::map< Key, T * >	RegistryMapType

Public Member Functions
const T *	GetRegistryItem (Key key) const
	Returns a registry item. More...
bool	InsertItem (T *obj, Key key, bool _override=false)
	Inserts a registry item. More...
void	RemoveItem (Key key, bool delete_object=true)
	Removes a registry item. More...
bool	HasItem (Key key) const
	Returns true if registry contains an item. More...
unsigned int	GetRegisteredItems (std::vector< Key > &l) const
	Inefficiently return a vector of registered items. More...
RegistryMapType const &	GetRegisteredItems () const
	Return the map of registered items. More...
	ObjectRegistry ()
	~ObjectRegistry ()

Static Public Member Functions
static ObjectRegistry< T, Key > *	instance ()

Private Attributes
RegistryMapType	i_registeredObjects

Detailed Description

template<class T, class Key = std::string>
class ObjectRegistry< T, Key >

ObjectRegistry holds all registry item of the same type

Member Typedef Documentation

template<class T, class Key = std::string>

typedef std::map<Key, T*> ObjectRegistry< T, Key >::RegistryMapType

Constructor & Destructor Documentation

template<class T, class Key = std::string>

ObjectRegistry< T, Key >::ObjectRegistry ( )

inline

{ }

template<class T, class Key = std::string>

ObjectRegistry< T, Key >::~ObjectRegistry ( )

inline

 {
 for (typename RegistryMapType::iterator iter=i_registeredObjects.begin(); iter != i_registeredObjects.end(); ++iter)
 delete iter->second;
 i_registeredObjects.clear();
 }

Member Function Documentation

template<class T, class Key = std::string>

unsigned int ObjectRegistry< T, Key >::GetRegisteredItems ( std::vector< Key > &  l ) const

inline

Inefficiently return a vector of registered items.

 {
 unsigned int sz = l.size();
 l.resize(sz + i_registeredObjects.size());
 for (typename RegistryMapType::const_iterator iter = i_registeredObjects.begin(); iter != i_registeredObjects.end(); ++iter)
 l[sz++] = iter->first;
 return i_registeredObjects.size();
 }

template<class T, class Key = std::string>

RegistryMapType const& ObjectRegistry< T, Key >::GetRegisteredItems ( ) const

inline

Return the map of registered items.

 {
 return i_registeredObjects;
 }

template<class T, class Key = std::string>

const T* ObjectRegistry< T, Key >::GetRegistryItem ( Key  key ) const

inline

Returns a registry item.

 {
 typename RegistryMapType::const_iterator iter = i_registeredObjects.find(key);
 return( iter == i_registeredObjects.end() ? NULL : iter->second );
 }

template<class T, class Key = std::string>

bool ObjectRegistry< T, Key >::HasItem ( Key  key ) const

inline

Returns true if registry contains an item.

 {
 return (i_registeredObjects.find(key) != i_registeredObjects.end());
 }

template<class T, class Key = std::string>

bool ObjectRegistry< T, Key >::InsertItem ( T *  obj, Key  key, bool  _override = false  )

inline

Inserts a registry item.

 {
 typename RegistryMapType::iterator iter = i_registeredObjects.find(key);
 if ( iter != i_registeredObjects.end() )
 {
 if ( !_override )
 return false;
 delete iter->second;
 i_registeredObjects.erase(iter);
 }

 i_registeredObjects[key] = obj;
 return true;
 }

template<class T, class Key = std::string>

static ObjectRegistry<T, Key>* ObjectRegistry< T, Key >::instance ( )

inlinestatic

 {
 static ObjectRegistry<T, Key> instance;
 return &instance;
 }

Here is the caller graph for this function:

template<class T, class Key = std::string>

void ObjectRegistry< T, Key >::RemoveItem ( Key  key, bool  delete_object = true  )

inline

Removes a registry item.

 {
 typename RegistryMapType::iterator iter = i_registeredObjects.find(key);
 if ( iter != i_registeredObjects.end() )
 {
 if ( delete_object )
 delete iter->second;
 i_registeredObjects.erase(iter);
 }
 }

Member Data Documentation

template<class T, class Key = std::string>

RegistryMapType ObjectRegistry< T, Key >::i_registeredObjects

private

---

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

• src/server/shared/Dynamic/ObjectRegistry.h