asset::AssetManager Class Reference

Facade for the Asset subsystem.

#include <assetmanager.hpp>

Collaboration diagram for asset::AssetManager:

[legend]

List of all members.

Public Member Functions
template<class KIND>
P< KIND >	getAsset (const ID< KIND > &id) throw (lumiera::error::Invalid)
	find and return corresponging object
bool	known (IDA id, const Category &cat)
bool	known (IDA id)
list< PcAsset >	listContent () const
	extract a sorted list of all registered Assets
void	remove (IDA id)
	remove the given asset from the internal DB.
Static Public Member Functions
static ID< Asset >	getID (const Asset::Ident &)
	provide the unique ID for given Asset::Ident tuple
template<class KIND>
static P< KIND >	wrap (const KIND &asset)
	retrieve the registerd smart-ptr for any asset
Static Public Attributes
static lumiera::Singleton < AssetManager >	instance
	get at the system-wide asset manager instance.
Protected Member Functions
friend	Asset::Asset (const Asset::Ident &idi)
Static Protected Member Functions
static void	destroy (Asset *aa)
	deleter function used by the Asset smart pointers to delete Asset objects
template<class KIND>
static ID< KIND >	reg (KIND *obj, const Asset::Ident &idi) throw (lumiera::error::Invalid)
	registers an asset object in the internal DB, providing its unique key.
Private Attributes
asset::DB &	registry
Friends
class	lumiera::singleton::StaticCreate< AssetManager >

---

Detailed Description

Definition at line 65 of file assetmanager.hpp.

---

Member Function Documentation

template<class KIND>

P< KIND > asset::AssetManager::getAsset

(

const ID< KIND > &

id

)

throw (lumiera::error::Invalid) [inline]

find and return the object registered with the given ID.

Exceptions:

Invalid

if nothing is found or if the actual KIND of the stored object differs and can't be casted.

Definition at line 134 of file assetmanager.cpp.

References asset::DB::get(), and known().

Referenced by remove().

  {
    if (P<KIND> obj = registry.get (id))
      return obj;
    else
      if (known (id))    // provide Ident tuple of existing Asset 
        throw WrongKind (registry.get(ID<Asset>(id))->ident);
      else
        throw UnknownID (id);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool asset::AssetManager::known	(	IDA	id,
		const Category &	cat
	)

Returns:

true if the given id is registered with the given Category

true if the given id is registered with the given Category

Definition at line 179 of file assetmanager.cpp.

References asset::DB::get().

  {
    PAsset pA = registry.get (id);
    return ( pA && pA->ident.category.isWithin(cat));
  }

Here is the call graph for this function:

bool asset::AssetManager::known

(

IDA

id

)

Returns:

true if the given id is registered in the internal asset DB

true if the given id is registered in the internal asset DB

Definition at line 168 of file assetmanager.cpp.

References asset::DB::get().

Referenced by getAsset(), and wrap().

  {
    return ( registry.get (ID<Asset>(id)) );
  }       // query most general Asset ID-kind and use implicit 

Here is the call graph for this function:

Here is the caller graph for this function:

template<class KIND>

ID< KIND > asset::AssetManager::reg	(	KIND *	obj,
		const Asset::Ident &	idi
	)			throw (lumiera::error::Invalid) [inline, static, protected]

For internal use only.

used by the Asset base class ctor to create Asset::id.

This includes creating the smart ptr in charge of the asset's lifecycle

Definition at line 112 of file assetmanager.cpp.

References destroy(), getID(), instance, asset::DB::put(), and registry.

  {
    AssetManager& _aMang (AssetManager::instance());
    TODO ("check validity of Ident Category");
    ID<KIND> asset_id (getID (idi));
    
    Thread::Lock<DB> guard   SIDEEFFECT;
    TODO ("handle duplicate Registrations");
    P<KIND> smart_ptr (obj, &destroy);

    _aMang.registry.put (asset_id, smart_ptr);
    return asset_id;
  }

Here is the call graph for this function:

void asset::AssetManager::remove

(

IDA

id

)

remove the given asset from the internal DB together with all its dependants

together with all its dependants

Definition at line 203 of file assetmanager.cpp.

References asset::DB::del(), and getAsset().

  {
    PAsset asset = getAsset (id);
    for_each (asset->dependants, detach_child_recursively());
    asset->unlink();
    registry.del(id);
  }

Here is the call graph for this function:

template<class KIND>

P< KIND > asset::AssetManager::wrap

(

const KIND &

asset

)

[inline, static]

convienience shortcut for fetching the registered smart-ptr which is in charge of the given asset instance.

By querying directly asset.id (of type ID<Asset>), the call to registry.get() can bypass the dynamic cast, because the type of the asset is explicitely given by type KIND.

Definition at line 154 of file assetmanager.cpp.

References instance, and known().

Referenced by asset::Asset::defineDependency(), mobject::session::Clip::findClipAsset(), asset::Clip::getClipAsset(), and mobject::session::Clip::getMedia().

  {
    ENSURE (instance().known(asset.id), 
            "unregistered asset instance encountered.");
    return static_pointer_cast<KIND,Asset>
            (instance().registry.get (asset.id));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

Singleton< AssetManager > asset::AssetManager::instance [static]

Implemented as singleton.

Definition at line 71 of file assetmanager.hpp.

Referenced by asset::ProcPatt::newCopy(), asset::StructFactory::operator()(), asset::test::TestAsset< A >::ptrFromThis(), reg(), asset::Asset::unlink(), and wrap().

---

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

• proc/assetmanager.hpp
• proc/assetmanager.cpp