ResourcePack< T > Class Template Reference

Inheritance diagram for ResourcePack< T >:

[legend]Collaboration diagram for ResourcePack< T >:

[legend]

---

Detailed Description

template<class T>
class ResourcePack< T >

Share resources.

Definition at line 17 of file ResourcePack.h.

Public Types
typedef std::vector< T >	t_range
Public Member Functions
virtual	~ResourcePack ()
void	removeAll ()
	Free all resources.
void	removeRes (const std::string &name)
	Unload all resources with this name.
void	addRes (const std::string &name, T res)
	Store resource under this name.
T	getRes (const std::string &name, int rank=0)
	Get resource with this name.
t_range	getRange (const std::string &name)
	Get all resources with this name.
T	getRandomRes (const std::string &name)
	Get resource at random index or return NULL.
int	countRes (const std::string &name)
	Count resources with this name.
std::string	toString () const
Protected Types
typedef std::multimap< std::string, T >	t_reses
typedef t_reses::iterator	t_resIterator
typedef t_reses::const_iterator	t_constIterator
Protected Member Functions
virtual void	unloadRes (T res)=0
Protected Attributes
t_reses	m_reses

---

Member Typedef Documentation

template<class T> typedef t_reses::const_iterator ResourcePack< T >::t_constIterator [protected]

Definition at line 23 of file ResourcePack.h.

template<class T> typedef std::vector<T> ResourcePack< T >::t_range

Definition at line 19 of file ResourcePack.h.

template<class T> typedef std::multimap<std::string,T> ResourcePack< T >::t_reses [protected]

Definition at line 21 of file ResourcePack.h.

template<class T> typedef t_reses::iterator ResourcePack< T >::t_resIterator [protected]

Definition at line 22 of file ResourcePack.h.

---

Constructor & Destructor Documentation

template<class T> virtual ResourcePack< T >::~ResourcePack (   )  [inline, virtual]

Definition at line 30 of file ResourcePack.h. { if (!m_reses.empty()) { LOG_WARNING(ExInfo("resources are not released") .addInfo("pack", toString())); } }

---

Member Function Documentation

template<class T> void ResourcePack< T >::addRes (  const std::string &  name, T  res )  [inline]

Store resource under this name. Definition at line 71 of file ResourcePack.h. { m_reses.insert( std::pair<std::string,T>(name, res)); }

template<class T> int ResourcePack< T >::countRes (  const std::string &  name  )  [inline]

Count resources with this name. Definition at line 134 of file ResourcePack.h. { return m_reses.count(name); }

template<class T> T ResourcePack< T >::getRandomRes (  const std::string &  name  )  [inline]

Get resource at random index or return NULL. Definition at line 116 of file ResourcePack.h. { T result = NULL; typename t_reses::size_type count = m_reses.count(name); if (count > 0) { result = getRes(name, Random::randomInt(count)); } else { LOG_WARNING(ExInfo("no such resource") .addInfo("name", name) .addInfo("pack", toString())); } return result; }

template<class T> t_range ResourcePack< T >::getRange (  const std::string &  name  )  [inline]

Get all resources with this name. NOTE: range can be empty. Definition at line 100 of file ResourcePack.h. { t_range result; std::pair<t_resIterator, t_resIterator> range = m_reses.equal_range(name); while (range.first != range.second) { result.push_back(range.first->second); range.first++; } return result; }

template<class T> T ResourcePack< T >::getRes (  const std::string &  name, int  rank = 0 )  [inline]

Get resource with this name. Definition at line 80 of file ResourcePack.h. { std::pair<t_resIterator, t_resIterator> range = m_reses.equal_range(name); for (int i = 0; i < rank && range.first != range.second; ++i) { ++(range.first); } if (range.second == range.first) { throw ResourceException(ExInfo("no such resource at index") .addInfo("name", name) .addInfo("index", rank) .addInfo("pack", toString())); } return range.first->second; }

template<class T> void ResourcePack< T >::removeAll (   )  [inline]

Free all resources. NOTE: we cannot call virtual functions from desctructor Definition at line 42 of file ResourcePack.h. { t_resIterator end = m_reses.end(); for (t_resIterator item = m_reses.begin(); item != end; ++item) { unloadRes(item->second); } m_reses.clear(); }

template<class T> void ResourcePack< T >::removeRes (  const std::string &  name  )  [inline]

Unload all resources with this name. Definition at line 54 of file ResourcePack.h. { std::pair<t_resIterator, t_resIterator> range = m_reses.equal_range(name); while (range.first != range.second) { unloadRes(range.first->second); ++(range.first); } m_reses.erase(name); LOG_DEBUG(ExInfo("removed resources") .addInfo("name", name)); }

template<class T> std::string ResourcePack< T >::toString (   )  const [inline]

Definition at line 139 of file ResourcePack.h. { ExInfo available_res = ExInfo("resources") .addInfo("name", getName()); t_constIterator end = m_reses.end(); for (t_constIterator item = m_reses.begin(); item != end; ++item) { available_res.addInfo("key", item->first); } return available_res.info(); }

template<class T> virtual void ResourcePack< T >::unloadRes (  T  res  )  [protected, pure virtual]

Implemented in ResColorPack, ResDialogPack, ResImagePack, and ResSoundPack.

---

Field Documentation

template<class T> t_reses ResourcePack< T >::m_reses [protected]

Definition at line 24 of file ResourcePack.h.

---

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

• ResourcePack.h

---