asset::Asset Class Reference

Superinterface describing especially bookeeping properties. More...

#include <asset.hpp>

Inheritance diagram for asset::Asset:

[legend]

Collaboration diagram for asset::Asset:

[legend]

List of all members.

Public Member Functions
bool	enable (bool on=true) throw (lumiera::error::State)
	change the enabled status of this asset.
const vector< PAsset > &	getDependant () const
	All the other assets requiring this asset to be functional.
virtual const ID< Asset > &	getID () const
const vector< PAsset > &	getParents () const
	List of entities this asset depends on or requires to be functional.
bool	isActive () const
	weather this asset is swithced on and consequently included in the fixture and participates in rendering
virtual	operator string () const
bool	operator< (const Asset &oa) const
bool	operator== (const Asset &oa) const
Public Attributes
const Ident	ident
	Asset identification tuple.
Protected Member Functions
	Asset (const Ident &idi)
	Asset is a Interface class; usually, objects of concrete subclasses are created via specialized Factories.
void	defineDependency (Asset &parent)
void	defineDependency (PAsset parent)
	establish a connection between this and the given parent asset, denoting we are in some way dependant on the parent.
virtual void	unlink (IDA target)
	variant of unlink() dropping only the links to the given specific Asset, leaving all other links intact.
virtual void	unlink ()
	release all links to other Asset objects held internally.
virtual	~Asset ()=0
Protected Attributes
vector< PAsset >	dependants
bool	enabled
set< string >	groups
	additional classification, selections or departments this asset belongs to.
const ID< Asset >	id
	Asset primary key.
const string	longDesc
	user visible qualification of the thing, unit or concept represented by this asset.
vector< PAsset >	parents
const string	shortDesc
	user visible Name-ID.
Private Member Functions
void	unregister (PAsset &other)
Friends
class	AssetManager
class	DB
Classes
struct	Ident
	a POD comprised of all the information sufficiently identifying any given Asset. More...

---

Detailed Description

As of 09/2007, there are four Kinds of Assets, each comprising a sub-Interface of the Asset Interface:

• asset::Media representing mediafiles
• asset::Proc representing media data processing components (e.g. Effects)
• asset::Struct representing structural components used in the sesion (e.g. Tracks)
• asset::Meta representing meta objects created while editing (e.g. Automation)

And of course there are various concret Asset subclasses, like asset::Clip, asset::Effect, asset::Codec, asset::Track, asset::Dataset.

Note:

Assets objects have a strict unique identity and because of this are non-copyable. You can not create an Asset derived object without registering it with the AssetManager automatically. It is possible to copy the PAsset (smart pointer) though.

Since:

09/2007

Author:

Ichthyo

Definition at line 139 of file asset.hpp.

---

Constructor & Destructor Documentation

asset::Asset::Asset

(

const Ident &

idi

)

[protected]

Calling this base ctor causes registration with AssetManager.

Definition at line 55 of file asset.cpp.

References ident.

    : ident(idi), id(AssetManager::reg (this, idi)), enabled(true)
  {
    TRACE (assetmem, "ctor Asset(id=%lu) :  adr=%x %s", size_t(id), this, cStr(this->ident) );
  }

asset::Asset::~Asset

(

)

[protected, pure virtual]

Note:

Asset is abstract

Definition at line 61 of file asset.cpp.

  { 
    TRACE (assetmem, "dtor Asset(id=%lu) :  adr=%x", size_t(id), this );
  }

---

Member Function Documentation

void asset::Asset::defineDependency

(

PAsset

parent

)

[protected]

Definition at line 164 of file asset.cpp.

References asset::AssetManager::wrap().

  {
    PAsset p_this (AssetManager::wrap(*this));
    REQUIRE (!contains (parent->dependants, p_this));
    REQUIRE (!contains (this->parents, parent));
    parents.push_back (parent);
    parent->dependants.push_back(p_this);
  }

Here is the call graph for this function:

bool asset::Asset::enable

(

bool

on = true

)

throw (lumiera::error::State)

change the enablement status of this asset.

Note the corresponding isActive predicate may depend on the enablement status of parent assets as well

Returns:

false if the state could not be changed due to parent objects being disabled

Definition at line 114 of file asset.cpp.

  {
    if (on == this->enabled)
      return true;
    if (on && !all_parents_enabled (parents))
      return false;
    
    // can indeed to do the toggle...
    this->enabled = on;
    for_each (dependants, bind (&propagate_down, _1 ,on));
    return true;
  }

const vector<PAsset>& asset::Asset::getDependant

(

)

const [inline]

For example, all the clips depending on a given media file. May be empty. The dependency relation is transitive.

Definition at line 279 of file asset.hpp.

{ return dependants; }

const vector<PAsset>& asset::Asset::getParents

(

)

const [inline]

May be empty. The head of this list can be considered the primary prerequisite

Definition at line 273 of file asset.hpp.

{ return parents; }

bool asset::Asset::isActive

(

)

const

whether this asset is swithced on and consequently included in the fixture and participates in rendering.

Definition at line 99 of file asset.cpp.

  {
    return this->enabled
        && all_parents_enabled (parents);
  }

void asset::Asset::unlink

(

IDA

target

)

[protected, virtual]

variant dropping only the links to the given Asset

Usable for propagating

Definition at line 155 of file asset.cpp.

References asset::AssetManager::instance.

  {
    PAsset asset (AssetManager::instance().getAsset (target));
    removeall (dependants,asset);
    removeall (parents,asset);
  }

void asset::Asset::unlink

(

)

[protected, virtual]

release all links to other dependant asset objects held internally and advise all parent assets to do so with the link to this asset.

The lifecycle of Asset objects is managed by smart pointers and the Asset manager. Calling release() breaks interconnectons to other Assets in the central Object network comprising the session. It is up to the AssetManager to asure the notification of any other components that may need to release references to the Asset object beeing removed. The rationale is, after releasing all interlinkings, when the AssetManager removes its DB entry for this asset, the smart pointer goes out of scope and triggers cleanup.

Note:

we don't release upward links to parent assets, thus effectively keeping the parents alive, because frequently these accessible parent assets are part of our own contract. (e.g. media for clip assets)

Definition at line 145 of file asset.cpp.

References unregister().

  {
    function<void(PAsset&)> forget_me = bind(&Asset::unregister, this,_1);
    
    for_each (parents, forget_me);
    dependants.clear();
  }

Here is the call graph for this function:

void asset::Asset::unregister

(

PAsset &

other

)

[private]

Parameters:

other

For internal use only.

Definition at line 131 of file asset.cpp.

Referenced by unlink().

  {
    other->unlink (this->id);  
  }

Here is the caller graph for this function:

---

Member Data Documentation

set<string> asset::Asset::groups [protected]

Groups are optional, non-exclusive and may be overlapping.

Definition at line 215 of file asset.hpp.

const string asset::Asset::longDesc [protected]

perferably "in one line". To be localized.

Reimplemented in asset::Pipe.

Definition at line 222 of file asset.hpp.

const string asset::Asset::shortDesc [protected]

To be localized.

Reimplemented in asset::Pipe.

Definition at line 218 of file asset.hpp.

---

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

• proc/asset.hpp
• proc/asset.cpp