Szablon klasy do przechowywania assetów. More...

#include <ResourceContainer.h>

Public Member Functions
	ResourceContainer ()

	~ResourceContainer ()
	Destruktor zwalnia wszystkie elementy w mapie (także pamięć po nich) More...

int	Remove (const std::wstring &name)
	Usuwa element o podanej nazwie, jeżeli nie ma do niego odwołań. More...

int	Remove (unsigned int id)
	Usuwa element o podanym indeksie, jeżeli nie ma do niego odwołań. More...

int	RemoveUnused ()
	Kasuje wszystkie elementy w kontenerze, które nie są używane przez żaden obiekt. Kasowanie jest w pełni bezpieczne. More...

void	UnsafeAdd (const std::wstring &name, TYPE *resource)
	Dodaje element do kontanera + nadaje mu unikalny identyfikator. More...

TYPE *	get (unsigned int id)
	Zwraca element na podstawie identyfikatora. More...

unsigned int	GetNextId ()
	Zwraca identyfikator, który zostanie przydzielony kolejnemu elementowi. More...

TYPE *	get (const std::wstring &name)
	Zwraca element na podstawie jego nazwy. More...

template<typename DescType >
TYPE *	Find (const DescType &desc)
	Finds resource matching given descriptor. More...

std::vector< ResourcePtr< TYPE > >	List ()
	Listuje wszystkie assety danego typu. More...

Protected Member Functions
int	ForceRemove (const std::wstring &name)
	Wymusza skasowanie podanego elementu, nawet jeżeli jest używany. More...

int	ForceRemove (unsigned int id)
	Wymusza skasowanie podanego elementu. More...

void	ForceRemoveAll ()
	Kasuje wszystkie elementy niezależnie od tego czy były używane, a następnie czyści mapę. More...

void	ReleaseMemory (TYPE *)
	Zwalnia obiekt podany w parametrze. More...

Protected Attributes
std::map< std::wstring, TYPE * >	container
	Kontener zawierający assety powiazane z ich nazwą More...

Private Attributes
unsigned int	count
	Indentyfikator jaki zostanie przydzielony kolejnemy elementowi. More...

Friends
class	AssetsManager

class	ResourceManager

Detailed Description

template<class TYPE>
class ResourceContainer< TYPE >

Szablon klasy do przechowywania assetów.

Todo:

Dodać IDki obok ścieżek.

Kontrner powinien obsługiwać ścieżki, jako obiekty typu Path zamiast wstringów.

Wszystkie assety są identyfikowane po nazwie, która najczęściej jest nazwą pliku, z którego asset pochodzi. Mapa zapewnia logarytmiczny czas dostępu po nazwie. Istnieje też możliwość odwołania się po identyfikatorze, wtedy czas dostępu jest liniowy (chyba że iterowanie po kolejnych elementacj mapy nie odbywa się liniowo.

Constructor & Destructor Documentation

template<class TYPE >

ResourceContainer< TYPE >::ResourceContainer ( )

template<class TYPE >

ResourceContainer< TYPE >::~ResourceContainer ( )

Destruktor zwalnia wszystkie elementy w mapie (także pamięć po nich)

Member Function Documentation

template<class TYPE >

template<typename DescType >

TYPE * ResourceContainer< TYPE >::Find ( const DescType & desc )

inline

Finds resource matching given descriptor.

Resource must implement GetDescriptor function. Descriptor must implement operator==.

Function finds resource in linear time. Use only for small containers.

template<class TYPE >

int ResourceContainer< TYPE >::ForceRemove ( const std::wstring & name )

protected

Wymusza skasowanie podanego elementu, nawet jeżeli jest używany.

Parameters

[in] name Nazwa elementu do usunięcia.

Returns

Zwracana wartość:

0 - w przypadku powodzenia,
-1 - nie znaleziono elementu

template<class TYPE >

int ResourceContainer< TYPE >::ForceRemove ( unsigned int id )

protected

Wymusza skasowanie podanego elementu.

Parameters

[in] id Identyfkator elementu do usunięcia

Returns

Zwracana wartość:

0 - w przypadku powodzenia,
-1 - nie znaleziono elementu

template<class TYPE >

void ResourceContainer< TYPE >::ForceRemoveAll ( )

protected

Kasuje wszystkie elementy niezależnie od tego czy były używane, a następnie czyści mapę.

template<class TYPE >

TYPE * ResourceContainer< TYPE >::get ( unsigned int id )

Zwraca element na podstawie identyfikatora.

Wyszukiwanie po identyfikatorze jest liniowe, a po nazwie logarytmiczne. Jednakże porównania stringów mogą się okazać bardziej kosztowne.

Parameters

[in] id Identyfikator elementu.

Returns: Wskaźnik na poszukiwany element.

template<class TYPE>

TYPE* ResourceContainer< TYPE >::get ( const std::wstring & name )

inline

Zwraca element na podstawie jego nazwy.

Parameters

[in] name Nazwa elementu, który chcemy dostać

Returns: Wskaźnik na obiekt assetu

template<class TYPE>

unsigned int ResourceContainer< TYPE >::GetNextId ( )

inline

Zwraca identyfikator, który zostanie przydzielony kolejnemu elementowi.

template<class TYPE >

std::vector< ResourcePtr< TYPE > > ResourceContainer< TYPE >::List ( )

inline

Listuje wszystkie assety danego typu.

template<class TYPE>

void ResourceContainer< TYPE >::ReleaseMemory ( TYPE * object )

protected

Zwalnia obiekt podany w parametrze.

Kasowanie pamięci nie jest możliwe przy pomocy operatora delete, ponieważ destruktory w tych klasach są prywatne. Dlatego trzeba zrobić to za pośrednictwem obiektu, który ma uprawnienia do tego.

Parameters

[in] object Objekt do skasowania.

template<class TYPE >

int ResourceContainer< TYPE >::Remove ( const std::wstring & name )

Usuwa element o podanej nazwie, jeżeli nie ma do niego odwołań.

Parameters

[in] name nazwa elementu do usunięcia.

Returns

Zwracana wartość:

0 - w przypadku powodzenia,
-1 - nie znaleziono elementu,
1 - nie da się usunąć, bo jest w użyciu

template<class TYPE >

int ResourceContainer< TYPE >::Remove ( unsigned int id )

Usuwa element o podanym indeksie, jeżeli nie ma do niego odwołań.

Parameters

[in] id Identyfikator elementu

Returns

Zwracana wartość:

0 - w przypadku powodzenia,
-1 - nie znaleziono elementu,
1 - nie da się usunąć, bo jest w użyciu

template<class TYPE >

int ResourceContainer< TYPE >::RemoveUnused ( )

Kasuje wszystkie elementy w kontenerze, które nie są używane przez żaden obiekt. Kasowanie jest w pełni bezpieczne.

Returns: Zwraca liczbę usuniętych elementów.

template<class TYPE>

void ResourceContainer< TYPE >::UnsafeAdd	(	const std::wstring &	name,
		TYPE *	resource
	)

Dodaje element do kontanera + nadaje mu unikalny identyfikator.

Jeżeli element już istniał, to zostanie nadpisany nowym, dlatego należy zawsze przed użyciem sprawdzić czy pod taką nazwą, coś już się nie znajduje.

Parameters

[in]	name	Nazwa elementu, pod jaką zostanie dodany.
[in]	resource	Element dodania.

Friends And Related Function Documentation

template<class TYPE>

friend class AssetsManager

friend

template<class TYPE>

friend class ResourceManager

friend

Member Data Documentation

template<class TYPE>

std::map<std::wstring, TYPE*> ResourceContainer< TYPE >::container

protected

Kontener zawierający assety powiazane z ich nazwą

template<class TYPE>

unsigned int ResourceContainer< TYPE >::count

private

Indentyfikator jaki zostanie przydzielony kolejnemy elementowi.

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

D:/ProgramyVS/SWLibraries/swGraphicAPI/ResourceManager/ResourceContainer.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Friends

Detailed Description

template<class TYPE> class ResourceContainer< TYPE >

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class TYPE>
class ResourceContainer< TYPE >