ichthyo/LUMIERA.clone
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

UML: export actual Version as HTML report

Browse source
This commit is contained in:
Fischlurch 2009-06-07 19:45:47 +02:00
parent 6f00eb742b
commit 8e46819c09
129 changed files with 495 additions and 284 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/devel/uml/class128005.html
View file

@ -16,11 +16,12 @@
<!-- ============================================================= -->
<a name="refclass128005"></a>
<p>Declaration :</p><ul><li>C++ : class SessionImpl : public <a href="class139653.html#refclass139653"><b>Session</b></a> </li></ul><p>Implementation class for the Session interface<br /></p><p>Artifact : <a href="index.html#refartifact128517"><b>sessionimpl</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
<p>Implementation class for the Session interface<br /></p><p>Declaration :</p><ul><li>C++ : class SessionImpl : public <a href="class139653.html#refclass139653"><b>Session</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact128517"><b>sessionimpl</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
<a name="refrelation128005"></a>
<table><tr><td><div class="element">Relation <b>edls (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # edls : <a href="class128133.html#refclass128133"><b>Seq</b></a>, multiplicity : 1..*</li><li>C++ : protected: &lt;<a href="class128133.html#refclass128133"><b>Seq</b></a>&gt; edls</li></ul><a name="refrelation128261"></a>
<table><tr><td><div class="element">Relation <b>edls (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # edls : <a href="class128133.html#refclass128133"><b>Seq</b></a>, multiplicity : 1..*</li><li>C++ : protected: &lt;<a href="class128133.html#refclass128133"><b>Seq</b></a>&gt; edls</li></ul><a name="refrelation128261"></a>
<table><tr><td><div class="element">Relation <b>theFixture (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # theFixture : <a href="class128261.html#refclass128261"><b>Fixture</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128261.html#refclass128261"><b>Fixture</b></a> * theFixture</li></ul><a name="refrelation147717"></a>
<table><tr><td><div class="element">Relation <b>pipes (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # pipes : <a href="class138117.html#refclass138117"><b>Pipe</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class138117.html#refclass138117"><b>Pipe</b></a>* pipes</li></ul><p>the global ports (busses) of the session<br /></p></div>
<table><tr><td><div class="element">Relation <b>pipes (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>the global ports (busses) of the session<br /></p><p>Declaration :</p><ul><li>Uml : # pipes : <a href="class138117.html#refclass138117"><b>Pipe</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class138117.html#refclass138117"><b>Pipe</b></a>* pipes</li></ul><p>Stereotype: vector</p>
</div>
<p>All public operations : <a href="class139653.html#refoperation133509"><b>currEDL</b></a> , <a href="class139653.html#refoperation133637"><b>getFixture</b></a> </p>
</body>
</html>

3
doc/devel/uml/class128133.html
View file

@ -19,7 +19,8 @@
<p>Declaration :</p><ul><li>C++ : class Seq </li></ul><p>Directly inherited by : <a href="class128261.html#refclass128261"><b>Fixture</b></a> </p>
<p>Artifact : <a href="index.html#refartifact128645"><b>edl</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
<a name="refrelation128901"></a>
<table><tr><td><div class="element">Relation <b>clips (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # clips : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class128517.html#refclass128517"><b>MObject</b></a> *&gt; clips</li></ul><a name="refrelation147333"></a>
<table><tr><td><div class="element">Relation <b>clips (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # clips : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class128517.html#refclass128517"><b>MObject</b></a> *&gt; clips</li></ul><p>Stereotype: list</p>
<a name="refrelation147333"></a>
<table><tr><td><div class="element">Relation <b>track (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # track : <a href="class128389.html#refclass128389"><b>Track</b></a></li><li>C++ : protected: <a href="class128389.html#refclass128389"><b>Track</b></a>* track</li></ul></div>
</body>
</html>

2
doc/devel/uml/class128138.html
View file

@ -16,5 +16,5 @@
<!-- ============================================================= -->
<a name="refclass128138"></a>
<p>Declaration :</p><ul><li>C++ : class Thread </li></ul><p>We can basically reuse the Thread class design from Cinelerra2, Thread becomes a baseclass for all Threads <br /></p></body>
<p>We can basically reuse the Thread class design from Cinelerra2, Thread becomes a baseclass for all Threads <br /></p><p>Declaration :</p><ul><li>C++ : class Thread </li></ul></body>
</html>

8
doc/devel/uml/class128181.html
View file

@ -18,10 +18,10 @@
<a name="refclass128181"></a>
<p>Declaration :</p><ul><li>C++ : class File </li></ul><div class="sub">
<a name="refrelation128437"></a>
<table><tr><td><div class="element">Relation <b>descriptor (descriptor)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # descriptor : <a href="class128693.html#refclass128693"><b>FileHandle</b></a></li><li>C++ : protected: <a href="class128693.html#refclass128693"><b>FileHandle</b></a> * descriptor</li></ul><p>type of this frame<br /></p><a name="refoperation128181"></a>
<table><tr><td><div class="element">Operation <b>getFrame</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getFrame(in : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>, in frame_address : , in mode : ) : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : public: <a href="class128821.html#refclass128821"><b>Frame</b></a> getFrame()</li></ul><p>mode = READ, WRITE, ...<br /></p><a name="refrelation128225"></a>
<table><tr><td><div class="element">Relation <b>handle (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # handle : <a href="class128693.html#refclass128693"><b>FileHandle</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128693.html#refclass128693"><b>FileHandle</b></a> * handle</li></ul><p>weak pointer<br /></p><a name="refrelation128609"></a>
<table><tr><td><div class="element">Relation <b>mappings (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # mappings : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128565.html#refclass128565"><b>FileMap</b></a> * mappings</li></ul><p>weak pointers<br /></p><a name="refrelation129162"></a>
<table><tr><td><div class="element">Relation <b>descriptor (descriptor)</b></div></td></tr></table><p>type of this frame<br /></p><p>Declaration :</p><ul><li>Uml : # descriptor : <a href="class128693.html#refclass128693"><b>FileHandle</b></a></li><li>C++ : protected: <a href="class128693.html#refclass128693"><b>FileHandle</b></a> * descriptor</li></ul><a name="refoperation128181"></a>
<table><tr><td><div class="element">Operation <b>getFrame</b></div></td></tr></table><p>mode = READ, WRITE, ...<br /></p><p>Declaration :</p><ul><li>Uml : + getFrame(in : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>, in frame_address : , in mode : ) : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : public: <a href="class128821.html#refclass128821"><b>Frame</b></a> getFrame()</li></ul><a name="refrelation128225"></a>
<table><tr><td><div class="element">Relation <b>handle (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>weak pointer<br /></p><p>Declaration :</p><ul><li>Uml : # handle : <a href="class128693.html#refclass128693"><b>FileHandle</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128693.html#refclass128693"><b>FileHandle</b></a> * handle</li></ul><a name="refrelation128609"></a>
<table><tr><td><div class="element">Relation <b>mappings (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>weak pointers<br /></p><p>Declaration :</p><ul><li>Uml : # mappings : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128565.html#refclass128565"><b>FileMap</b></a> * mappings</li></ul><a name="refrelation129162"></a>
<table><tr><td><div class="element">Relation <b>&lt;aggregation&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class129333.html#refclass129333"><b>FileProvider</b></a></li><li>C++ : protected: <a href="class129333.html#refclass129333"><b>FileProvider</b></a> * </li></ul></div>
<p>All public operations : <a href="class128181.html#refoperation128181"><b>getFrame</b></a> </p>
</body>

2
doc/devel/uml/class128225.html
View file

@ -18,6 +18,6 @@
<a name="refclass128225"></a>
<p>Declaration :</p><ul><li>C++ : class FrameReference : public <a href="class128906.html#refclass128906"><b>SmartPointer</b></a> </li></ul><div class="sub">
<a name="refrelation129761"></a>
<table><tr><td><div class="element">Relation <b>frame (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # frame : <a href="class128821.html#refclass128821"><b>Frame</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a> * frame</li></ul><p>maybe weak reference<br /></p></div>
<table><tr><td><div class="element">Relation <b>frame (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>maybe weak reference<br /></p><p>Declaration :</p><ul><li>Uml : # frame : <a href="class128821.html#refclass128821"><b>Frame</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a> * frame</li></ul></div>
</body>
</html>

7
doc/devel/uml/class128261.html
View file

@ -18,10 +18,13 @@
<a name="refclass128261"></a>
<p>Declaration :</p><ul><li>C++ : class Fixture : public <a href="class128133.html#refclass128133"><b>Seq</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact128773"><b>fixture</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
<a name="refrelation131717"></a>
<table><tr><td><div class="element">Relation <b>effectiveTimeline (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # effectiveTimeline : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> effectiveTimeline</li></ul><a name="refoperation128645"></a>
<table><tr><td><div class="element">Relation <b>effectiveTimeline (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # effectiveTimeline : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> effectiveTimeline</li></ul><p>Stereotype: list</p>
<a name="refoperation128645"></a>
<table><tr><td><div class="element">Operation <b>getPlaylistForRender</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getPlaylistForRender() : list&lt;ExplicitPlacement [ProcessingLayer::MObject]&gt;</li><li>C++ : public: list&lt;ExplicitPlacement [ProcessingLayer::MObject]&gt; getPlaylistForRender () </li></ul><a name="refoperation129157"></a>
<table><tr><td><div class="element">Operation <b>getAutomation</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getAutomation() : Auto [ProcessingLayer::MObject]*</li><li>C++ : public: Auto [ProcessingLayer::MObject]* getAutomation () </li></ul><a name="refrelation147589"></a>
<table><tr><td><div class="element">Relation <b>track (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # track : <a href="class128389.html#refclass128389"><b>Track</b></a></li><li>C++ : protected: <a href="class128389.html#refclass128389"><b>Track</b></a>* track</li></ul></div>
<table><tr><td><div class="element">Relation <b>track (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # track : <a href="class128389.html#refclass128389"><b>Track</b></a></li><li>C++ : protected: <a href="class128389.html#refclass128389"><b>Track</b></a>* track</li></ul><a name="refrelation163333"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class147333.html#refclass147333"><b>Segmentation</b></a></li><li>C++ : protected: <a href="class147333.html#refclass147333"><b>Segmentation</b></a>* </li></ul><p>Stereotype: partitioning</p>
</div>
<p>All public operations : <a href="class128261.html#refoperation129157"><b>getAutomation</b></a> , <a href="class128261.html#refoperation128645"><b>getPlaylistForRender</b></a> </p>
</body>
</html>

2
doc/devel/uml/class128266.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass128266"></a>
<p>Declaration :</p><ul><li>C++ : class Condition </li></ul><p>I provided a reworked Condition class in my Cinelerra2 repository<br /></p><div class="sub">
<p>I provided a reworked Condition class in my Cinelerra2 repository<br /></p><p>Declaration :</p><ul><li>C++ : class Condition </li></ul><div class="sub">
<table><tr><td><div class="element">Class <b><a href="class128522.html#refclass128522"><b>Lock</b></a></b></div></td></tr></table>
</div>
</body>

5
doc/devel/uml/class128309.html
View file

@ -18,8 +18,9 @@
<a name="refclass128309"></a>
<p>Declaration :</p><ul><li>C++ : class FileHandleCache </li></ul><div class="sub">
<a name="refrelation128737"></a>
<table><tr><td><div class="element">Relation <b>handles (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # handles : <a href="class128693.html#refclass128693"><b>FileHandle</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class128693.html#refclass128693"><b>FileHandle</b></a>&gt; handles</li></ul><a name="refattribute128225"></a>
<table><tr><td><div class="element">Relation <b>handles (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # handles : <a href="class128693.html#refclass128693"><b>FileHandle</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class128693.html#refclass128693"><b>FileHandle</b></a>&gt; handles</li></ul><p>Stereotype: list</p>
<a name="refattribute128225"></a>
<table><tr><td><div class="element">Attribut <b>handles_available</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : - handles_available : int</li><li>C++ : private: int handles_available</li></ul><p>initialized to the maximum number of filehandles the backend may use for mapped files. When no handles are available, the handle which is last in the handles list is closed and (re-)used.<br />Else this number is decremented for each new filehandle used and incremented for any one explicitly freed.<br /></p></div>
<p>initialized to the maximum number of filehandles the backend may use for mapped files. When no handles are available, the handle which is last in the handles list is closed and (re-)used.<br />Else this number is decremented for each new filehandle used and incremented for any one explicitly freed.<br /></p><p>Declaration :</p><ul><li>Uml : - handles_available : int</li><li>C++ : private: int handles_available</li></ul></div>
</body>
</html>

3
doc/devel/uml/class128389.html
View file

@ -18,7 +18,8 @@
<a name="refclass128389"></a>
<p>Declaration :</p><ul><li>C++ : class Track : public <a href="class129157.html#refclass129157"><b>Meta</b></a>, public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact128901"><b>track</b></a>, Diagram : <a href="index.html#refclass diagram128133"><b>Session structure</b></a></p><div class="sub">
<a name="refrelation147205"></a>
<table><tr><td><div class="element">Relation <b>subTracks (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + subTracks : <a href="class128389.html#refclass128389"><b>Track</b></a>, multiplicity : *</li><li>C++ : public: <a href="class128389.html#refclass128389"><b>Track</b></a> subTracks</li></ul><p>Child tracks in a tree structure<br /></p></div>
<table><tr><td><div class="element">Relation <b>subTracks (&lt;directional composition&gt;)</b></div></td></tr></table><p>Child tracks in a tree structure<br /></p><p>Declaration :</p><ul><li>Uml : + subTracks : <a href="class128389.html#refclass128389"><b>Track</b></a>, multiplicity : *</li><li>C++ : public: <a href="class128389.html#refclass128389"><b>Track</b></a> subTracks</li></ul><p>Stereotype: vector</p>
</div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
</body>
</html>

2
doc/devel/uml/class128394.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass128394"></a>
<p>Declaration :</p><ul><li>C++ : class Mutex </li></ul><p>I provided a reworked Mutex class in my Cinelerra2 repository<br /></p><div class="sub">
<p>I provided a reworked Mutex class in my Cinelerra2 repository<br /></p><p>Declaration :</p><ul><li>C++ : class Mutex </li></ul><div class="sub">
<table><tr><td><div class="element">Class <b><a href="class128650.html#refclass128650"><b>Lock</b></a></b></div></td></tr></table>
</div>
</body>

6
doc/devel/uml/class128437.html
View file

@ -19,7 +19,9 @@
<p>Declaration :</p><ul><li>C++ : class FileMapCache </li></ul><div class="sub">
<a name="refrelation129505"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a> * </li></ul><a name="refrelation129633"></a>
<table><tr><td><div class="element">Relation <b>checked_in (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # checked_in : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128565.html#refclass128565"><b>FileMap</b></a> checked_in</li></ul><p>checked_in objects are subject of cache aging and must be not in use<br /></p><a name="refrelation129290"></a>
<table><tr><td><div class="element">Relation <b>checked_out (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # checked_out : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class128565.html#refclass128565"><b>FileMap</b></a>&gt; checked_out</li></ul><p>this list keeps all mappings which are in use, and thus prevents them from Cache aging<br /></p></div>
<table><tr><td><div class="element">Relation <b>checked_in (&lt;directional composition&gt;)</b></div></td></tr></table><p>checked_in objects are subject of cache aging and must be not in use<br /></p><p>Declaration :</p><ul><li>Uml : # checked_in : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128565.html#refclass128565"><b>FileMap</b></a> checked_in</li></ul><p>Stereotype: list</p>
<a name="refrelation129290"></a>
<table><tr><td><div class="element">Relation <b>checked_out (&lt;directional composition&gt;)</b></div></td></tr></table><p>this list keeps all mappings which are in use, and thus prevents them from Cache aging<br /></p><p>Declaration :</p><ul><li>Uml : # checked_out : <a href="class128565.html#refclass128565"><b>FileMap</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class128565.html#refclass128565"><b>FileMap</b></a>&gt; checked_out</li></ul><p>Stereotype: list</p>
</div>
</body>
</html>

5
doc/devel/uml/class128517.html
View file

@ -17,10 +17,11 @@
<a name="refclass128517"></a>
<p>Declaration :</p><ul><li>C++ : class MObject : public <a href="class134021.html#refclass134021"><b>Buildable</b></a> </li><li>Java : public interface MObject </li></ul><p>Directly inherited by : <a href="class128773.html#refclass128773"><b>AbstractMO</b></a> <a href="class128901.html#refclass128901"><b>Clip</b></a> <a href="class129029.html#refclass129029"><b>Effect</b></a> <a href="class129669.html#refclass129669"><b>Label</b></a> <a href="class128389.html#refclass128389"><b>Track</b></a> </p>
<p>Artifact : <a href="index.html#refartifact128261"><b>mobject</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
<p>Artifact : <a href="index.html#refartifact128261"><b>mobject</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refattribute128517"></a>
<table><tr><td><div class="element">Attribut <b>length</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # length : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> length</li></ul><p>TODO: how to represent time intervals?<br /></p></div>
<p>TODO: how to represent time intervals?<br /></p><p>Declaration :</p><ul><li>Uml : # length : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> length</li></ul></div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
</body>
</html>

13
doc/devel/uml/class128645.html
View file

@ -16,13 +16,14 @@
<!-- ============================================================= -->
<a name="refclass128645"></a>
<p>Declaration :</p><ul><li>C++ : class Placement </li><li>Java : public interface Placement </li></ul><p>Directly inherited by : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> </p>
<p>used to specify the position of a MObject in the EDL. This can be done in various ways (absolute, relative). <br />Placement at the same time acts as (refcounting) smart pointer for accessing the MObject.<br /></p><p>Artifact : <a href="index.html#refartifact129029"><b>placement</b></a></p><div class="sub">
<p>used to specify the position of a MObject in the EDL. This can be done in various ways (absolute, relative). <br />Placement at the same time acts as (refcounting) smart pointer for accessing the MObject.<br /></p><p>Declaration :</p><ul><li>C++ : class Placement </li><li>Java : public interface Placement </li></ul><p>Directly inherited by : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> </p>
<p>Artifact : <a href="index.html#refartifact129029"><b>placement</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refoperation128005"></a>
<table><tr><td><div class="element">Operation <b>resolve</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + resolve() : ExplicitPlacement [ProcessingLayer::MObject]&amp;</li><li>C++ : public: ExplicitPlacement [ProcessingLayer::MObject]&amp; resolve () </li></ul><p>create an actual (explicit) placement while trying to satisfy the network of adjacent objects and placements.<br /></p><a name="refrelation144901"></a>
<table><tr><td><div class="element">Relation <b>subject (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # subject : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128517.html#refclass128517"><b>MObject</b></a>* subject</li></ul><p>Placement acts as smart pointer<br /></p><a name="refoperation134277"></a>
<table><tr><td><div class="element">Operation <b>chain</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + chain(in style : ) : </li><li>C++ : public: chain (const &amp; style) </li></ul><p>create and add another Placement for this media object, thus increasingly constraining the (possible) position of this object.<br /></p><a name="refrelation145413"></a>
<table><tr><td><div class="element">Relation <b>chain (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # chain : <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>* chain</li></ul><p>Chain of additional Placements further constraining the position of this MObject<br /></p></div>
<table><tr><td><div class="element">Operation <b>resolve</b></div></td></tr></table><p>create an actual (explicit) placement while trying to satisfy the network of adjacent objects and placements.<br /></p><p>Declaration :</p><ul><li>Uml : + resolve() : ExplicitPlacement [ProcessingLayer::MObject]&amp;</li><li>C++ : public: ExplicitPlacement [ProcessingLayer::MObject]&amp; resolve () </li></ul><a name="refrelation144901"></a>
<table><tr><td><div class="element">Relation <b>subject (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Placement acts as smart pointer<br /></p><p>Declaration :</p><ul><li>Uml : # subject : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128517.html#refclass128517"><b>MObject</b></a>* subject</li></ul><a name="refoperation134277"></a>
<table><tr><td><div class="element">Operation <b>chain</b></div></td></tr></table><p>create and add another Placement for this media object, thus increasingly constraining the (possible) position of this object.<br /></p><p>Declaration :</p><ul><li>Uml : + chain(in style : ) : </li><li>C++ : public: chain (const &amp; style) </li></ul><a name="refrelation145413"></a>
<table><tr><td><div class="element">Relation <b>chain (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Chain of additional Placements further constraining the position of this MObject<br /></p><p>Declaration :</p><ul><li>Uml : # chain : <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>* chain</li></ul></div>
<p>All public operations : <a href="class128645.html#refoperation134277"><b>chain</b></a> , <a href="class128645.html#refoperation128005"><b>resolve</b></a> </p>
</body>
</html>

2
doc/devel/uml/class128821.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass128821"></a>
<p>Declaration :</p><ul><li>C++ : class Frame </li></ul><p>Frames are just a low level lump of continous memory, most parts are opaque. Frames are memory sensitive, they will be small constant sized structures which can be efficently managed in a pool.<br /></p><div class="sub">
<p>Frames are just a low level lump of continous memory, most parts are opaque. Frames are memory sensitive, they will be small constant sized structures which can be efficently managed in a pool.<br /></p><p>Declaration :</p><ul><li>C++ : class Frame </li></ul><div class="sub">
<a name="refrelation128181"></a>
<table><tr><td><div class="element">Relation <b>&lt;directional aggregation&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>, multiplicity : *</li><li>C++ : protected: &lt;<a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> *&gt; </li></ul><a name="refrelation128309"></a>
<table><tr><td><div class="element">Relation <b>&lt;directional aggregation&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a></li><li>C++ : protected: <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a> * </li></ul><a name="refrelation128693"></a>

2
doc/devel/uml/class128901.html
View file

@ -19,7 +19,7 @@
<p>Declaration :</p><ul><li>C++ : class Clip : public <a href="class128773.html#refclass128773"><b>AbstractMO</b></a>, public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Directly inherited by : <a href="class138629.html#refclass138629"><b>CompoundClip</b></a> <a href="class138885.html#refclass138885"><b>SimpleClip</b></a> </p>
<p>Artifact : <a href="index.html#refartifact129413"><b>clip</b></a></p><div class="sub">
<a name="refrelation142469"></a>
<table><tr><td><div class="element">Relation <b>source (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # source : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class136709.html#refclass136709"><b>Media</b></a>* source</li></ul><p>the media source this clip referes to<br /></p></div>
<table><tr><td><div class="element">Relation <b>source (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>the media source this clip referes to<br /></p><p>Declaration :</p><ul><li>Uml : # source : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class136709.html#refclass136709"><b>Media</b></a>* source</li></ul></div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
</body>
</html>

1
doc/devel/uml/class128906.html
View file

@ -17,5 +17,6 @@
<a name="refclass128906"></a>
<p>Declaration :</p><ul><li>C++ : class SmartPointer </li><li>Java : package abstract class SmartPointer </li></ul><p>Directly inherited by : <a href="class128778.html#refclass128778"><b>FileReference</b></a> <a href="class128225.html#refclass128225"><b>FrameReference</b></a> </p>
<p>Stereotype: auxiliary</p>
</body>
</html>

3
doc/devel/uml/class128949.html
View file

@ -16,7 +16,8 @@
<!-- ============================================================= -->
<a name="refclass128949"></a>
<p>Declaration :</p><ul><li>C++ : class FrameDescriptor </li><li>Java : package interface FrameDescriptor </li></ul><p>A FrameDescriptor implements the higher level interfaces for frames. Further refinements are made by subclassing and policy classes<br /></p><div class="sub">
<p>A FrameDescriptor implements the higher level interfaces for frames. Further refinements are made by subclassing and policy classes<br /></p><p>Declaration :</p><ul><li>C++ : class FrameDescriptor </li><li>Java : package interface FrameDescriptor </li></ul><p>Stereotype: interface</p>
<div class="sub">
<a name="refrelation128821"></a>
<table><tr><td><div class="element">Relation <b>&lt;aggregation&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128821.html#refclass128821"><b>Frame</b></a></li><li>C++ : protected: <a href="class128821.html#refclass128821"><b>Frame</b></a> * </li></ul></div>
</body>

2
doc/devel/uml/class129029.html
View file

@ -19,7 +19,7 @@
<p>Declaration :</p><ul><li>C++ : class Effect : public <a href="class128773.html#refclass128773"><b>AbstractMO</b></a>, public <a href="class128517.html#refclass128517"><b>MObject</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact129541"><b>effect</b></a></p><div class="sub">
<a name="refattribute128901"></a>
<table><tr><td><div class="element">Attribut <b>plugin</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # plugin : string</li><li>C++ : protected: string plugin</li></ul><p>Identifier of the Plugin to be used<br /></p></div>
<p>Identifier of the Plugin to be used<br /></p><p>Declaration :</p><ul><li>Uml : # plugin : string</li><li>C++ : protected: string plugin</li></ul></div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
</body>
</html>

6
doc/devel/uml/class129333.html
View file

@ -16,11 +16,11 @@
<!-- ============================================================= -->
<a name="refclass129333"></a>
<p>Declaration :</p><ul><li>C++ : class FileProvider </li></ul><p>This is the Factory for Files, whenever something wants to use some file (or temporary storage), This Factory will hand out some smart/shared pointer to a File object which will be used to retrieve Frames.<br /></p><div class="sub">
<p>This is the Factory for Files, whenever something wants to use some file (or temporary storage), This Factory will hand out some smart/shared pointer to a File object which will be used to retrieve Frames.<br /></p><p>Declaration :</p><ul><li>C++ : class FileProvider </li></ul><div class="sub">
<a name="refrelation129034"></a>
<table><tr><td><div class="element">Relation <b>files (&lt;aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # files : <a href="class128181.html#refclass128181"><b>File</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class128181.html#refclass128181"><b>File</b></a> * files</li></ul><a name="refoperation128010"></a>
<table><tr><td><div class="element">Operation <b>useFile</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + useFile(in name : string, in mode : ) : <a href="class128778.html#refclass128778"><b>FileReference</b></a></li><li>C++ : public: <a href="class128778.html#refclass128778"><b>FileReference</b></a> useFile()</li></ul><p>Announces that the application intends to use this file with mode (READ|WRITE|READWRITE)<br /></p><a name="refoperation128138"></a>
<table><tr><td><div class="element">Operation <b>useTemporaryStorage</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + useTemporaryStorage(in type : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>) : <a href="class128778.html#refclass128778"><b>FileReference</b></a></li><li>C++ : public: <a href="class128778.html#refclass128778"><b>FileReference</b></a> useTemporaryStorage()</li></ul><p>Provides a pool for interminate frames<br /></p></div>
<table><tr><td><div class="element">Operation <b>useFile</b></div></td></tr></table><p>Announces that the application intends to use this file with mode (READ|WRITE|READWRITE)<br /></p><p>Declaration :</p><ul><li>Uml : + useFile(in name : string, in mode : ) : <a href="class128778.html#refclass128778"><b>FileReference</b></a></li><li>C++ : public: <a href="class128778.html#refclass128778"><b>FileReference</b></a> useFile()</li></ul><a name="refoperation128138"></a>
<table><tr><td><div class="element">Operation <b>useTemporaryStorage</b></div></td></tr></table><p>Provides a pool for interminate frames<br /></p><p>Declaration :</p><ul><li>Uml : + useTemporaryStorage(in type : <a href="class128949.html#refclass128949"><b>FrameDescriptor</b></a>) : <a href="class128778.html#refclass128778"><b>FileReference</b></a></li><li>C++ : public: <a href="class128778.html#refclass128778"><b>FileReference</b></a> useTemporaryStorage()</li></ul></div>
<p>All public operations : <a href="class129333.html#refoperation128010"><b>useFile</b></a> , <a href="class129333.html#refoperation128138"><b>useTemporaryStorage</b></a> </p>
</body>
</html>

4
doc/devel/uml/class129413.html
View file

@ -20,9 +20,9 @@
<a name="refrelation130565"></a>
<table><tr><td><div class="element">Relation <b>anchor (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # anchor : <a href="class128517.html#refclass128517"><b>MObject</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128517.html#refclass128517"><b>MObject</b></a>* anchor</li></ul><a name="refattribute128133"></a>
<table><tr><td><div class="element">Attribut <b>relType</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # relType : <a href="class133893.html#refclass133893"><b>RelType</b></a></li><li>C++ : protected: <a href="class133893.html#refclass133893"><b>RelType</b></a> relType</li></ul><p>the kind of relation denoted by this Placement<br /></p><a name="refattribute129029"></a>
<p>the kind of relation denoted by this Placement<br /></p><p>Declaration :</p><ul><li>Uml : # relType : <a href="class133893.html#refclass133893"><b>RelType</b></a></li><li>C++ : protected: <a href="class133893.html#refclass133893"><b>RelType</b></a> relType</li></ul><a name="refattribute129029"></a>
<table><tr><td><div class="element">Attribut <b>offset</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # offset : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> offset</li></ul><p>Offset the actual position by this (time) value relative to the anchor point. TODO: Representation?<br /></p><table><tr><td><div class="element">Class <b><a href="class133893.html#refclass133893"><b>RelType</b></a></b></div></td></tr></table>
<p>Offset the actual position by this (time) value relative to the anchor point. TODO: Representation?<br /></p><p>Declaration :</p><ul><li>Uml : # offset : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> offset</li></ul><table><tr><td><div class="element">Class <b><a href="class133893.html#refclass133893"><b>RelType</b></a></b></div></td></tr></table>
</div>
</body>
</html>

6
doc/devel/uml/class129541.html
View file

@ -16,11 +16,11 @@
<!-- ============================================================= -->
<a name="refclass129541"></a>
<p>Declaration :</p><ul><li>C++ : class Allocation : public <a href="class139909.html#refclass139909"><b>LocatingPin</b></a> </li></ul><p>Directly inherited by : <a href="class130181.html#refclass130181"><b>Constraint</b></a> <a href="class130053.html#refclass130053"><b>Wish</b></a> </p>
<p>a directive to place a MObject in a specific way<br /></p><p>Artifact : <a href="index.html#refartifact130053"><b>allocation</b></a></p><div class="sub">
<p>a directive to place a MObject in a specific way<br /></p><p>Declaration :</p><ul><li>C++ : class Allocation : public <a href="class139909.html#refclass139909"><b>LocatingPin</b></a> </li></ul><p>Directly inherited by : <a href="class130181.html#refclass130181"><b>Constraint</b></a> <a href="class130053.html#refclass130053"><b>Wish</b></a> </p>
<p>Artifact : <a href="index.html#refartifact130053"><b>allocation</b></a></p><div class="sub">
<a name="refattribute128773"></a>
<table><tr><td><div class="element">Attribut <b>repr</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # repr : string</li><li>C++ : protected: string repr</li></ul><p>human readable representation of the condition characterizing this allocaton, e.g. "t &gt;= 10"<br /></p><a name="refoperation131205"></a>
<p>human readable representation of the condition characterizing this allocaton, e.g. "t &gt;= 10"<br /></p><p>Declaration :</p><ul><li>Uml : # repr : string</li><li>C++ : protected: string repr</li></ul><a name="refoperation131205"></a>
<table><tr><td><div class="element">Operation <b>get_repr</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + get_repr() : string</li><li>C++ : public: inline const string getRepr () const </li></ul></div>
<p>All public operations : <a href="class129541.html#refoperation131205"><b>get_repr</b></a> </p>
</body>

3
doc/devel/uml/class129797.html
View file

@ -16,7 +16,8 @@
<!-- ============================================================= -->
<a name="refclass129797"></a>
<p>Declaration :</p><ul><li>C++ : class ExplicitPlacement : public <a href="class128645.html#refclass128645"><b>Placement</b></a> </li><li>Java : public interface ExplicitPlacement </li></ul><p>Artifact : <a href="index.html#refartifact129157"><b>explicitplacement</b></a></p><div class="sub">
<p>Declaration :</p><ul><li>C++ : class ExplicitPlacement : public <a href="class128645.html#refclass128645"><b>Placement</b></a> </li><li>Java : public interface ExplicitPlacement </li></ul><p>Artifact : <a href="index.html#refartifact129157"><b>explicitplacement</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refattribute128261"></a>
<table><tr><td><div class="element">Attribut <b>time</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # time : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> time</li></ul><a name="refattribute128389"></a>

2
doc/devel/uml/class129925.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass129925"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class Auto : public <a href="class129157.html#refclass129157"><b>Meta</b></a>, public <a href="class134661.html#refclass134661"><b>ParamProvider</b></a>&lt;VAL&gt; </li></ul><p>Automation data for some parameter (i.e. a time varying function)<br /></p><p>Artifact : <a href="index.html#refartifact130309"><b>auto</b></a></p><div class="sub">
<p>Automation data for some parameter (i.e. a time varying function)<br /></p><p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class Auto : public <a href="class129157.html#refclass129157"><b>Meta</b></a>, public <a href="class134661.html#refclass134661"><b>ParamProvider</b></a>&lt;VAL&gt; </li></ul><p>Artifact : <a href="index.html#refartifact130309"><b>auto</b></a></p><div class="sub">
<a name="refoperation131077"></a>
<table><tr><td><div class="element">Operation <b>getValue</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getValue() : VAL</li><li>C++ : public: VAL getValue () const </li></ul></div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> , <a href="class129925.html#refoperation131077"><b>getValue</b></a> , <a href="class134661.html#refoperation130949"><b>getValue</b></a> </p>

3
doc/devel/uml/class130309.html
View file

@ -16,5 +16,6 @@
<!-- ============================================================= -->
<a name="refclass130309"></a>
<p>Declaration :</p><ul><li>C++ : class ControllerFacade </li></ul><p>Provides unified access to the Proc-Subsystem Controller. Especially, this Facade class provides the functions to get a render engine to carry out actual renderings.<br /></p><p>Artifact : <a href="index.html#refartifact131589"><b>controllerfacade</b></a>, Component(s) : <a href="index.html#refcomponent129541"><b>ControllerFacade</b></a></p></body>
<p>Provides unified access to the Proc-Subsystem Controller. Especially, this Facade class provides the functions to get a render engine to carry out actual renderings.<br /></p><p>Declaration :</p><ul><li>C++ : class ControllerFacade </li></ul><p>Artifact : <a href="index.html#refartifact131589"><b>controllerfacade</b></a>, Component(s) : <a href="index.html#refcomponent129541"><b>ControllerFacade</b></a></p><p>Stereotype: boundary</p>
</body>
</html>

4
doc/devel/uml/class130437.html
View file

@ -16,9 +16,9 @@
<!-- ============================================================= -->
<a name="refclass130437"></a>
<p>Declaration :</p><ul><li>C++ : class PathManager </li></ul><p>While building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state)<br /></p><p>Artifact : <a href="index.html#refartifact131717"><b>pathmanager</b></a>, Component(s) : <a href="index.html#refcomponent129285"><b>RenderPathManager</b></a></p><div class="sub">
<p>While building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state)<br /></p><p>Declaration :</p><ul><li>C++ : class PathManager </li></ul><p>Artifact : <a href="index.html#refartifact131717"><b>pathmanager</b></a>, Component(s) : <a href="index.html#refcomponent129285"><b>RenderPathManager</b></a></p><div class="sub">
<a name="refoperation128261"></a>
<table><tr><td><div class="element">Operation <b>buildProcessor</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + buildProcessor() : <a href="class131461.html#refclass131461"><b>Processor</b></a></li><li>C++ : public: <a href="class131461.html#refclass131461"><b>Processor</b></a> buildProcessor () </li></ul></div>
<table><tr><td><div class="element">Operation <b>buildProcessor</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + buildProcessor() : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a></li><li>C++ : public: <a href="class131461.html#refclass131461"><b>RenderGraph</b></a> buildProcessor () </li></ul></div>
<p>All public operations : <a href="class130437.html#refoperation128261"><b>buildProcessor</b></a> </p>
</body>
</html>

5
doc/devel/uml/class130565.html
View file

@ -16,9 +16,10 @@
<!-- ============================================================= -->
<a name="refclass130565"></a>
<p>Declaration :</p><ul><li>C++ : class BuilderFacade </li></ul><p>Provides unified access to the builder functionality. While individual components of the builder subsystem may be called if necessary or suitable, it is usually better to do all extern invocations via the high level methods of this Facade<br /></p><p>Artifact : <a href="index.html#refartifact130437"><b>builderfacade</b></a>, Component(s) : <a href="index.html#refcomponent128261"><b>Controller</b></a></p><div class="sub">
<p>Provides unified access to the builder functionality. While individual components of the builder subsystem may be called if necessary or suitable, it is usually better to do all extern invocations via the high level methods of this Facade<br /></p><p>Declaration :</p><ul><li>C++ : class BuilderFacade </li></ul><p>Artifact : <a href="index.html#refartifact130437"><b>builderfacade</b></a>, Component(s) : <a href="index.html#refcomponent128261"><b>Controller</b></a></p><p>Stereotype: boundary</p>
<div class="sub">
<a name="refoperation128517"></a>
<table><tr><td><div class="element">Operation <b>buildEngine</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + buildEngine() : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a></li><li>C++ : public: <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> buildEngine () </li></ul><p>Main Operation of the Builder: create a render engine for a given part of the timeline<br /></p></div>
<table><tr><td><div class="element">Operation <b>buildEngine</b></div></td></tr></table><p>Main Operation of the Builder: create a render engine for a given part of the timeline<br /></p><p>Declaration :</p><ul><li>Uml : + buildEngine() : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a></li><li>C++ : public: <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> buildEngine () </li></ul></div>
<p>All public operations : <a href="class130565.html#refoperation128517"><b>buildEngine</b></a> </p>
</body>
</html>

4
doc/devel/uml/class130821.html
View file

@ -16,9 +16,9 @@
<!-- ============================================================= -->
<a name="refclass130821"></a>
<p>Declaration :</p><ul><li>C++ : class ConManager </li></ul><p>Connection Manager, used to build the connections between render engine nodes, if these nodes need to cooperate besides the normal "data pull" operation. Esp., the Connection Manager knows how to wire up the effect's parameters with the corresponding ParamProviders (autmation) in the Session<br /></p><p>Artifact : <a href="index.html#refartifact130693"><b>conmanager</b></a></p><div class="sub">
<p>Connection Manager, used to build the connections between render engine nodes, if these nodes need to cooperate besides the normal "data pull" operation. Esp., the Connection Manager knows how to wire up the effect's parameters with the corresponding ParamProviders (autmation) in the Session<br /></p><p>Declaration :</p><ul><li>C++ : class ConManager </li></ul><p>Artifact : <a href="index.html#refartifact130693"><b>conmanager</b></a></p><div class="sub">
<a name="refoperation129029"></a>
<table><tr><td><div class="element">Operation <b>getConnection</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getConnection() : int</li><li>C++ : public: int getConnection () </li></ul><p>TODO<br /></p></div>
<table><tr><td><div class="element">Operation <b>getConnection</b></div></td></tr></table><p>TODO<br /></p><p>Declaration :</p><ul><li>Uml : + getConnection() : int</li><li>C++ : public: int getConnection () </li></ul></div>
<p>All public operations : <a href="class130821.html#refoperation129029"><b>getConnection</b></a> </p>
</body>
</html>

2
doc/devel/uml/class130949.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass130949"></a>
<p>Declaration :</p><ul><li>C++ : class RenderState </li></ul><p>Encapsulates the logic used to get a "current render process" in accordance to the currentyl applicable controller settings. The provided StateProxy serves to hold any mutalbe state used in the render process, so the rest of the render engine can be stateless.<br /></p><p>Artifact : <a href="index.html#refartifact131845"><b>renderstate</b></a></p><div class="sub">
<p>Encapsulates the logic used to get a "current render process" in accordance to the currentyl applicable controller settings. The provided StateProxy serves to hold any mutalbe state used in the render process, so the rest of the render engine can be stateless.<br /></p><p>Declaration :</p><ul><li>C++ : class RenderState </li></ul><p>Artifact : <a href="index.html#refartifact131845"><b>renderstate</b></a></p><div class="sub">
<a name="refoperation128389"></a>
<table><tr><td><div class="element">Operation <b>getStateProxy</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getStateProxy() : <a href="class132741.html#refclass132741"><b>State</b></a></li><li>C++ : public: <a href="class132741.html#refclass132741"><b>State</b></a> getStateProxy () </li></ul></div>
<p>All public operations : <a href="class130949.html#refoperation128389"><b>getStateProxy</b></a> </p>

2
doc/devel/uml/class131077.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass131077"></a>
<p>Declaration :</p><ul><li>C++ : class Assembler </li></ul><p>This is the actual building facility: provided the correct tools and associations, it serves to build and connect the individual ProcNode objects<br /></p><p>Artifact : <a href="index.html#refartifact130821"><b>assembler</b></a></p><div class="sub">
<p>This is the actual building facility: provided the correct tools and associations, it serves to build and connect the individual ProcNode objects<br /></p><p>Declaration :</p><ul><li>C++ : class Assembler </li></ul><p>Artifact : <a href="index.html#refartifact130821"><b>assembler</b></a></p><div class="sub">
<a name="refoperation128901"></a>
<table><tr><td><div class="element">Operation <b>build</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + build() : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a></li><li>C++ : public: <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> build () </li></ul></div>
<p>All public operations : <a href="class131077.html#refoperation128901"><b>build</b></a> </p>

7
doc/devel/uml/class131333.html
View file

@ -16,10 +16,11 @@
<!-- ============================================================= -->
<a name="refclass131333"></a>
<p>Declaration :</p><ul><li>C++ : class RenderEngine : public <a href="class131461.html#refclass131461"><b>Processor</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact131973"><b>renderengine</b></a></p><div class="sub">
<p>Declaration :</p><ul><li>C++ : class RenderEngine : public <a href="class131461.html#refclass131461"><b>RenderGraph</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact131973"><b>renderengine</b></a></p><div class="sub">
<a name="refoperation129413"></a>
<table><tr><td><div class="element">Operation <b>play</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + play() : void</li><li>C++ : public: void play () </li></ul><p>TODO: will probably be handled differently (see Cehteh)<br /></p><a name="refrelation132485"></a>
<table><tr><td><div class="element">Relation <b>renderSegments (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - renderSegments : <a href="class131461.html#refclass131461"><b>Processor</b></a>, multiplicity : 0..*</li><li>C++ : private: list&lt;<a href="class131461.html#refclass131461"><b>Processor</b></a>&gt; renderSegments</li></ul></div>
<table><tr><td><div class="element">Operation <b>play</b></div></td></tr></table><p>TODO: will probably be handled differently (see Cehteh)<br /></p><p>Declaration :</p><ul><li>Uml : + play() : void</li><li>C++ : public: void play () </li></ul><a name="refrelation132485"></a>
<table><tr><td><div class="element">Relation <b>renderSegments (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - renderSegments : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a>, multiplicity : 0..*</li><li>C++ : private: list&lt;<a href="class131461.html#refclass131461"><b>RenderGraph</b></a>&gt; renderSegments</li></ul><p>Stereotype: list</p>
</div>
<p>All public operations : <a href="class131333.html#refoperation129413"><b>play</b></a> </p>
</body>
</html>

15
doc/devel/uml/class131461.html
View file

@ -4,25 +4,26 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Processor</title>
<title>Class RenderGraph</title>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body bgcolor="#ffffff">
<div class = "title">Class Processor</div>
<div class = "title">Class RenderGraph</div>
<p></p>
<!-- ============================================================= -->
<a name="refclass131461"></a>
<p>Declaration :</p><ul><li>C++ : class Processor </li></ul><p>Directly inherited by : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> </p>
<p>Artifact : <a href="index.html#refartifact132101"><b>processor</b></a></p><div class="sub">
<p>Declaration :</p><ul><li>C++ : class RenderGraph </li></ul><p>Directly inherited by : <a href="class131333.html#refclass131333"><b>RenderEngine</b></a> </p>
<p>Artifact : <a href="index.html#refartifact132101"><b>rendergraph</b></a></p><div class="sub">
<a name="refrelation132613"></a>
<table><tr><td><div class="element">Relation <b>output (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # output : <a href="class131589.html#refclass131589"><b>ExitNode</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class131589.html#refclass131589"><b>ExitNode</b></a> * output</li></ul><a name="refattribute129413"></a>
<table><tr><td><div class="element">Relation <b>pipes (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # pipes : <a href="class131589.html#refclass131589"><b>ExitNode</b></a>, multiplicity : 1..*</li><li>C++ : protected: <a href="class131589.html#refclass131589"><b>ExitNode</b></a> * pipes</li></ul><p>Stereotype: list</p>
<a name="refattribute129413"></a>
<table><tr><td><div class="element">Attribut <b>start</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # start : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> start</li></ul><p>begin of the timerange covered by this processor<br /></p><a name="refattribute129541"></a>
<p>begin of the timerange covered by this processor<br /></p><p>Declaration :</p><ul><li>Uml : # start : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> start</li></ul><a name="refattribute129541"></a>
<table><tr><td><div class="element">Attribut <b>end</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # end : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> end</li></ul><p>end of the timerange (excl)<br /></p></div>
<p>end of the timerange (excl)<br /></p><p>Declaration :</p><ul><li>Uml : # end : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> end</li></ul></div>
</body>
</html>

2
doc/devel/uml/class131589.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass131589"></a>
<p>Declaration :</p><ul><li>C++ : class ExitNode : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>The output of the render pipeline. Pulling from such exit nodes actually ivokes the render process<br /></p><p>Artifact : <a href="index.html#refartifact132229"><b>exitnode</b></a></p><div class="sub">
<p>The output of the render pipeline. Pulling from such exit nodes actually ivokes the render process<br /></p><p>Declaration :</p><ul><li>C++ : class ExitNode : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact132229"><b>exitnode</b></a></p><div class="sub">
</div>
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
</body>

16
doc/devel/uml/class131717.html
View file

@ -16,14 +16,18 @@
<!-- ============================================================= -->
<a name="refclass131717"></a>
<p>Declaration :</p><ul><li>C++ : class ProcNode </li><li>Java : public interface ProcNode </li></ul><p>Directly inherited by : <a href="class131589.html#refclass131589"><b>ExitNode</b></a> <a href="class131973.html#refclass131973"><b>Link</b></a> <a href="class133765.html#refclass133765"><b>Source</b></a> <a href="class131845.html#refclass131845"><b>Trafo</b></a> </p>
<p>Key abstraction of the Render Engine: A Data processing Node<br /></p><p>Artifact : <a href="index.html#refartifact132357"><b>procnode</b></a></p><div class="sub">
<p>Key abstraction of the Render Engine: A Data processing Node<br /></p><p>Declaration :</p><ul><li>C++ : class ProcNode </li><li>Java : public interface ProcNode </li></ul><p>Directly inherited by : <a href="class131589.html#refclass131589"><b>ExitNode</b></a> <a href="class131973.html#refclass131973"><b>Link</b></a> <a href="class133765.html#refclass133765"><b>Source</b></a> <a href="class131845.html#refclass131845"><b>Trafo</b></a> </p>
<p>Artifact : <a href="index.html#refartifact132357"><b>procnode</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refrelation136965"></a>
<table><tr><td><div class="element">Relation <b>datasrc (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # datasrc : <a href="class131717.html#refclass131717"><b>ProcNode</b></a></li><li>C++ : protected: <a href="class131717.html#refclass131717"><b>ProcNode</b></a> * datasrc</li></ul><p>The predecessor in a processing pipeline, i.e. a source to get data to be processed<br /></p><a name="refrelation137861"></a>
<table><tr><td><div class="element">Relation <b>params (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # params : <a href="class134533.html#refclass134533"><b>Parameter</b></a>, multiplicity : 1..*</li><li>C++ : protected: vector&lt;<a href="class134533.html#refclass134533"><b>Parameter</b></a>&gt; params</li></ul><a name="refrelation152581"></a>
<table><tr><td><div class="element">Relation <b>predecessors (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # predecessors : <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a> predecessors</li></ul><a name="refoperation135685"></a>
<table><tr><td><div class="element">Relation <b>datasrc (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>The predecessor in a processing pipeline, i.e. a source to get data to be processed<br /></p><p>Declaration :</p><ul><li>Uml : # datasrc : <a href="class131717.html#refclass131717"><b>ProcNode</b></a></li><li>C++ : protected: <a href="class131717.html#refclass131717"><b>ProcNode</b></a> * datasrc</li></ul><a name="refrelation137861"></a>
<table><tr><td><div class="element">Relation <b>params (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # params : <a href="class134533.html#refclass134533"><b>Parameter</b></a>, multiplicity : 1..*</li><li>C++ : protected: vector&lt;<a href="class134533.html#refclass134533"><b>Parameter</b></a>&gt; params</li></ul><p>Stereotype: vector</p>
<a name="refrelation152581"></a>
<table><tr><td><div class="element">Relation <b>predecessors (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # predecessors : <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a> predecessors</li></ul><p>Stereotype: array</p>
<a name="refoperation135685"></a>
<table><tr><td><div class="element">Operation <b>pull</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + pull() : </li><li>C++ : public: pull () </li></ul><a name="refoperation136069"></a>
<table><tr><td><div class="element">Operation <b>process</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + process() : </li><li>C++ : public: process () </li></ul></div>
<table><tr><td><div class="element">Operation <b>process</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + process() : </li><li>C++ : public: process () </li></ul><a name="refrelation166789"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a></li><li>C++ : protected: <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a>* </li></ul></div>
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
</body>
</html>

2
doc/devel/uml/class132229.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass132229"></a>
<p>Declaration :</p><ul><li>C++ : class Projector : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Special video processing node used to scale and translate image data.<br /></p><p>Artifact : <a href="index.html#refartifact132869"><b>projector</b></a></p><div class="sub">
<p>Special video processing node used to scale and translate image data.<br /></p><p>Declaration :</p><ul><li>C++ : class Projector : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact132869"><b>projector</b></a></p><div class="sub">
</div>
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
</body>

2
doc/devel/uml/class132485.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass132485"></a>
<p>Declaration :</p><ul><li>C++ : class PluginAdapter : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Adapter used to integrage an effects processor in the render pipeline<br /></p><p>Artifact : <a href="index.html#refartifact133125"><b>pluginadapter</b></a></p><div class="sub">
<p>Adapter used to integrage an effects processor in the render pipeline<br /></p><p>Declaration :</p><ul><li>C++ : class PluginAdapter : public <a href="class131845.html#refclass131845"><b>Trafo</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact133125"><b>pluginadapter</b></a></p><div class="sub">
</div>
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
</body>

6
doc/devel/uml/class132741.html
View file

@ -17,9 +17,11 @@
<a name="refclass132741"></a>
<p>Declaration :</p><ul><li>C++ : class State </li><li>Java : public interface State </li></ul><p>Directly inherited by : <a href="class142597.html#refclass142597"><b>StateAdapter</b></a> <a href="class142469.html#refclass142469"><b>StateProxy</b></a> </p>
<p>Artifact : <a href="index.html#refartifact130949"><b>stateproxy</b></a>, Component(s) : <a href="index.html#refcomponent128005"><b>Builder</b></a></p><div class="sub">
<p>Artifact : <a href="index.html#refartifact130949"><b>stateproxy</b></a>, Component(s) : <a href="index.html#refcomponent128005"><b>Builder</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refrelation135941"></a>
<table><tr><td><div class="element">Relation <b>currFrame (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # currFrame : <a href="class133253.html#refclass133253"><b>Frame</b></a></li><li>C++ : protected: <a href="class133253.html#refclass133253"><b>Frame</b></a> * currFrame</li></ul><a name="refoperation135813"></a>
<table><tr><td><div class="element">Relation <b>currFrame (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # currFrame : <a href="class133253.html#refclass133253"><b>Frame</b></a></li><li>C++ : protected: <a href="class133253.html#refclass133253"><b>Frame</b></a> * currFrame</li></ul><p>Stereotype: vector</p>
<a name="refoperation135813"></a>
<table><tr><td><div class="element">Operation <b>fetch</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + fetch() : </li><li>C++ : public: fetch () </li></ul><a name="refoperation135941"></a>
<table><tr><td><div class="element">Operation <b>allocateBuffer</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + allocateBuffer() : </li><li>C++ : public: allocateBuffer () </li></ul><a name="refoperation136197"></a>
<table><tr><td><div class="element">Operation <b>releaseBuffer</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + releaseBuffer() : </li><li>C++ : public: releaseBuffer () </li></ul><a name="refoperation136325"></a>

5
doc/devel/uml/class133253.html
View file

@ -16,6 +16,7 @@
<!-- ============================================================= -->
<a name="refclass133253"></a>
<p>Declaration :</p><ul><li>C++ : class Frame </li><li>Java : public interface Frame </li></ul><p>Directly inherited by : <a href="class133381.html#refclass133381"><b>AFrame</b></a> <a href="class133637.html#refclass133637"><b>GLBuf</b></a> <a href="class133509.html#refclass133509"><b>VFrame</b></a> </p>
<p>TODO: how to relate to Cehteh's Frame entity in the Backend?<br />The latter is the fundamental Frame entity, wheras this Object rather represents a buffer set containing frame date<br /></p><p>Artifact : <a href="index.html#refartifact133765"><b>frame</b></a></p></body>
<p>TODO: how to relate to Cehteh's Frame entity in the Backend?<br />The latter is the fundamental Frame entity, wheras this Object rather represents a buffer set containing frame date<br /></p><p>Declaration :</p><ul><li>C++ : class Frame </li><li>Java : public interface Frame </li></ul><p>Directly inherited by : <a href="class133381.html#refclass133381"><b>AFrame</b></a> <a href="class133637.html#refclass133637"><b>GLBuf</b></a> <a href="class133509.html#refclass133509"><b>VFrame</b></a> </p>
<p>Artifact : <a href="index.html#refartifact133765"><b>frame</b></a></p><p>Stereotype: interface</p>
</body>
</html>

2
doc/devel/uml/class133765.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass133765"></a>
<p>Declaration :</p><ul><li>C++ : class Source : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>Source Node: represents a media source to pull data from.<br /></p><p>Artifact : <a href="index.html#refartifact134277"><b>source</b></a></p><div class="sub">
<p>Source Node: represents a media source to pull data from.<br /></p><p>Declaration :</p><ul><li>C++ : class Source : public <a href="class131717.html#refclass131717"><b>ProcNode</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact134277"><b>source</b></a></p><div class="sub">
</div>
<p>All public operations : <a href="class131717.html#refoperation136069"><b>process</b></a> , <a href="class131717.html#refoperation135685"><b>pull</b></a> </p>
</body>

3
doc/devel/uml/class133893.html
View file

@ -16,7 +16,8 @@
<!-- ============================================================= -->
<a name="refclass133893"></a>
<p>Declaration :</p><ul><li>C++ : enum RelType </li><li>Java : public enum RelType </li></ul><p>the possible kinds of RelativePlacements<br /></p><p>nested in <a href="class129413.html#refclass129413"><b>RelativeLocation</b></a></p>
<p>the possible kinds of RelativePlacements<br /></p><p>Declaration :</p><ul><li>C++ : enum RelType </li><li>Java : public enum RelType </li></ul><p>nested in <a href="class129413.html#refclass129413"><b>RelativeLocation</b></a></p>
<p>Stereotype: enum</p>
<div class="sub">
<p>Items :</p><ul>
<li>SAMETIME</li>

3
doc/devel/uml/class134021.html
View file

@ -17,7 +17,8 @@
<a name="refclass134021"></a>
<p>Declaration :</p><ul><li>C++ : class Buildable : public <a href="class140165.html#refclass140165"><b>Visitable</b></a> </li><li>Java : public interface Buildable </li></ul><p>Directly inherited by : <a href="class128517.html#refclass128517"><b>MObject</b></a> </p>
<p>Artifact : <a href="index.html#refartifact131077"><b>buildable</b></a></p><div class="sub">
<p>Artifact : <a href="index.html#refartifact131077"><b>buildable</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refoperation129669"></a>
<table><tr><td><div class="element">Operation <b>apply</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : abstract, + apply(inout providedTool : <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>) : void</li><li>C++ : public: virtual void apply (<a href="class134149.html#refclass134149"><b>BuilderTool</b></a>&amp; providedTool) = 0 </li></ul></div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>

7
doc/devel/uml/class134149.html
View file

@ -16,10 +16,11 @@
<!-- ============================================================= -->
<a name="refclass134149"></a>
<p>Declaration :</p><ul><li>C++ : class BuilderTool : public <a href="class140037.html#refclass140037"><b>Tool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a>&lt;&gt; </li><li>Java : public interface BuilderTool </li></ul><p>Directly inherited by : <a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a> <a href="class134277.html#refclass134277"><b>SegmentationTool</b></a> </p>
<p>Used according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes<br /></p><p>Artifact : <a href="index.html#refartifact131205"><b>buildertool</b></a></p><div class="sub">
<p>Used according to the visitor pattern: each Tool contains the concrete implementation for one task to be done to the various MObject classes<br /></p><p>Declaration :</p><ul><li>C++ : class BuilderTool : public <a href="class140037.html#refclass140037"><b>Tool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a>&lt;&gt; </li><li>Java : public interface BuilderTool </li></ul><p>Directly inherited by : <a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a> <a href="class134277.html#refclass134277"><b>SegmentationTool</b></a> </p>
<p>Artifact : <a href="index.html#refartifact131205"><b>buildertool</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refoperation129797"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : abstract, + treat(in mElement : <a href="class134021.html#refclass134021"><b>Buildable</b></a>) : void</li><li>C++ : public: virtual void treat (const <a href="class134021.html#refclass134021"><b>Buildable</b></a>&amp; mElement) = 0 </li></ul><p>This operation is to be overloaded for the specific MObject subclasses to be treated.<br /></p></div>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>This operation is to be overloaded for the specific MObject subclasses to be treated.<br /></p><p>Declaration :</p><ul><li>Uml : abstract, + treat(in mElement : <a href="class134021.html#refclass134021"><b>Buildable</b></a>) : void</li><li>C++ : public: virtual void treat (const <a href="class134021.html#refclass134021"><b>Buildable</b></a>&amp; mElement) = 0 </li></ul></div>
<p>All public operations : <a href="class140293.html#refoperation134405"><b>treat</b></a> , <a href="class134149.html#refoperation129797"><b>treat</b></a> </p>
</body>
</html>

7
doc/devel/uml/class134277.html
View file

@ -16,12 +16,15 @@
<!-- ============================================================= -->
<a name="refclass134277"></a>
<p>Declaration :</p><ul><li>C++ : class SegmentationTool : public <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a>&lt;&gt; </li></ul><p>Tool implementation for deriving a partitioning of the current timeline such, that each segement has a constant configuration. "Constant" means here, that any remaining changes over time can be represented by automation solely, without the need to change the node connections.<br /></p><p>Artifact : <a href="index.html#refartifact131333"><b>segmentationtool</b></a></p><div class="sub">
<p>Tool implementation for deriving a partitioning of the current timeline such, that each segement has a constant configuration. "Constant" means here, that any remaining changes over time can be represented by automation solely, without the need to change the node connections.<br /></p><p>Declaration :</p><ul><li>C++ : class SegmentationTool : public <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a>&lt;&gt; </li></ul><p>Artifact : <a href="index.html#refartifact131333"><b>segmentationtool</b></a></p><div class="sub">
<a name="refoperation129925"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(in something : <a href="class134021.html#refclass134021"><b>Buildable</b></a>) : void</li><li>C++ : public: void treat (const <a href="class134021.html#refclass134021"><b>Buildable</b></a>&amp; something) </li></ul><a name="refoperation130181"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(in clip : <a href="class128901.html#refclass128901"><b>Clip</b></a>) : void</li><li>C++ : public: void treat (const <a href="class128901.html#refclass128901"><b>Clip</b></a>&amp; clip) </li></ul><a name="refoperation130053"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(in effect : <a href="class129029.html#refclass129029"><b>Effect</b></a>) : void</li><li>C++ : public: void treat (const <a href="class129029.html#refclass129029"><b>Effect</b></a>&amp; effect) </li></ul><a name="refrelation139013"></a>
<table><tr><td><div class="element">Relation <b>segments (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # segments : <a href="class135173.html#refclass135173"><b>Segment</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class135173.html#refclass135173"><b>Segment</b></a>&gt; segments</li></ul><p>the partitioning of the Timeline to be created by this tool.<br /></p></div>
<table><tr><td><div class="element">Relation <b>segments (&lt;directional composition&gt;)</b></div></td></tr></table><p>the partitioning of the Timeline to be created by this tool.<br /></p><p>Declaration :</p><ul><li>Uml : # segments : <a href="class135173.html#refclass135173"><b>Segment</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class135173.html#refclass135173"><b>Segment</b></a>&gt; segments</li></ul><p>Stereotype: list</p>
<a name="refrelation163461"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class147333.html#refclass147333"><b>Segmentation</b></a></li><li>C++ : protected: <a href="class147333.html#refclass147333"><b>Segmentation</b></a>* </li></ul><p>Stereotype: create</p>
</div>
<p>All public operations : <a href="class140293.html#refoperation134405"><b>treat</b></a> , <a href="class134149.html#refoperation129797"><b>treat</b></a> , <a href="class134277.html#refoperation130181"><b>treat</b></a> , <a href="class134277.html#refoperation130053"><b>treat</b></a> , <a href="class134277.html#refoperation129925"><b>treat</b></a> </p>
</body>
</html>

4
doc/devel/uml/class134405.html
View file

@ -16,14 +16,14 @@
<!-- ============================================================= -->
<a name="refclass134405"></a>
<p>Declaration :</p><ul><li>C++ : class NodeCreatorTool : public <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a>&lt;&gt; </li></ul><p>This Tool implementation plays the central role in the buld process: given a MObject from Session, it is able to attach ProcNodes to the render engine under construction such as to reflect the properties of the MObject in the actual render.<br /></p><p>Artifact : <a href="index.html#refartifact131461"><b>nodecreatertool</b></a></p><div class="sub">
<p>This Tool implementation plays the central role in the buld process: given a MObject from Session, it is able to attach ProcNodes to the render engine under construction such as to reflect the properties of the MObject in the actual render.<br /></p><p>Declaration :</p><ul><li>C++ : class NodeCreatorTool : public <a href="class134149.html#refclass134149"><b>BuilderTool</b></a>, public <a href="class140293.html#refclass140293"><b>Applicable</b></a>&lt;&gt; </li></ul><p>Artifact : <a href="index.html#refartifact131461"><b>nodecreatertool</b></a></p><div class="sub">
<a name="refoperation130309"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout something : <a href="class134021.html#refclass134021"><b>Buildable</b></a>) : void</li><li>C++ : public: void treat (<a href="class134021.html#refclass134021"><b>Buildable</b></a>&amp; something) </li></ul><a name="refoperation130437"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout clip : <a href="class128901.html#refclass128901"><b>Clip</b></a>) : void</li><li>C++ : public: void treat (<a href="class128901.html#refclass128901"><b>Clip</b></a>&amp; clip) </li></ul><a name="refoperation130565"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout effect : <a href="class129029.html#refclass129029"><b>Effect</b></a>) : void</li><li>C++ : public: void treat (<a href="class129029.html#refclass129029"><b>Effect</b></a>&amp; effect) </li></ul><a name="refoperation130693"></a>
<table><tr><td><div class="element">Operation <b>treat</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + treat(inout auto : <a href="class129925.html#refclass129925"><b>Auto</b></a>) : void</li><li>C++ : public: void treat (<a href="class129925.html#refclass129925"><b>Auto</b></a>&amp; auto) </li></ul><a name="refattribute129797"></a>
<table><tr><td><div class="element">Attribut <b>proc</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # proc : <a href="class131461.html#refclass131461"><b>Processor</b></a></li><li>C++ : protected: <a href="class131461.html#refclass131461"><b>Processor</b></a> proc</li></ul><p>holds the Processor (Render Engine Element) to be built by the current build step<br /></p></div>
<p>holds the Processor (Render Engine Element) to be built by the current build step<br /></p><p>Declaration :</p><ul><li>Uml : # proc : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a></li><li>C++ : protected: <a href="class131461.html#refclass131461"><b>RenderGraph</b></a> proc</li></ul></div>
<p>All public operations : <a href="class140293.html#refoperation134405"><b>treat</b></a> , <a href="class134149.html#refoperation129797"><b>treat</b></a> , <a href="class134405.html#refoperation130437"><b>treat</b></a> , <a href="class134405.html#refoperation130565"><b>treat</b></a> , <a href="class134405.html#refoperation130693"><b>treat</b></a> , <a href="class134405.html#refoperation130309"><b>treat</b></a> </p>
</body>
</html>

2
doc/devel/uml/class134533.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass134533"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class Parameter </li></ul><p>Descriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated.<br /></p><p>Artifact : <a href="index.html#refartifact134405"><b>parameter</b></a>, Component(s) : <a href="index.html#refcomponent130053"><b>ProcNode</b></a></p><div class="sub">
<p>Descriptor and access object for a plugin parameter. Parameters may be provided with values from the session, and this values may be automated.<br /></p><p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class Parameter </li></ul><p>Artifact : <a href="index.html#refartifact134405"><b>parameter</b></a>, Component(s) : <a href="index.html#refcomponent130053"><b>ProcNode</b></a></p><div class="sub">
<a name="refoperation130821"></a>
<table><tr><td><div class="element">Operation <b>getValue</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getValue() : VAL</li><li>C++ : public: VAL getValue () const </li></ul><a name="refrelation138629"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # provider : <a href="class134661.html#refclass134661"><b>ParamProvider</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class134661.html#refclass134661"><b>ParamProvider</b></a>* provider</li></ul></div>

5
doc/devel/uml/class134661.html
View file

@ -16,8 +16,9 @@
<!-- ============================================================= -->
<a name="refclass134661"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class ParamProvider </li><li>Java : public interface ParamProvider&lt;VAL&gt; </li></ul><p>Directly inherited by : <a href="class129925.html#refclass129925"><b>Auto</b></a> </p>
<p>A facility to get the actual value of a plugin/effect parameter<br /></p><p>Artifact : <a href="index.html#refartifact134533"><b>paramprovider</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><div class="sub">
<p>A facility to get the actual value of a plugin/effect parameter<br /></p><p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class ParamProvider </li><li>Java : public interface ParamProvider&lt;VAL&gt; </li></ul><p>Directly inherited by : <a href="class129925.html#refclass129925"><b>Auto</b></a> </p>
<p>Artifact : <a href="index.html#refartifact134533"><b>paramprovider</b></a>, Component(s) : <a href="index.html#refcomponent128133"><b>Session</b></a></p><p>Stereotype: interface</p>
<div class="sub">
<a name="refrelation137989"></a>
<table><tr><td><div class="element">Relation <b>param (&lt;association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # param : <a href="class134533.html#refclass134533"><b>Parameter</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class134533.html#refclass134533"><b>Parameter</b></a>* param</li></ul><a name="refrelation138373"></a>
<table><tr><td><div class="element">Relation <b>ipo (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # ipo : <a href="class134789.html#refclass134789"><b>Interpolator</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class134789.html#refclass134789"><b>Interpolator</b></a>* ipo</li></ul><a name="refoperation130949"></a>

2
doc/devel/uml/class134789.html
View file

@ -16,5 +16,5 @@
<!-- ============================================================= -->
<a name="refclass134789"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class Interpolator </li></ul><p>Provides the implementation for getting the acutal value of a time varying or automated effect/plugin parameter<br /></p><p>Artifact : <a href="index.html#refartifact134661"><b>interpolator</b></a></p></body>
<p>Provides the implementation for getting the acutal value of a time varying or automated effect/plugin parameter<br /></p><p>Declaration :</p><ul><li>C++ : template&lt;class VAL&gt; class Interpolator </li></ul><p>Artifact : <a href="index.html#refartifact134661"><b>interpolator</b></a></p></body>
</html>

2
doc/devel/uml/class134917.html
View file

@ -16,5 +16,5 @@
<!-- ============================================================= -->
<a name="refclass134917"></a>
<p>Declaration :</p><ul><li>C++ : class Time </li></ul><p>denotes a temporal position (time point), based on timeline start.<br /><br />investigate posix.4 realtime timers, wrap these here<br /></p><p>Artifact : <a href="index.html#refartifact134789"><b>time</b></a>, Component(s) : <a href="index.html#refcomponent129925"><b>CommonLib</b></a></p></body>
<p>denotes a temporal position (time point), based on timeline start.<br /><br />investigate posix.4 realtime timers, wrap these here<br /></p><p>Declaration :</p><ul><li>C++ : class Time </li></ul><p>Artifact : <a href="index.html#refartifact134789"><b>time</b></a>, Component(s) : <a href="index.html#refcomponent129925"><b>CommonLib</b></a></p></body>
</html>

7
doc/devel/uml/class135173.html
View file

@ -21,7 +21,10 @@
<table><tr><td><div class="element">Attribut <b>start</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # start : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> start</li></ul><a name="refattribute130053"></a>
<table><tr><td><div class="element">Attribut <b>length</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # length : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> length</li></ul><p>duration (span) of this timeline segment.<br /></p><a name="refrelation138885"></a>
<table><tr><td><div class="element">Relation <b>elements (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # elements : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> *&gt; elements</li></ul><p>relevant MObjects comprising this segment. TODO: actually necessary??<br /></p></div>
<p>duration (span) of this timeline segment.<br /></p><p>Declaration :</p><ul><li>Uml : # length : <a href="class134917.html#refclass134917"><b>Time</b></a></li><li>C++ : protected: <a href="class134917.html#refclass134917"><b>Time</b></a> length</li></ul><a name="refrelation138885"></a>
<table><tr><td><div class="element">Relation <b>elements (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>relevant MObjects comprising this segment. TODO: actually necessary??<br /></p><p>Declaration :</p><ul><li>Uml : # elements : <a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a>, multiplicity : *</li><li>C++ : protected: list&lt;<a href="class129797.html#refclass129797"><b>ExplicitPlacement</b></a> *&gt; elements</li></ul><p>Stereotype: list</p>
<a name="refrelation163589"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class131461.html#refclass131461"><b>RenderGraph</b></a></li><li>C++ : protected: <a href="class131461.html#refclass131461"><b>RenderGraph</b></a>* </li></ul><p>Stereotype: correspondance</p>
</div>
</body>
</html>

2
doc/devel/uml/class135301.html
View file

@ -16,5 +16,5 @@
<!-- ============================================================= -->
<a name="refclass135301"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;class T&gt; class Factory </li></ul><p>a template for generating functor-like Factory objects, used to encapsulate object creation and providing access via smart-pointers only.<br /></p></body>
<p>a template for generating functor-like Factory objects, used to encapsulate object creation and providing access via smart-pointers only.<br /></p><p>Declaration :</p><ul><li>C++ : template&lt;class T&gt; class Factory </li></ul></body>
</html>

9
doc/devel/uml/class135429.html
View file

@ -16,13 +16,14 @@
<!-- ============================================================= -->
<a name="refclass135429"></a>
<p>Declaration :</p><ul><li>C++ : class Appconfig </li></ul><p>Singleton to hold inevitable global flags and constants and for performing erarly (static) global initialization tasks.<br /></p><p>Artifact : <a href="index.html#refartifact135173"><b>appconfig</b></a></p><div class="sub">
<p>Singleton to hold inevitable global flags and constants and for performing erarly (static) global initialization tasks.<br /></p><p>Declaration :</p><ul><li>C++ : class Appconfig </li></ul><p>Artifact : <a href="index.html#refartifact135173"><b>appconfig</b></a></p><p>Stereotype: singleton</p>
<div class="sub">
<a name="refattribute130181"></a>
<table><tr><td><div class="element">Attribut <b>theApp_</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : static, - theApp_ : <a href="class135429.html#refclass135429"><b>Appconfig</b></a></li><li>C++ : private: static <a href="class135429.html#refclass135429"><b>Appconfig</b></a> theApp_</li></ul><p>holds the single instance and triggers initialization<br /></p><a name="refoperation131333"></a>
<table><tr><td><div class="element">Operation <b>Appconfig</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : - Appconfig() : </li><li>C++ : private: Appconfig () </li></ul><p>perform initialization on first access. <br />A call is placed in static initialization code<br />included in lumiera.h<br /></p><a name="refoperation131461"></a>
<p>holds the single instance and triggers initialization<br /></p><p>Declaration :</p><ul><li>Uml : static, - theApp_ : <a href="class135429.html#refclass135429"><b>Appconfig</b></a></li><li>C++ : private: static <a href="class135429.html#refclass135429"><b>Appconfig</b></a> theApp_</li></ul><a name="refoperation131333"></a>
<table><tr><td><div class="element">Operation <b>Appconfig</b></div></td></tr></table><p>perform initialization on first access. <br />A call is placed in static initialization code<br />included in lumiera.h<br /></p><p>Declaration :</p><ul><li>Uml : - Appconfig() : </li><li>C++ : private: Appconfig () </li></ul><a name="refoperation131461"></a>
<table><tr><td><div class="element">Operation <b>instance</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : static, - instance() : Appconfig*</li><li>C++ : private: static Appconfig* instance () </li></ul><a name="refoperation131589"></a>
<table><tr><td><div class="element">Operation <b>get</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : static, + get(inout key : string) : string</li><li>C++ : public: static string get (string &amp; key) </li></ul><p>access the configuation value for a given key.<br />@return empty string for unknown keys, else the corresponding configuration value<br /></p></div>
<table><tr><td><div class="element">Operation <b>get</b></div></td></tr></table><p>access the configuation value for a given key.<br />@return empty string for unknown keys, else the corresponding configuration value<br /></p><p>Declaration :</p><ul><li>Uml : static, + get(inout key : string) : string</li><li>C++ : public: static string get (string &amp; key) </li></ul></div>
<p>All public operations : <a href="class135429.html#refoperation131589"><b>get</b></a> </p>
</body>
</html>

5
doc/devel/uml/class135557.html
View file

@ -20,9 +20,10 @@
<p>Artifact : <a href="index.html#refartifact135813"><b>error</b></a>, Component(s) : <a href="index.html#refcomponent129925"><b>CommonLib</b></a></p><div class="sub">
<a name="refoperation131845"></a>
<table><tr><td><div class="element">Operation <b>what</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + what() : const char*</li><li>C++ : public: virtual const char* what () const </li></ul><a name="refoperation131973"></a>
<table><tr><td><div class="element">Operation <b>rootCause</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + rootCause() : std::exception</li><li>C++ : public: std::exception rootCause () </li></ul><p>If this exception was caused by a chain of further exceptions,<br />return the first one registered in this throw sequence.<br />This works only, if every exceptions thrown as a consequence<br />of another exception is propperly constructed by passing<br />the original exception to the constructor<br /></p><a name="refattribute130309"></a>
<table><tr><td><div class="element">Operation <b>rootCause</b></div></td></tr></table><p>If this exception was caused by a chain of further exceptions,<br />return the first one registered in this throw sequence.<br />This works only, if every exceptions thrown as a consequence<br />of another exception is propperly constructed by passing<br />the original exception to the constructor<br /></p><p>Declaration :</p><ul><li>Uml : + rootCause() : std::exception</li><li>C++ : public: std::exception rootCause () </li></ul><a name="refattribute130309"></a>
<table><tr><td><div class="element">Attribut <b>cause</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : - cause : <a href="class136325.html#refclass136325"><b>std::exception</b></a></li><li>C++ : private: <a href="class136325.html#refclass136325"><b>std::exception</b></a> cause</li></ul><p>a copy of the first exception encountered in this exception chain<br /></p></div>
<p>a copy of the first exception encountered in this exception chain<br /></p><p>Declaration :</p><ul><li>Uml : - cause : <a href="class136325.html#refclass136325"><b>std::exception</b></a></li><li>C++ : private: <a href="class136325.html#refclass136325"><b>std::exception</b></a> cause</li></ul><p>Stereotype: auto_ptr</p>
</div>
<p>All public operations : <a href="class135557.html#refoperation131973"><b>rootCause</b></a> , <a href="class135557.html#refoperation131845"><b>what</b></a> , <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
</body>
</html>

3
doc/devel/uml/class136325.html
View file

@ -17,9 +17,10 @@
<a name="refclass136325"></a>
<p>Declaration :</p><ul><li>C++ : class std::exception </li></ul><p>Directly inherited by : <a href="class135557.html#refclass135557"><b>Error</b></a> </p>
<p>Stereotype: auxiliary</p>
<div class="sub">
<a name="refoperation131717"></a>
<table><tr><td><div class="element">Operation <b>what</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + what() : const char*</li><li>C++ : public: virtual const char* what () const </li></ul><p>the base class of all exceptions thrown by the standard library<br /></p></div>
<table><tr><td><div class="element">Operation <b>what</b></div></td></tr></table><p>the base class of all exceptions thrown by the standard library<br /></p><p>Declaration :</p><ul><li>Uml : + what() : const char*</li><li>C++ : public: virtual const char* what () const </li></ul></div>
<p>All public operations : <a href="class136325.html#refoperation131717"><b>what</b></a> </p>
</body>
</html>

29
doc/devel/uml/class136453.html
View file

@ -16,28 +16,29 @@
<!-- ============================================================= -->
<a name="refclass136453"></a>
<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>Superinterface describing especially the bookeeping properties of Assets<br /></p><p>Artifact : <a href="index.html#refartifact136069"><b>asset</b></a></p><div class="sub">
<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>Declaration :</p><ul><li>Uml : + id : long</li><li>C++ : public: const long id</li></ul><p>Asset primary key.<br /></p><a name="refattribute130565"></a>
<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>Declaration :</p><ul><li>Uml : + name : string</li><li>C++ : public: const string name</li></ul><p>element ID, comprehensible but sanitized. The tuple (category, name, org) is unique.<br /></p><a name="refrelation140421"></a>
<table><tr><td><div class="element">Relation <b>category (&lt;unidirectional association&gt;)</b></div></td></tr></table><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><p>primary tree like classification of the asset<br /></p><a name="refattribute130821"></a>
<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 (&lt;unidirectional association&gt;)</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>Declaration :</p><ul><li>Uml : + org : string</li><li>C++ : public: const string org</li></ul><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><a name="refattribute130949"></a>
<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>Declaration :</p><ul><li>Uml : + version : uint</li><li>C++ : public: const unsigned int version</li></ul><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><a name="refattribute131077"></a>
<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>Declaration :</p><ul><li>Uml : # groups : set&lt;string&gt;</li><li>C++ : protected: set&lt;string&gt; groups</li></ul><p>additional classification, selections or departments this asset belongs to. Groups are optional, non-exclusive and may be overlapping.<br /></p><a name="refattribute131205"></a>
<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&lt;string&gt;</li><li>C++ : protected: set&lt;string&gt; groups</li></ul><a name="refattribute131205"></a>
<table><tr><td><div class="element">Attribut <b>shortDesc</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : # shortDesc : string</li><li>C++ : protected: const string shortDesc</li></ul><p>user visible Name-ID. To be localized.<br /></p><a name="refattribute131333"></a>
<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>Declaration :</p><ul><li>Uml : # longDesc : string</li><li>C++ : protected: const string longDesc</li></ul><p>user visible qualification of the thing, unit or concept represented by this asset. perferably "in one line". To be localized.<br /></p><a name="refoperation132101"></a>
<table><tr><td><div class="element">Operation <b>getParents</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getParents() : vector&lt;PAsset&gt;</li><li>C++ : public: vector&lt;PAsset&gt; getParents () </li></ul><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><a name="refoperation132229"></a>
<table><tr><td><div class="element">Operation <b>getDependant</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getDependant() : vector&lt;PAsset&gt;</li><li>C++ : public: vector&lt;PAsset&gt; getDependant () </li></ul><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><a name="refoperation132869"></a>
<table><tr><td><div class="element">Operation <b>isActive</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + isActive() : bool</li><li>C++ : public: bool isActive () </li></ul><p>weather this asset is swithced on and consequently included in the fixture and participates in rendering<br /></p><a name="refoperation132997"></a>
<table><tr><td><div class="element">Operation <b>enable</b></div></td></tr></table><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><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></div>
<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&lt;PAsset&gt;</li><li>C++ : public: vector&lt;PAsset&gt; 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&lt;PAsset&gt;</li><li>C++ : public: vector&lt;PAsset&gt; 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>

13
doc/devel/uml/class136581.html
View file

@ -16,14 +16,15 @@
<!-- ============================================================= -->
<a name="refclass136581"></a>
<p>Declaration :</p><ul><li>C++ : class AssetManager </li></ul><p>Facade for the Asset subsystem<br /></p><p>Artifact : <a href="index.html#refartifact136197"><b>assetmanager</b></a></p><div class="sub">
<p>Facade for the Asset subsystem<br /></p><p>Declaration :</p><ul><li>C++ : class AssetManager </li></ul><p>Artifact : <a href="index.html#refartifact136197"><b>assetmanager</b></a></p><p>Stereotype: boundary</p>
<div class="sub">
<a name="refoperation133125"></a>
<table><tr><td><div class="element">Operation <b>getID</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : static, + getID(in idi : <a href="class136453.html#refclass136453"><b>Asset</b></a>) : </li><li>C++ : public: static getID () </li></ul><a name="refoperation132485"></a>
<table><tr><td><div class="element">Operation <b>getAsset</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getAsset(in id : long) : KIND, exceptions : <a href="class136069.html#refclass136069"><b>Invalid</b></a></li><li>C++ : public: template&lt;class KIND&gt; KIND getAsset (long &amp; id) throw (<a href="class136069.html#refclass136069"><b>Invalid</b></a>)</li></ul><p>find and return corresponging object<br /></p><a name="refoperation132613"></a>
<table><tr><td><div class="element">Operation <b>known</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + known(in id : long) : bool</li><li>C++ : public: bool known (long id) </li></ul><p>@return true if the given id is registered in the internal asset DB<br /></p><a name="refoperation132741"></a>
<table><tr><td><div class="element">Operation <b>remove</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + remove(in id : long) : void, exceptions : <a href="class136069.html#refclass136069"><b>Invalid</b></a>, <a href="class135941.html#refclass135941"><b>State</b></a></li><li>C++ : public: void remove (long id) throw (<a href="class136069.html#refclass136069"><b>Invalid</b></a>, <a href="class135941.html#refclass135941"><b>State</b></a>)</li></ul><p>remove the given asset &lt;i&gt;together with all its dependants&lt;/i&gt; from the internal DB<br /></p><a name="refoperation132357"></a>
<table><tr><td><div class="element">Operation <b>reg</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : static, # reg(inout name : string, inout category : string, inout org : string, inout uint : version) : long, exceptions : Invalid</li><li>C++ : protected: static long reg (string &amp; name, string &amp; category, string &amp; org, version&amp; uint) throw (Invalid)</li></ul><p>registers an asset object in the internal DB, providing its unique key<br /></p><a name="refrelation142085"></a>
<table><tr><td><div class="element">Relation <b>registry (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # registry : <a href="class138373.html#refclass138373"><b>DB</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class138373.html#refclass138373"><b>DB</b></a>* registry</li></ul><p>@internal Table or DB holding all registered asset instances.<br /></p></div>
<table><tr><td><div class="element">Operation <b>getAsset</b></div></td></tr></table><p>find and return corresponging object<br /></p><p>Declaration :</p><ul><li>Uml : + getAsset(in id : long) : KIND, exceptions : <a href="class136069.html#refclass136069"><b>Invalid</b></a></li><li>C++ : public: template&lt;class KIND&gt; KIND getAsset (long &amp; id) throw (<a href="class136069.html#refclass136069"><b>Invalid</b></a>)</li></ul><a name="refoperation132613"></a>
<table><tr><td><div class="element">Operation <b>known</b></div></td></tr></table><p>@return true if the given id is registered in the internal asset DB<br /></p><p>Declaration :</p><ul><li>Uml : + known(in id : long) : bool</li><li>C++ : public: bool known (long id) </li></ul><a name="refoperation132741"></a>
<table><tr><td><div class="element">Operation <b>remove</b></div></td></tr></table><p>remove the given asset &lt;i&gt;together with all its dependants&lt;/i&gt; from the internal DB<br /></p><p>Declaration :</p><ul><li>Uml : + remove(in id : long) : void, exceptions : <a href="class136069.html#refclass136069"><b>Invalid</b></a>, <a href="class135941.html#refclass135941"><b>State</b></a></li><li>C++ : public: void remove (long id) throw (<a href="class136069.html#refclass136069"><b>Invalid</b></a>, <a href="class135941.html#refclass135941"><b>State</b></a>)</li></ul><a name="refoperation132357"></a>
<table><tr><td><div class="element">Operation <b>reg</b></div></td></tr></table><p>registers an asset object in the internal DB, providing its unique key<br /></p><p>Declaration :</p><ul><li>Uml : static, # reg(inout name : string, inout category : string, inout org : string, inout uint : version) : long, exceptions : Invalid</li><li>C++ : protected: static long reg (string &amp; name, string &amp; category, string &amp; org, version&amp; uint) throw (Invalid)</li></ul><a name="refrelation142085"></a>
<table><tr><td><div class="element">Relation <b>registry (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>@internal Table or DB holding all registered asset instances.<br /></p><p>Declaration :</p><ul><li>Uml : # registry : <a href="class138373.html#refclass138373"><b>DB</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class138373.html#refclass138373"><b>DB</b></a>* registry</li></ul></div>
<p>All public operations : <a href="class136581.html#refoperation132485"><b>getAsset</b></a> , <a href="class136581.html#refoperation133125"><b>getID</b></a> , <a href="class136581.html#refoperation132613"><b>known</b></a> , <a href="class136581.html#refoperation132741"><b>remove</b></a> </p>
</body>
</html>

8
doc/devel/uml/class136709.html
View file

@ -16,11 +16,11 @@
<!-- ============================================================= -->
<a name="refclass136709"></a>
<p>Declaration :</p><ul><li>C++ : class Media : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class137349.html#refclass137349"><b>Clip</b></a> <a href="class138501.html#refclass138501"><b>CompoundMedia</b></a> <a href="class137477.html#refclass137477"><b>Unknown</b></a> </p>
<p>key abstraction: media-like assets<br /></p><p>Artifact : <a href="index.html#refartifact136453"><b>media</b></a></p><div class="sub">
<p>key abstraction: media-like assets<br /></p><p>Declaration :</p><ul><li>C++ : class Media : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class137349.html#refclass137349"><b>Clip</b></a> <a href="class138501.html#refclass138501"><b>CompoundMedia</b></a> <a href="class137477.html#refclass137477"><b>Unknown</b></a> </p>
<p>Artifact : <a href="index.html#refartifact136453"><b>media</b></a></p><div class="sub">
<a name="refoperation133253"></a>
<table><tr><td><div class="element">Operation <b>createClip</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + createClip() : <a href="class128901.html#refclass128901"><b>Clip</b></a></li><li>C++ : public: <a href="class128901.html#refclass128901"><b>Clip</b></a> createClip () </li></ul><p>create a (possibly compound) Clip refering to this media, ready to be added to the EDL.<br /></p><a name="refoperation133381"></a>
<table><tr><td><div class="element">Operation <b>howtoProc</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + howtoProc() : <a href="class138757.html#refclass138757"><b>ProcPatt</b></a></li><li>C++ : public: <a href="class138757.html#refclass138757"><b>ProcPatt</b></a> howtoProc () </li></ul><p>@return descriptor how to build a render pipeline corresponding to this media<br /></p></div>
<table><tr><td><div class="element">Operation <b>createClip</b></div></td></tr></table><p>create a (possibly compound) Clip refering to this media, ready to be added to the EDL.<br /></p><p>Declaration :</p><ul><li>Uml : + createClip() : <a href="class128901.html#refclass128901"><b>Clip</b></a></li><li>C++ : public: <a href="class128901.html#refclass128901"><b>Clip</b></a> createClip () </li></ul><a name="refoperation133381"></a>
<table><tr><td><div class="element">Operation <b>howtoProc</b></div></td></tr></table><p>@return descriptor how to build a render pipeline corresponding to this media<br /></p><p>Declaration :</p><ul><li>Uml : + howtoProc() : <a href="class138757.html#refclass138757"><b>ProcPatt</b></a></li><li>C++ : public: <a href="class138757.html#refclass138757"><b>ProcPatt</b></a> howtoProc () </li></ul></div>
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <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="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
</body>
</html>

4
doc/devel/uml/class136837.html
View file

@ -16,8 +16,8 @@
<!-- ============================================================= -->
<a name="refclass136837"></a>
<p>Declaration :</p><ul><li>C++ : class Proc : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class137861.html#refclass137861"><b>Codec</b></a> <a href="class137733.html#refclass137733"><b>Effect</b></a> </p>
<p>key abstraction: data processing asset<br /></p><p>Artifact : <a href="index.html#refartifact136581"><b>proc</b></a></p><div class="sub">
<p>key abstraction: data processing asset<br /></p><p>Declaration :</p><ul><li>C++ : class Proc : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class137861.html#refclass137861"><b>Codec</b></a> <a href="class137733.html#refclass137733"><b>Effect</b></a> </p>
<p>Artifact : <a href="index.html#refartifact136581"><b>proc</b></a></p><div class="sub">
</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>

4
doc/devel/uml/class136965.html
View file

@ -16,8 +16,8 @@
<!-- ============================================================= -->
<a name="refclass136965"></a>
<p>Declaration :</p><ul><li>C++ : class Struct : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class138117.html#refclass138117"><b>Pipe</b></a> <a href="class138757.html#refclass138757"><b>ProcPatt</b></a> <a href="class137989.html#refclass137989"><b>Track</b></a> </p>
<p>key abstraction: structural asset<br /></p><p>Artifact : <a href="index.html#refartifact136709"><b>struct</b></a></p><div class="sub">
<p>key abstraction: structural asset<br /></p><p>Declaration :</p><ul><li>C++ : class Struct : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class138117.html#refclass138117"><b>Pipe</b></a> <a href="class138757.html#refclass138757"><b>ProcPatt</b></a> <a href="class137989.html#refclass137989"><b>Track</b></a> </p>
<p>Artifact : <a href="index.html#refartifact136709"><b>struct</b></a></p><div class="sub">
</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>

4
doc/devel/uml/class137093.html
View file

@ -16,8 +16,8 @@
<!-- ============================================================= -->
<a name="refclass137093"></a>
<p>Declaration :</p><ul><li>C++ : class Meta : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class138245.html#refclass138245"><b>Dataset</b></a> </p>
<p>key abstraction: metadata and organisational asset<br /></p><p>Artifact : <a href="index.html#refartifact136837"><b>meta</b></a></p><div class="sub">
<p>key abstraction: metadata and organisational asset<br /></p><p>Declaration :</p><ul><li>C++ : class Meta : public <a href="class136453.html#refclass136453"><b>Asset</b></a> </li></ul><p>Directly inherited by : <a href="class138245.html#refclass138245"><b>Dataset</b></a> </p>
<p>Artifact : <a href="index.html#refartifact136837"><b>meta</b></a></p><div class="sub">
</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>

2
doc/devel/uml/class137221.html
View file

@ -16,5 +16,5 @@
<!-- ============================================================= -->
<a name="refclass137221"></a>
<p>Declaration :</p><ul><li>C++ : class Category </li></ul><p>tree like classification of Assets<br /></p><p>Artifact : <a href="index.html#refartifact135941"><b>category</b></a></p></body>
<p>tree like classification of Assets<br /></p><p>Declaration :</p><ul><li>C++ : class Category </li></ul><p>Artifact : <a href="index.html#refartifact135941"><b>category</b></a></p></body>
</html>

4
doc/devel/uml/class137349.html
View file

@ -16,9 +16,9 @@
<!-- ============================================================= -->
<a name="refclass137349"></a>
<p>Declaration :</p><ul><li>C++ : class Clip : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>bookkeeping (asset) view of a media clip.<br /></p><p>Artifact : <a href="index.html#refartifact136325"><b>clip</b></a></p><div class="sub">
<p>bookkeeping (asset) view of a media clip.<br /></p><p>Declaration :</p><ul><li>C++ : class Clip : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact136325"><b>clip</b></a></p><div class="sub">
<a name="refrelation141957"></a>
<table><tr><td><div class="element">Relation <b>source (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # source : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1</li><li>C++ : protected: const <a href="class136709.html#refclass136709"><b>Media</b></a>* source</li></ul><p>media source of this clip<br /></p></div>
<table><tr><td><div class="element">Relation <b>source (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>media source of this clip<br /></p><p>Declaration :</p><ul><li>Uml : # source : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1</li><li>C++ : protected: const <a href="class136709.html#refclass136709"><b>Media</b></a>* source</li></ul></div>
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <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="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
</body>
</html>

4
doc/devel/uml/class137477.html
View file

@ -16,8 +16,8 @@
<!-- ============================================================= -->
<a name="refclass137477"></a>
<p>Declaration :</p><ul><li>C++ : class Unknown : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>Directly inherited by : <a href="class137605.html#refclass137605"><b>Preview</b></a> </p>
<p>placeholder for unknown or unavailable media source<br /></p><p>Artifact : <a href="index.html#refartifact137093"><b>unknown</b></a></p><div class="sub">
<p>placeholder for unknown or unavailable media source<br /></p><p>Declaration :</p><ul><li>C++ : class Unknown : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>Directly inherited by : <a href="class137605.html#refclass137605"><b>Preview</b></a> </p>
<p>Artifact : <a href="index.html#refartifact137093"><b>unknown</b></a></p><div class="sub">
</div>
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <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="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
</body>

2
doc/devel/uml/class137605.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass137605"></a>
<p>Declaration :</p><ul><li>C++ : class Preview : public <a href="class137477.html#refclass137477"><b>Unknown</b></a> </li></ul><p>alternative version of the media data, probably with lower resolution<br /></p><p>Artifact : <a href="index.html#refartifact136965"><b>preview</b></a></p><div class="sub">
<p>alternative version of the media data, probably with lower resolution<br /></p><p>Declaration :</p><ul><li>C++ : class Preview : public <a href="class137477.html#refclass137477"><b>Unknown</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact136965"><b>preview</b></a></p><div class="sub">
</div>
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <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="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
</body>

2
doc/devel/uml/class137733.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass137733"></a>
<p>Declaration :</p><ul><li>C++ : class Effect : public <a href="class136837.html#refclass136837"><b>Proc</b></a> </li></ul><p>Effect or media processing component<br /></p><p>Artifact : <a href="index.html#refartifact137221"><b>effect</b></a></p><div class="sub">
<p>Effect or media processing component<br /></p><p>Declaration :</p><ul><li>C++ : class Effect : public <a href="class136837.html#refclass136837"><b>Proc</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137221"><b>effect</b></a></p><div class="sub">
</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>

2
doc/devel/uml/class137861.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass137861"></a>
<p>Declaration :</p><ul><li>C++ : class Codec : public <a href="class136837.html#refclass136837"><b>Proc</b></a> </li></ul><p>description of some media data decoder or encoder facility<br /></p><p>Artifact : <a href="index.html#refartifact137349"><b>codec</b></a></p><div class="sub">
<p>description of some media data decoder or encoder facility<br /></p><p>Declaration :</p><ul><li>C++ : class Codec : public <a href="class136837.html#refclass136837"><b>Proc</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137349"><b>codec</b></a></p><div class="sub">
</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>

2
doc/devel/uml/class137989.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass137989"></a>
<p>Declaration :</p><ul><li>C++ : class Track : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>structural asset holding the configuration of a track in the EDL<br /></p><p>Artifact : <a href="index.html#refartifact137477"><b>track</b></a></p><div class="sub">
<p>structural asset holding the configuration of a track in the EDL<br /></p><p>Declaration :</p><ul><li>C++ : class Track : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137477"><b>track</b></a></p><div class="sub">
</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>

2
doc/devel/uml/class138117.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass138117"></a>
<p>Declaration :</p><ul><li>C++ : class Pipe : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>structural asset representing a basic building block within the high level model: a port for building a processing chain and generating media output<br /></p><p>Artifact : <a href="index.html#refartifact137605"><b>pipe</b></a></p><div class="sub">
<p>structural asset representing a basic building block within the high level model: a port for building a processing chain and generating media output<br /></p><p>Declaration :</p><ul><li>C++ : class Pipe : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137605"><b>pipe</b></a></p><div class="sub">
<a name="refrelation148229"></a>
<table><tr><td><div class="element">Relation <b>wiringTemplate (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # wiringTemplate : <a href="class138757.html#refclass138757"><b>ProcPatt</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class138757.html#refclass138757"><b>ProcPatt</b></a>* wiringTemplate</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>

2
doc/devel/uml/class138245.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass138245"></a>
<p>Declaration :</p><ul><li>C++ : class Dataset : public <a href="class137093.html#refclass137093"><b>Meta</b></a> </li></ul><p>meta asset describing a collection of control data<br /></p><p>Artifact : <a href="index.html#refartifact137733"><b>dataset</b></a></p><div class="sub">
<p>meta asset describing a collection of control data<br /></p><p>Declaration :</p><ul><li>C++ : class Dataset : public <a href="class137093.html#refclass137093"><b>Meta</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137733"><b>dataset</b></a></p><div class="sub">
</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>

2
doc/devel/uml/class138373.html
View file

@ -16,5 +16,5 @@
<!-- ============================================================= -->
<a name="refclass138373"></a>
<p>Declaration :</p><ul><li>C++ : class DB </li></ul><p>Implementation of the registry holding all Asset instances known to the Asset Manager subsystem. As of 8/2007 implemented by a hashtable.<br /></p><p>Artifact : <a href="index.html#refartifact137861"><b>db</b></a></p></body>
<p>Implementation of the registry holding all Asset instances known to the Asset Manager subsystem. As of 8/2007 implemented by a hashtable.<br /></p><p>Declaration :</p><ul><li>C++ : class DB </li></ul><p>Artifact : <a href="index.html#refartifact137861"><b>db</b></a></p></body>
</html>

5
doc/devel/uml/class138501.html
View file

@ -16,9 +16,10 @@
<!-- ============================================================= -->
<a name="refclass138501"></a>
<p>Declaration :</p><ul><li>C++ : class CompoundMedia : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>compound of several elementary media tracks,<br />e.g. the individual media streams found in one media file<br /></p><p>Artifact : <a href="index.html#refartifact138245"><b>compoundmedia</b></a></p><div class="sub">
<p>compound of several elementary media tracks,<br />e.g. the individual media streams found in one media file<br /></p><p>Declaration :</p><ul><li>C++ : class CompoundMedia : public <a href="class136709.html#refclass136709"><b>Media</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact138245"><b>compoundmedia</b></a></p><div class="sub">
<a name="refrelation142341"></a>
<table><tr><td><div class="element">Relation <b>tracks (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # tracks : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1..*</li><li>C++ : protected: vector&lt;<a href="class136709.html#refclass136709"><b>Media</b></a> *&gt; tracks</li></ul><p>elementary media assets comprising this compound<br /></p></div>
<table><tr><td><div class="element">Relation <b>tracks (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>elementary media assets comprising this compound<br /></p><p>Declaration :</p><ul><li>Uml : # tracks : <a href="class136709.html#refclass136709"><b>Media</b></a>, multiplicity : 1..*</li><li>C++ : protected: vector&lt;<a href="class136709.html#refclass136709"><b>Media</b></a> *&gt; tracks</li></ul><p>Stereotype: vector</p>
</div>
<p>All public operations : <a href="class136709.html#refoperation133253"><b>createClip</b></a> , <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="class136709.html#refoperation133381"><b>howtoProc</b></a> , <a href="class136453.html#refoperation132869"><b>isActive</b></a> </p>
</body>
</html>

2
doc/devel/uml/class138629.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass138629"></a>
<p>Declaration :</p><ul><li>C++ : class CompoundClip : public <a href="class128901.html#refclass128901"><b>Clip</b></a> </li></ul><p>Clip MObject which is actually a compound of several elementary clips,<br />e.g. the several streams found within multichannels media.<br /></p><p>Artifact : <a href="index.html#refartifact138501"><b>compoundclip</b></a>, Diagram : <a href="index.html#refclass diagram128133"><b>Session structure</b></a></p><div class="sub">
<p>Clip MObject which is actually a compound of several elementary clips,<br />e.g. the several streams found within multichannels media.<br /></p><p>Declaration :</p><ul><li>C++ : class CompoundClip : public <a href="class128901.html#refclass128901"><b>Clip</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact138501"><b>compoundclip</b></a>, Diagram : <a href="index.html#refclass diagram128133"><b>Session structure</b></a></p><div class="sub">
<a name="refrelation143493"></a>
<table><tr><td><div class="element">Relation <b>components (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # components : <a href="class128901.html#refclass128901"><b>Clip</b></a>, multiplicity : 1..*</li><li>C++ : protected: <a href="class128901.html#refclass128901"><b>Clip</b></a>* components</li></ul></div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>

5
doc/devel/uml/class138757.html
View file

@ -16,9 +16,10 @@
<!-- ============================================================= -->
<a name="refclass138757"></a>
<p>Declaration :</p><ul><li>C++ : class ProcPatt : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>special type of structural Asset representing information how to build some part of the render engine's processing nodes network.<br /></p><p>Artifact : <a href="index.html#refartifact137989"><b>procpatt</b></a></p><div class="sub">
<p>special type of structural Asset representing information how to build some part of the render engine's processing nodes network.<br /></p><p>Declaration :</p><ul><li>C++ : class ProcPatt : public <a href="class136965.html#refclass136965"><b>Struct</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact137989"><b>procpatt</b></a></p><div class="sub">
<a name="refrelation143621"></a>
<table><tr><td><div class="element">Relation <b>instructions (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # instructions : <a href="class139013.html#refclass139013"><b>BuildInstruct</b></a>, multiplicity : 1..*</li><li>C++ : protected: const vector&lt;<a href="class139013.html#refclass139013"><b>BuildInstruct</b></a>&gt; instructions</li></ul></div>
<table><tr><td><div class="element">Relation <b>instructions (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # instructions : <a href="class139013.html#refclass139013"><b>BuildInstruct</b></a>, multiplicity : 1..*</li><li>C++ : protected: const vector&lt;<a href="class139013.html#refclass139013"><b>BuildInstruct</b></a>&gt; instructions</li></ul><p>Stereotype: vector</p>
</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>

2
doc/devel/uml/class138885.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass138885"></a>
<p>Declaration :</p><ul><li>C++ : class SimpleClip : public <a href="class128901.html#refclass128901"><b>Clip</b></a> </li></ul><p>Elementary clip consisting of only one media stream<br /></p><p>Artifact : <a href="index.html#refartifact138373"><b>simpleclip</b></a></p><div class="sub">
<p>Elementary clip consisting of only one media stream<br /></p><p>Declaration :</p><ul><li>C++ : class SimpleClip : public <a href="class128901.html#refclass128901"><b>Clip</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact138373"><b>simpleclip</b></a></p><div class="sub">
</div>
<p>All public operations : <a href="class134021.html#refoperation129669"><b>apply</b></a> , <a href="class140165.html#refoperation134789"><b>apply</b></a> , <a href="class140165.html#refoperation134917"><b>dispatchOp</b></a> </p>
</body>

4
doc/devel/uml/class139013.html
View file

@ -16,6 +16,6 @@
<!-- ============================================================= -->
<a name="refclass139013"></a>
<p>Declaration :</p><ul><li>C++ : class BuildInstruct </li></ul><p>Directly inherited by : <a href="class139141.html#refclass139141"><b>DoAttach</b></a> <a href="class139269.html#refclass139269"><b>DoRecurse</b></a> </p>
<p>(Interface) building instructions to be executed by the Builder on the render node network under construction.<br /></p><p>Artifact : <a href="index.html#refartifact138117"><b>buildinstruct</b></a></p></body>
<p>(Interface) building instructions to be executed by the Builder on the render node network under construction.<br /></p><p>Declaration :</p><ul><li>C++ : class BuildInstruct </li></ul><p>Directly inherited by : <a href="class139141.html#refclass139141"><b>DoAttach</b></a> <a href="class139269.html#refclass139269"><b>DoRecurse</b></a> </p>
<p>Artifact : <a href="index.html#refartifact138117"><b>buildinstruct</b></a></p></body>
</html>

5
doc/devel/uml/class139141.html
View file

@ -18,8 +18,9 @@
<a name="refclass139141"></a>
<p>Declaration :</p><ul><li>C++ : class DoAttach : public <a href="class139013.html#refclass139013"><b>BuildInstruct</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact138117"><b>buildinstruct</b></a></p><div class="sub">
<a name="refrelation144133"></a>
<table><tr><td><div class="element">Relation <b>nodes (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + nodes : <a href="class136837.html#refclass136837"><b>Proc</b></a>, multiplicity : 1..*</li><li>C++ : public: const <a href="class136837.html#refclass136837"><b>Proc</b></a>* nodes</li></ul><a name="refattribute131461"></a>
<table><tr><td><div class="element">Relation <b>nodes (&lt;directional aggregation&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + nodes : <a href="class136837.html#refclass136837"><b>Proc</b></a>, multiplicity : 1..*</li><li>C++ : public: const <a href="class136837.html#refclass136837"><b>Proc</b></a>* nodes</li></ul><p>Stereotype: vector</p>
<a name="refattribute131461"></a>
<table><tr><td><div class="element">Attribut <b>point</b></div></td></tr></table>
<p>Declaration :</p><ul><li>Uml : + point : string</li><li>C++ : public: const string point</li></ul><p>identifying the point where the nodes should be attached<br /></p></div>
<p>identifying the point where the nodes should be attached<br /></p><p>Declaration :</p><ul><li>Uml : + point : string</li><li>C++ : public: const string point</li></ul></div>
</body>
</html>

2
doc/devel/uml/class139397.html
View file

@ -16,7 +16,7 @@
<!-- ============================================================= -->
<a name="refclass139397"></a>
<p>Declaration :</p><ul><li>C++ : class MediaFactory </li></ul><p>Depends on <a href="index.html#refpackage129157"><b>BackendLayer</b></a></p><p>Depends on <a href="index.html#refpackage129157"><b>BackendLayer</b></a></p><p>specialized Asset Factory for configuring (new) media asset instances based on existing media files on disk; can create placeholder assets as well<br /></p><p>Artifact : <a href="index.html#refartifact136453"><b>media</b></a></p><div class="sub">
<p>specialized Asset Factory for configuring (new) media asset instances based on existing media files on disk; can create placeholder assets as well<br /></p><p>Declaration :</p><ul><li>C++ : class MediaFactory </li></ul><p>Depends on <a href="index.html#refpackage129157"><b>BackendLayer</b></a></p><p>Depends on <a href="index.html#refpackage129157"><b>BackendLayer</b></a></p><p>Artifact : <a href="index.html#refartifact136453"><b>media</b></a></p><div class="sub">
</div>
</body>
</html>

3
doc/devel/uml/class139525.html
View file

@ -16,5 +16,6 @@
<!-- ============================================================= -->
<a name="refclass139525"></a>
<p>Declaration :</p><ul><li>C++ : class MediaAccessFacade </li></ul><p>provides functions for querying (opening) a media file, detecting the channels or streams found within this file, etc. Delegating to the actual backend functions<br /></p><p>Artifact : <a href="index.html#refartifact138629"><b>mediaaccessfacade</b></a>, Component(s) : <a href="index.html#refcomponent130437"><b>Media Access</b></a></p></body>
<p>provides functions for querying (opening) a media file, detecting the channels or streams found within this file, etc. Delegating to the actual backend functions<br /></p><p>Declaration :</p><ul><li>C++ : class MediaAccessFacade </li></ul><p>Artifact : <a href="index.html#refartifact138629"><b>mediaaccessfacade</b></a>, Component(s) : <a href="index.html#refcomponent130437"><b>Media Access</b></a></p><p>Stereotype: boundary</p>
</body>
</html>

10
doc/devel/uml/class139653.html
View file

@ -16,12 +16,12 @@
<!-- ============================================================= -->
<a name="refclass139653"></a>
<p>Declaration :</p><ul><li>C++ : class Session </li></ul><p>Directly inherited by : <a href="class128005.html#refclass128005"><b>SessionImpl</b></a> </p>
<p>Primary Interface for all editing tasks.<br />The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered.<br /></p><p>Artifact : <a href="index.html#refartifact138757"><b>session</b></a></p><div class="sub">
<p>Primary Interface for all editing tasks.<br />The session contains defaults, all the assets being edited, and a set of EDL with the individual MObjects to be manipulated and rendered.<br /></p><p>Declaration :</p><ul><li>C++ : class Session </li></ul><p>Directly inherited by : <a href="class128005.html#refclass128005"><b>SessionImpl</b></a> </p>
<p>Artifact : <a href="index.html#refartifact138757"><b>session</b></a></p><div class="sub">
<a name="refoperation133509"></a>
<table><tr><td><div class="element">Operation <b>currEDL</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + currEDL() : <a href="class128133.html#refclass128133"><b>Seq</b></a></li><li>C++ : public: <a href="class128133.html#refclass128133"><b>Seq</b></a> currEDL () </li></ul><p>The EDL currently in focus. In most cases, Session and EDL are almost the same, just EDL emphasizes the collection aspect. But generally (for larger editing projects) one Session can contain several EDLs, which may even be nested. At any given time, only one of these EDLs has focus and recieves the editing commands.<br /></p><a name="refoperation133637"></a>
<table><tr><td><div class="element">Operation <b>getFixture</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + getFixture() : Fixture&amp;</li><li>C++ : public: Fixture&amp; getFixture () </li></ul><p>While the session can be comprised of several EDLs, <br />there is only one Fixture, which represents the actual<br />configuration of all Objects to be rendered<br /></p><a name="refrelation144773"></a>
<table><tr><td><div class="element">Relation <b>current (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : static, + current : <a href="class139781.html#refclass139781"><b>SessManager</b></a>, multiplicity : 1</li><li>C++ : public: static <a href="class139781.html#refclass139781"><b>SessManager</b></a>&amp; current</li></ul><p>Standard access path to get at the current session via the Session Manager, which acts as a "PImpl" smart pointer<br /></p><a name="refrelation150917"></a>
<table><tr><td><div class="element">Operation <b>currEDL</b></div></td></tr></table><p>The EDL currently in focus. In most cases, Session and EDL are almost the same, just EDL emphasizes the collection aspect. But generally (for larger editing projects) one Session can contain several EDLs, which may even be nested. At any given time, only one of these EDLs has focus and recieves the editing commands.<br /></p><p>Declaration :</p><ul><li>Uml : + currEDL() : <a href="class128133.html#refclass128133"><b>Seq</b></a></li><li>C++ : public: <a href="class128133.html#refclass128133"><b>Seq</b></a> currEDL () </li></ul><a name="refoperation133637"></a>
<table><tr><td><div class="element">Operation <b>getFixture</b></div></td></tr></table><p>While the session can be comprised of several EDLs, <br />there is only one Fixture, which represents the actual<br />configuration of all Objects to be rendered<br /></p><p>Declaration :</p><ul><li>Uml : + getFixture() : Fixture&amp;</li><li>C++ : public: Fixture&amp; getFixture () </li></ul><a name="refrelation144773"></a>
<table><tr><td><div class="element">Relation <b>current (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Standard access path to get at the current session via the Session Manager, which acts as a "PImpl" smart pointer<br /></p><p>Declaration :</p><ul><li>Uml : static, + current : <a href="class139781.html#refclass139781"><b>SessManager</b></a>, multiplicity : 1</li><li>C++ : public: static <a href="class139781.html#refclass139781"><b>SessManager</b></a>&amp; current</li></ul><a name="refrelation150917"></a>
<table><tr><td><div class="element">Relation <b>defaults (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # defaults : <a href="class141445.html#refclass141445"><b>DefaultsManager</b></a></li><li>C++ : protected: <a href="class141445.html#refclass141445"><b>DefaultsManager</b></a>* defaults</li></ul></div>
<p>All public operations : <a href="class139653.html#refoperation133509"><b>currEDL</b></a> , <a href="class139653.html#refoperation133637"><b>getFixture</b></a> </p>
</body>

8
doc/devel/uml/class139781.html
View file

@ -18,10 +18,10 @@
<a name="refclass139781"></a>
<p>Declaration :</p><ul><li>C++ : class SessManager </li></ul><p>Artifact : <a href="index.html#refartifact138885"><b>sessmanager</b></a></p><div class="sub">
<a name="refoperation133765"></a>
<table><tr><td><div class="element">Operation <b>clear</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + clear() : void</li><li>C++ : public: void clear () </li></ul><p>clear current session contents <br />without resetting overall session config.<br />Afterwards, the session will contain only one <br />empty EDL, while all Assets are retained.<br /><br /></p><a name="refoperation133893"></a>
<table><tr><td><div class="element">Operation <b>reset</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + reset() : void</li><li>C++ : public: void reset () </li></ul><p>reset all session config and <br />start with a pristine default session.<br /></p><a name="refoperation134021"></a>
<table><tr><td><div class="element">Operation <b>load</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + load() : void</li><li>C++ : public: void load () </li></ul><p>replace the current session by a new<br />session loaded from serialized state.<br /></p><a name="refoperation134149"></a>
<table><tr><td><div class="element">Operation <b>save</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + save() : void</li><li>C++ : public: void save () </li></ul><p>create a complete, serialized representation<br />of the current session config and contents.<br />@todo how to serialize, prameters, return value?<br /></p></div>
<table><tr><td><div class="element">Operation <b>clear</b></div></td></tr></table><p>clear current session contents <br />without resetting overall session config.<br />Afterwards, the session will contain only one <br />empty EDL, while all Assets are retained.<br /><br /></p><p>Declaration :</p><ul><li>Uml : + clear() : void</li><li>C++ : public: void clear () </li></ul><a name="refoperation133893"></a>
<table><tr><td><div class="element">Operation <b>reset</b></div></td></tr></table><p>reset all session config and <br />start with a pristine default session.<br /></p><p>Declaration :</p><ul><li>Uml : + reset() : void</li><li>C++ : public: void reset () </li></ul><a name="refoperation134021"></a>
<table><tr><td><div class="element">Operation <b>load</b></div></td></tr></table><p>replace the current session by a new<br />session loaded from serialized state.<br /></p><p>Declaration :</p><ul><li>Uml : + load() : void</li><li>C++ : public: void load () </li></ul><a name="refoperation134149"></a>
<table><tr><td><div class="element">Operation <b>save</b></div></td></tr></table><p>create a complete, serialized representation<br />of the current session config and contents.<br />@todo how to serialize, prameters, return value?<br /></p><p>Declaration :</p><ul><li>Uml : + save() : void</li><li>C++ : public: void save () </li></ul></div>
<p>All public operations : <a href="class139781.html#refoperation133765"><b>clear</b></a> , <a href="class139781.html#refoperation134021"><b>load</b></a> , <a href="class139781.html#refoperation133893"><b>reset</b></a> , <a href="class139781.html#refoperation134149"><b>save</b></a> </p>
</body>
</html>

6
doc/devel/uml/class139909.html
View file

@ -16,9 +16,9 @@
<!-- ============================================================= -->
<a name="refclass139909"></a>
<p>Declaration :</p><ul><li>C++ : class LocatingPin </li></ul><p>Directly inherited by : <a href="class129541.html#refclass129541"><b>Allocation</b></a> <a href="class129285.html#refclass129285"><b>FixedLocation</b></a> <a href="class129413.html#refclass129413"><b>RelativeLocation</b></a> </p>
<p>An element with value semantics, which actually implements the placement of some MObject by positioning it in some way.<br /></p><p>Artifact : <a href="index.html#refartifact139013"><b>locatingpin</b></a></p><div class="sub">
<p>An element with value semantics, which actually implements the placement of some MObject by positioning it in some way.<br /></p><p>Declaration :</p><ul><li>C++ : class LocatingPin </li></ul><p>Directly inherited by : <a href="class129541.html#refclass129541"><b>Allocation</b></a> <a href="class129285.html#refclass129285"><b>FixedLocation</b></a> <a href="class129413.html#refclass129413"><b>RelativeLocation</b></a> </p>
<p>Artifact : <a href="index.html#refartifact139013"><b>locatingpin</b></a></p><div class="sub">
<a name="refrelation146053"></a>
<table><tr><td><div class="element">Relation <b>next (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # next : <a href="class139909.html#refclass139909"><b>LocatingPin</b></a></li><li>C++ : protected: <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>* next</li></ul><p>next additional LocatingPin, if any<br /></p></div>
<table><tr><td><div class="element">Relation <b>next (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>next additional LocatingPin, if any<br /></p><p>Declaration :</p><ul><li>Uml : # next : <a href="class139909.html#refclass139909"><b>LocatingPin</b></a></li><li>C++ : protected: <a href="class139909.html#refclass139909"><b>LocatingPin</b></a>* next</li></ul></div>
</body>
</html>

2
doc/devel/uml/class140421.html
View file

@ -18,7 +18,7 @@
<a name="refclass140421"></a>
<p>Declaration :</p><ul><li>C++ : class Plug : public <a href="class130053.html#refclass130053"><b>Wish</b></a> </li></ul><p>Artifact : <a href="index.html#refartifact139525"><b>plug</b></a></p><div class="sub">
<a name="refrelation147973"></a>
<table><tr><td><div class="element">Relation <b>outPort (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # outPort : <a href="class138117.html#refclass138117"><b>Pipe</b></a></li><li>C++ : protected: <a href="class138117.html#refclass138117"><b>Pipe</b></a>* outPort</li></ul><p>the Port this MObject wants to be conected to<br /></p></div>
<table><tr><td><div class="element">Relation <b>outPort (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>the Port this MObject wants to be conected to<br /></p><p>Declaration :</p><ul><li>Uml : # outPort : <a href="class138117.html#refclass138117"><b>Pipe</b></a></li><li>C++ : protected: <a href="class138117.html#refclass138117"><b>Pipe</b></a>* outPort</li></ul></div>
<p>All public operations : <a href="class129541.html#refoperation131205"><b>get_repr</b></a> </p>
</body>
</html>

5
doc/devel/uml/class140549.html
View file

@ -16,8 +16,9 @@
<!-- ============================================================= -->
<a name="refclass140549"></a>
<p>Declaration :</p><ul><li>C++ : class ConfigRules : public <a href="class140677.html#refclass140677"><b>QueryHandler</b></a>&lt;&gt; </li><li>Java : public interface ConfigRules </li></ul><p>Directly inherited by : <a href="class140933.html#refclass140933"><b>ResolverBase</b></a> </p>
<p>public acces point for running Config Queries<br /></p><div class="sub">
<p>public acces point for running Config Queries<br /></p><p>Declaration :</p><ul><li>C++ : class ConfigRules : public <a href="class140677.html#refclass140677"><b>QueryHandler</b></a>&lt;&gt; </li><li>Java : public interface ConfigRules </li></ul><p>Directly inherited by : <a href="class140933.html#refclass140933"><b>ResolverBase</b></a> </p>
<p>Stereotype: interface</p>
<div class="sub">
<a name="refrelation148485"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class140677.html#refclass140677"><b>QueryHandler</b></a></li><li>C++ : protected: <a href="class140677.html#refclass140677"><b>QueryHandler</b></a>* </li></ul><a name="refrelation148741"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class140677.html#refclass140677"><b>QueryHandler</b></a></li><li>C++ : protected: <a href="class140677.html#refclass140677"><b>QueryHandler</b></a>* </li></ul></div>

1
doc/devel/uml/class140677.html
View file

@ -17,6 +17,7 @@
<a name="refclass140677"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;class TY&gt; class QueryHandler </li><li>Java : public interface QueryHandler&lt;TY&gt; </li></ul><p>Directly inherited by : <a href="class140549.html#refclass140549"><b>ConfigRules</b></a> </p>
<p>Stereotype: interface</p>
<div class="sub">
<a name="refrelation148613"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class140549.html#refclass140549"><b>ConfigRules</b></a></li><li>C++ : protected: <a href="class140549.html#refclass140549"><b>ConfigRules</b></a>* </li></ul><a name="refrelation148869"></a>

1
doc/devel/uml/class140805.html
View file

@ -17,6 +17,7 @@
<a name="refclass140805"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;class TY&gt; class TypeHandler </li><li>Java : public interface TypeHandler&lt;TY&gt; </li></ul><p>Directly inherited by : <a href="class141317.html#refclass141317"><b>TypeHandler&lt;Pipe&gt;</b></a> </p>
<p>Stereotype: interface</p>
<div class="sub">
<a name="refoperation135045"></a>
<table><tr><td><div class="element">Operation <b>find</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : abstract, + find(in capabilities : Pred) : TY</li><li>C++ : public: virtual TY find () = 0 </li></ul><a name="refoperation135173"></a>

3
doc/devel/uml/class141701.html
View file

@ -16,5 +16,6 @@
<!-- ============================================================= -->
<a name="refclass141701"></a>
<p>Declaration :</p><ul><li>C++ : class User </li></ul></body>
<p>Declaration :</p><ul><li>C++ : class User </li></ul><p>Stereotype: actor</p>
</body>
</html>

3
doc/devel/uml/class141829.html
View file

@ -16,5 +16,6 @@
<!-- ============================================================= -->
<a name="refclass141829"></a>
<p>Declaration :</p><ul><li>C++ : class Serializer </li></ul></body>
<p>Declaration :</p><ul><li>C++ : class Serializer </li></ul><p>Stereotype: actor</p>
</body>
</html>

3
doc/devel/uml/class142469.html
View file

@ -16,7 +16,8 @@
<!-- ============================================================= -->
<a name="refclass142469"></a>
<p>Declaration :</p><ul><li>C++ : class StateProxy : public <a href="class132741.html#refclass132741"><b>State</b></a> </li></ul><div class="sub">
<p>Declaration :</p><ul><li>C++ : class StateProxy : public <a href="class132741.html#refclass132741"><b>State</b></a> </li></ul><p>Stereotype: implementation</p>
<div class="sub">
</div>
<p>All public operations : <a href="class132741.html#refoperation135941"><b>allocateBuffer</b></a> , <a href="class132741.html#refoperation135813"><b>fetch</b></a> , <a href="class132741.html#refoperation136325"><b>isCalculated</b></a> , <a href="class132741.html#refoperation136197"><b>releaseBuffer</b></a> </p>
</body>

3
doc/devel/uml/class143365.html
View file

@ -21,7 +21,8 @@
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class144517.html#refclass144517"><b>Strategy</b></a></li><li>C++ : protected: <a href="class144517.html#refclass144517"><b>Strategy</b></a>* </li></ul><a name="refrelation156421"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class144517.html#refclass144517"><b>Strategy</b></a></li><li>C++ : protected: <a href="class144517.html#refclass144517"><b>Strategy</b></a>* </li></ul><a name="refrelation156677"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class144517.html#refclass144517"><b>Strategy</b></a></li><li>C++ : protected: <a href="class144517.html#refclass144517"><b>Strategy</b></a>* </li></ul><a name="refrelation156933"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class144261.html#refclass144261"><b>Invocation</b></a></li><li>C++ : protected: <a href="class144261.html#refclass144261"><b>Invocation</b></a>* </li></ul><a name="refoperation136581"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class144261.html#refclass144261"><b>Invocation</b></a></li><li>C++ : protected: <a href="class144261.html#refclass144261"><b>Invocation</b></a>* </li></ul><p>Stereotype: creates</p>
<a name="refoperation136581"></a>
<table><tr><td><div class="element">Operation <b>callDown</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : + callDown() : </li><li>C++ : public: callDown () </li></ul></div>
<p>All public operations : <a href="class143365.html#refoperation136581"><b>callDown</b></a> , <a href="class142725.html#refoperation136453"><b>callDown</b></a> </p>
</body>

3
doc/devel/uml/class144005.html
View file

@ -18,7 +18,8 @@
<a name="refclass144005"></a>
<p>Declaration :</p><ul><li>C++ : template&lt;int SIZ&gt; class BuffTable </li></ul><div class="sub">
<a name="refrelation153861"></a>
<table><tr><td><div class="element">Relation <b>&lt;directional aggregation by value&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class144133.html#refclass144133"><b>BuffHandle</b></a>, multiplicity : SIZ</li><li>C++ : protected: <a href="class144133.html#refclass144133"><b>BuffHandle</b></a> </li></ul><a name="refrelation153989"></a>
<table><tr><td><div class="element">Relation <b>&lt;directional composition&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class144133.html#refclass144133"><b>BuffHandle</b></a>, multiplicity : SIZ</li><li>C++ : protected: <a href="class144133.html#refclass144133"><b>BuffHandle</b></a> </li></ul><p>Stereotype: array</p>
<a name="refrelation153989"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a></li><li>C++ : protected: <a href="class142725.html#refclass142725"><b>WiringDescriptor</b></a>* </li></ul></div>
</body>
</html>

3
doc/devel/uml/class145285.html
View file

@ -16,5 +16,6 @@
<!-- ============================================================= -->
<a name="refclass145285"></a>
<p>Declaration :</p><ul><li>C++ : enum MediaKind </li><li>Java : package enum MediaKind </li></ul></body>
<p>Declaration :</p><ul><li>C++ : enum MediaKind </li><li>Java : package enum MediaKind </li></ul><p>Stereotype: enum</p>
</body>
</html>

8
doc/devel/uml/class145541.html
View file

@ -19,9 +19,11 @@
<p>Declaration :</p><ul><li>C++ : class Timeline </li></ul><p>Directly inherited by : <a href="class145797.html#refclass145797"><b>TimelineView</b></a> </p>
<div class="sub">
<a name="refrelation159109"></a>
<table><tr><td><div class="element">Relation <b>&lt;aggregation by value&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145669.html#refclass145669"><b>Project</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class145669.html#refclass145669"><b>Project</b></a> </li></ul><a name="refrelation159237"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145925.html#refclass145925"><b>PlayControl</b></a></li><li>C++ : protected: <a href="class145925.html#refclass145925"><b>PlayControl</b></a>* </li></ul><a name="refrelation159621"></a>
<table><tr><td><div class="element">Relation <b>&lt;composition&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145669.html#refclass145669"><b>Project</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class145669.html#refclass145669"><b>Project</b></a> </li></ul><a name="refrelation159237"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145925.html#refclass145925"><b>PlayControl</b></a></li><li>C++ : protected: <a href="class145925.html#refclass145925"><b>PlayControl</b></a>* </li></ul><p>Stereotype: own</p>
<a name="refrelation159621"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146309.html#refclass146309"><b>Sequence</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class146309.html#refclass146309"><b>Sequence</b></a>* </li></ul><a name="refrelation160005"></a>
<table><tr><td><div class="element">Relation <b>globalBusses (&lt;directional aggregation by value&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # globalBusses : <a href="class138117.html#refclass138117"><b>Pipe</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class138117.html#refclass138117"><b>Pipe</b></a> globalBusses</li></ul></div>
<table><tr><td><div class="element">Relation <b>globalBusses (&lt;directional composition&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # globalBusses : <a href="class138117.html#refclass138117"><b>Pipe</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class138117.html#refclass138117"><b>Pipe</b></a> globalBusses</li></ul><p>Stereotype: list</p>
</div>
</body>
</html>

4
doc/devel/uml/class145669.html
View file

@ -18,7 +18,7 @@
<a name="refclass145669"></a>
<p>Declaration :</p><ul><li>C++ : class Project </li></ul><div class="sub">
<a name="refrelation158981"></a>
<table><tr><td><div class="element">Relation <b>&lt;aggregation by value&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145541.html#refclass145541"><b>Timeline</b></a>, multiplicity : 1..*</li><li>C++ : protected: <a href="class145541.html#refclass145541"><b>Timeline</b></a> </li></ul><a name="refrelation159365"></a>
<table><tr><td><div class="element">Relation <b>&lt;aggregation by value&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146309.html#refclass146309"><b>Sequence</b></a>, multiplicity : 1..*</li><li>C++ : protected: <a href="class146309.html#refclass146309"><b>Sequence</b></a> </li></ul></div>
<table><tr><td><div class="element">Relation <b>&lt;composition&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145541.html#refclass145541"><b>Timeline</b></a>, multiplicity : 1..*</li><li>C++ : protected: <a href="class145541.html#refclass145541"><b>Timeline</b></a> </li></ul><a name="refrelation159365"></a>
<table><tr><td><div class="element">Relation <b>&lt;composition&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146309.html#refclass146309"><b>Sequence</b></a>, multiplicity : 1..*</li><li>C++ : protected: <a href="class146309.html#refclass146309"><b>Sequence</b></a> </li></ul></div>
</body>
</html>

3
doc/devel/uml/class145925.html
View file

@ -18,6 +18,7 @@
<a name="refclass145925"></a>
<p>Declaration :</p><ul><li>C++ : class PlayControl </li></ul><div class="sub">
<a name="refrelation160389"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146437.html#refclass146437"><b>PlayheadCursor</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class146437.html#refclass146437"><b>PlayheadCursor</b></a>* </li></ul></div>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146437.html#refclass146437"><b>PlayheadCursor</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class146437.html#refclass146437"><b>PlayheadCursor</b></a>* </li></ul><p>Stereotype: direct</p>
</div>
</body>
</html>

3
doc/devel/uml/class146053.html
View file

@ -18,7 +18,8 @@
<a name="refclass146053"></a>
<p>Declaration :</p><ul><li>C++ : class Monitor </li></ul><div class="sub">
<a name="refrelation160133"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145541.html#refclass145541"><b>Timeline</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class145541.html#refclass145541"><b>Timeline</b></a>* </li></ul><a name="refrelation160517"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145541.html#refclass145541"><b>Timeline</b></a>, multiplicity : 0..1</li><li>C++ : protected: <a href="class145541.html#refclass145541"><b>Timeline</b></a>* </li></ul><p>Stereotype: attach</p>
<a name="refrelation160517"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146437.html#refclass146437"><b>PlayheadCursor</b></a></li><li>C++ : protected: <a href="class146437.html#refclass146437"><b>PlayheadCursor</b></a>* </li></ul></div>
</body>
</html>

5
doc/devel/uml/class146309.html
View file

@ -18,8 +18,9 @@
<a name="refclass146309"></a>
<p>Declaration :</p><ul><li>C++ : class Sequence </li></ul><div class="sub">
<a name="refrelation159493"></a>
<table><tr><td><div class="element">Relation <b>&lt;aggregation by value&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145669.html#refclass145669"><b>Project</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class145669.html#refclass145669"><b>Project</b></a> </li></ul><a name="refrelation159877"></a>
<table><tr><td><div class="element">Relation <b>subSequences (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # subSequences : <a href="class146309.html#refclass146309"><b>Sequence</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class146309.html#refclass146309"><b>Sequence</b></a>* subSequences</li></ul><a name="refrelation161541"></a>
<table><tr><td><div class="element">Relation <b>&lt;composition&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class145669.html#refclass145669"><b>Project</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class145669.html#refclass145669"><b>Project</b></a> </li></ul><a name="refrelation159877"></a>
<table><tr><td><div class="element">Relation <b>subSequences (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # subSequences : <a href="class146309.html#refclass146309"><b>Sequence</b></a>, multiplicity : *</li><li>C++ : protected: <a href="class146309.html#refclass146309"><b>Sequence</b></a>* subSequences</li></ul><p>Stereotype: contains</p>
<a name="refrelation161541"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128517.html#refclass128517"><b>MObject</b></a></li><li>C++ : protected: <a href="class128517.html#refclass128517"><b>MObject</b></a>* </li></ul><a name="refrelation161669"></a>
<table><tr><td><div class="element">Relation <b>trackTree (&lt;unidirectional association&gt;)</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # trackTree : <a href="class128389.html#refclass128389"><b>Track</b></a>, multiplicity : 1</li><li>C++ : protected: <a href="class128389.html#refclass128389"><b>Track</b></a>* trackTree</li></ul></div>
</body>

1
doc/devel/uml/class146565.html
View file

@ -17,5 +17,6 @@
<a name="refclass146565"></a>
<p>Declaration :</p><ul><li>C++ : class Facade </li><li>Java : package interface Facade </li></ul><p>Directly inherited by : <a href="class146693.html#refclass146693"><b>Proxy</b></a> <a href="class146821.html#refclass146821"><b>ServiceImpl</b></a> </p>
<p>Stereotype: interface</p>
</body>
</html>

5
doc/devel/uml/class146693.html
View file

@ -17,7 +17,8 @@
<a name="refclass146693"></a>
<p>Declaration :</p><ul><li>C++ : class Proxy : public <a href="class146565.html#refclass146565"><b>Facade</b></a> </li></ul><div class="sub">
<a name="refrelation162181"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146949.html#refclass146949"><b>C_Interface</b></a></li><li>C++ : protected: <a href="class146949.html#refclass146949"><b>C_Interface</b></a>* </li></ul></div>
<a name="refrelation170117"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146949.html#refclass146949"><b>C_Interface</b></a></li><li>C++ : protected: <a href="class146949.html#refclass146949"><b>C_Interface</b></a>* </li></ul><p>Stereotype: uses</p>
</div>
</body>
</html>

5
doc/devel/uml/class146821.html
View file

@ -17,7 +17,8 @@
<a name="refclass146821"></a>
<p>Declaration :</p><ul><li>C++ : class ServiceImpl : public <a href="class146565.html#refclass146565"><b>Facade</b></a> </li></ul><div class="sub">
<a name="refrelation162437"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class147205.html#refclass147205"><b>InstanceHandle</b></a></li><li>C++ : protected: <a href="class147205.html#refclass147205"><b>InstanceHandle</b></a>* </li></ul></div>
<a name="refrelation170501"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class147205.html#refclass147205"><b>InstanceHandle</b></a></li><li>C++ : protected: <a href="class147205.html#refclass147205"><b>InstanceHandle</b></a>* </li></ul><p>Stereotype: has_a</p>
</div>
</body>
</html>

5
doc/devel/uml/class147077.html
View file

@ -17,7 +17,8 @@
<a name="refclass147077"></a>
<p>Declaration :</p><ul><li>C++ : class C_Instance : public <a href="class146949.html#refclass146949"><b>C_Interface</b></a> </li></ul><div class="sub">
<a name="refrelation162309"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146821.html#refclass146821"><b>ServiceImpl</b></a></li><li>C++ : protected: <a href="class146821.html#refclass146821"><b>ServiceImpl</b></a>* </li></ul></div>
<a name="refrelation170373"></a>
<table><tr><td><div class="element">Relation <b>&lt;unidirectional association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class146821.html#refclass146821"><b>ServiceImpl</b></a></li><li>C++ : protected: <a href="class146821.html#refclass146821"><b>ServiceImpl</b></a>* </li></ul><p>Stereotype: calls</p>
</div>
</body>
</html>

24
doc/devel/uml/class147333.html Normal file
View file

@ -0,0 +1,24 @@
<!-- 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 Segmentation</title>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body bgcolor="#ffffff">
<div class = "title">Class Segmentation</div>
<p></p>
<!-- ============================================================= -->
<a name="refclass147333"></a>
<p>Declaration :</p><ul><li>C++ : class Segmentation </li></ul><div class="sub">
<a name="refrelation163205"></a>
<table><tr><td><div class="element">Relation <b>&lt;association&gt;</b></div></td></tr></table><p>Declaration :</p><ul><li>Uml : # : <a href="class128261.html#refclass128261"><b>Fixture</b></a></li><li>C++ : protected: <a href="class128261.html#refclass128261"><b>Fixture</b></a>* </li></ul><p>Stereotype: partitioning</p>
</div>
</body>
</html>

3
doc/devel/uml/classdiagrams.html
View file

@ -18,7 +18,8 @@
<table>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram130309" target = "projectFrame"><b>Asset Kinds</b></a></td><td></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram129669" target = "projectFrame"><b>Automation Entities</b></a></td><td></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram129285" target = "projectFrame"><b>Builder Entities</b></a></td><td></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram132868" target = "projectFrame"><b>Builder Entities</b></a></td><td></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram129285" target = "projectFrame"><b>Builder Tool (Visitor)</b></a></td><td></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram128645" target = "projectFrame"><b>Controller Entities</b></a></td><td></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram128181" target = "projectFrame"><b>File Mapping</b></a></td><td></td><td>Shows whats used to access Frames</td></tr>
<tr bgcolor=#f0f0f0><td><a href="index.html#refclass diagram130181" target = "projectFrame"><b>Hierarchy</b></a></td><td></td><td>Lumiera Exception hierarchy</td></tr>

Some files were not shown because too many files have changed in this diff Show more