44 lines
6.1 KiB
HTML
44 lines
6.1 KiB
HTML
<!-- Documentation produced by the Html generator of Bouml (http://bouml.free.fr) -->
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
|
<head>
|
|
<title>Class Asset</title>
|
|
<link rel="stylesheet" href="style.css" type="text/css" />
|
|
</head>
|
|
|
|
<body bgcolor="#ffffff">
|
|
|
|
<div class = "title">Class Asset</div>
|
|
<p></p>
|
|
|
|
<!-- ============================================================= -->
|
|
|
|
<a name="refclass136453"></a>
|
|
<p>Superinterface describing especially the bookeeping properties of Assets<br /></p><p>Declaration :</p><ul><li>C++ : class Asset </li><li>Java : public interface Asset </li></ul><p>Directly inherited by : <a href="class136709.html#refclass136709"><b>Media</b></a> <a href="class137093.html#refclass137093"><b>Meta</b></a> <a href="class136837.html#refclass136837"><b>Proc</b></a> <a href="class136965.html#refclass136965"><b>Struct</b></a> </p>
|
|
<p>Artifact : <a href="index.html#refartifact136069"><b>asset</b></a></p><p>Stereotype: interface</p>
|
|
<div class="sub">
|
|
<a name="refattribute130437"></a>
|
|
<table><tr><td><div class="element">Attribut <b>id</b></div></td></tr></table>
|
|
<p>Asset primary key.<br /></p><p>Declaration :</p><ul><li>Uml : + id : long</li><li>C++ : public: const long id</li></ul><a name="refattribute130565"></a>
|
|
<table><tr><td><div class="element">Attribut <b>name</b></div></td></tr></table>
|
|
<p>element ID, comprehensible but sanitized. The tuple (category, name, org) is unique.<br /></p><p>Declaration :</p><ul><li>Uml : + name : string</li><li>C++ : public: const string name</li></ul><a name="refrelation140421"></a>
|
|
<table><tr><td><div class="element">Relation <b>category (<unidirectional association>)</b></div></td></tr></table><p>primary tree like classification of the asset<br /></p><p>Declaration :</p><ul><li>Uml : + category : <a href="class137221.html#refclass137221"><b>Category</b></a>, multiplicity : 1</li><li>C++ : public: const <a href="class137221.html#refclass137221"><b>Category</b></a>* category</li></ul><a name="refattribute130821"></a>
|
|
<table><tr><td><div class="element">Attribut <b>org</b></div></td></tr></table>
|
|
<p>origin or authorship id. Can be a project abbreviation, a package id or just the authors nickname or UID. This allows for the compnent name to be more generic (e.g. "blur"). Default for all assets provided by the core Lumiera codebase is "lumi".<br /></p><p>Declaration :</p><ul><li>Uml : + org : string</li><li>C++ : public: const string org</li></ul><a name="refattribute130949"></a>
|
|
<table><tr><td><div class="element">Attribut <b>version</b></div></td></tr></table>
|
|
<p>version number of the thing or concept represented by this asset. Of each unique tuple (name, category, org) there will be only one version in the whole system. Version 0 is reserved for internal purposes. Versions are considered to be ordered, and any higher version is supposed to be fully backwards compatible to all previous versions.<br /></p><p>Declaration :</p><ul><li>Uml : + version : uint</li><li>C++ : public: const unsigned int version</li></ul><a name="refattribute131077"></a>
|
|
<table><tr><td><div class="element">Attribut <b>groups</b></div></td></tr></table>
|
|
<p>additional classification, selections or departments this asset belongs to. Groups are optional, non-exclusive and may be overlapping.<br /></p><p>Declaration :</p><ul><li>Uml : # groups : set<string></li><li>C++ : protected: set<string> groups</li></ul><a name="refattribute131205"></a>
|
|
<table><tr><td><div class="element">Attribut <b>shortDesc</b></div></td></tr></table>
|
|
<p>user visible Name-ID. To be localized.<br /></p><p>Declaration :</p><ul><li>Uml : # shortDesc : string</li><li>C++ : protected: const string shortDesc</li></ul><a name="refattribute131333"></a>
|
|
<table><tr><td><div class="element">Attribut <b>longDesc</b></div></td></tr></table>
|
|
<p>user visible qualification of the thing, unit or concept represented by this asset. perferably "in one line". To be localized.<br /></p><p>Declaration :</p><ul><li>Uml : # longDesc : string</li><li>C++ : protected: const string longDesc</li></ul><a name="refoperation132101"></a>
|
|
<table><tr><td><div class="element">Operation <b>getParents</b></div></td></tr></table><p>List of entities this asset depends on or requires to be functional. May be empty. The head of this list can be considered the primary prerequisite<br /></p><p>Declaration :</p><ul><li>Uml : + getParents() : vector<PAsset></li><li>C++ : public: vector<PAsset> getParents () </li></ul><a name="refoperation132229"></a>
|
|
<table><tr><td><div class="element">Operation <b>getDependant</b></div></td></tr></table><p>All the other assets requiring this asset to be functional. For example, all the clips depending on a given media file. May be empty. The dependency relation is transitive.<br /></p><p>Declaration :</p><ul><li>Uml : + getDependant() : vector<PAsset></li><li>C++ : public: vector<PAsset> getDependant () </li></ul><a name="refoperation132869"></a>
|
|
<table><tr><td><div class="element">Operation <b>isActive</b></div></td></tr></table><p>weather this asset is swithced on and consequently included in the fixture and participates in rendering<br /></p><p>Declaration :</p><ul><li>Uml : + isActive() : bool</li><li>C++ : public: bool isActive () </li></ul><a name="refoperation132997"></a>
|
|
<table><tr><td><div class="element">Operation <b>enable</b></div></td></tr></table><p>change the enabled status of this asset. Note the corresponding #isActive predicate may depend on the enablement status of parent assets as well<br /></p><p>Declaration :</p><ul><li>Uml : + enable(in bool : ) : void, exceptions : <a href="class135941.html#refclass135941"><b>State</b></a></li><li>C++ : public: void enable () throw (<a href="class135941.html#refclass135941"><b>State</b></a>)</li></ul></div>
|
|
<p>All public operations : <a href="class136453.html#refoperation132997"><b>enable</b></a> , <a href="class136453.html#refoperation132229"><b>getDependant</b></a> , <a href="class136453.html#refoperation132101"><b>getParents</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
|
|
</body>
|
|
</html>
|