benn/lumiera_
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
lumiera_/doc/devel/uml/public_operations.html

61 lines
9.2 KiB
HTML
Raw Normal View History

Some notes to the wiki, including first verion of the UML diagrams
2007-06-19 09:22:52 +02:00
<!-- 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>Public Operations Index</title>
<link rel="stylesheet" href="style.css" type="text/css" />
</head>
<body bgcolor="#ffffff">
<div class = "title">Public Operations Index</div>
<p></p>
<!-- ============================================================= -->
<table>
<tr bgcolor=#f0f0f0><td align=center><b>Operation</b></td><td align=center><b>Class</b></td><td align=center><b>Description</b></td></tr>
switch to the backported BOUML version 2.27-2 which gives us stable image links. Note 2.28 introduces major format changes and is not bug-free at the moment, so I rather backported only the needed functionallity
2007-06-25 09:02:09 +02:00
<tr bgcolor=#f0f0f0><td><a href="class134021.html#refoperation129669"><b>apply</b></a></td><td><a href="class134021.html#refclass134021"><b>Buildable</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class131077.html#refoperation128901"><b>build</b></a></td><td><a href="class131077.html#refclass131077"><b>Assembler</b></a></td><td></td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class130565.html#refoperation128517"><b>buildEngine</b></a></td><td><a href="class130565.html#refclass130565"><b>BuilderFacade</b></a></td><td>Main Operation of the Builder: create a render engine for a given part of the timeline</td></tr>
switch to the backported BOUML version 2.27-2 which gives us stable image links. Note 2.28 introduces major format changes and is not bug-free at the moment, so I rather backported only the needed functionallity
2007-06-25 09:02:09 +02:00
<tr bgcolor=#f0f0f0><td><a href="class130437.html#refoperation128261"><b>buildProcessor</b></a></td><td><a href="class130437.html#refclass130437"><b>PathManager</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class130693.html#refoperation128773"><b>configure</b></a></td><td><a href="class130693.html#refclass130693"><b>ToolFactory</b></a></td><td></td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refoperation132997"><b>enable</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>change the enabled status of this asset. Note the corresponding #isActive predicate may depend on the enablement status of parent assets as well</td></tr>
<tr bgcolor=#f0f0f0><td><a href="class135429.html#refoperation131589"><b>get</b></a></td><td><a href="class135429.html#refclass135429"><b>Appconfig</b></a></td><td>access the configuation value for a given key.<br />@return empty string for unknown keys, else the corresponding configuration value</td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class129541.html#refoperation131205"><b>get_repr</b></a></td><td><a href="class129541.html#refclass129541"><b>Allocation</b></a></td><td></td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class136581.html#refoperation132485"><b>getAsset</b></a></td><td><a href="class136581.html#refclass136581"><b>AssetManager</b></a></td><td>find and return corresponging object</td></tr>
switch to the backported BOUML version 2.27-2 which gives us stable image links. Note 2.28 introduces major format changes and is not bug-free at the moment, so I rather backported only the needed functionallity
2007-06-25 09:02:09 +02:00
<tr bgcolor=#f0f0f0><td><a href="class128261.html#refoperation129157"><b>getAutomation</b></a></td><td><a href="class128261.html#refclass128261"><b>Fixture</b></a></td><td></td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class130821.html#refoperation129029"><b>getConnection</b></a></td><td><a href="class130821.html#refclass130821"><b>ConManager</b></a></td><td>TODO</td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refoperation132229"><b>getDependant</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>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.</td></tr>
upgraded UML-Model to BOUML 2.29-1 To help with the conversion, which will create a bunch of new object instance nodes, I separated out the Object diagrams into a separate use case view
2007-08-03 18:40:18 +02:00
<tr bgcolor=#f0f0f0><td><a href="class128181.html#refoperation128181"><b>getFrame</b></a></td><td><a href="class128181.html#refclass128181"><b>File</b></a></td><td>mode = READ, WRITE, ...</td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refoperation132101"><b>getParents</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>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</td></tr>
switch to the backported BOUML version 2.27-2 which gives us stable image links. Note 2.28 introduces major format changes and is not bug-free at the moment, so I rather backported only the needed functionallity
2007-06-25 09:02:09 +02:00
<tr bgcolor=#f0f0f0><td><a href="class128261.html#refoperation128645"><b>getPlaylistForRender</b></a></td><td><a href="class128261.html#refclass128261"><b>Fixture</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class130949.html#refoperation128389"><b>getStateProxy</b></a></td><td><a href="class130949.html#refclass130949"><b>RenderState</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class129925.html#refoperation131077"><b>getValue</b></a></td><td><a href="class129925.html#refclass129925"><b>Auto</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class134533.html#refoperation130821"><b>getValue</b></a></td><td><a href="class134533.html#refclass134533"><b>Parameter</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class134661.html#refoperation130949"><b>getValue</b></a></td><td><a href="class134661.html#refclass134661"><b>ParamProvider</b></a></td><td></td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refoperation132869"><b>isActive</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>weather this asset is swithced on and consequently included in the fixture and participates in rendering</td></tr>
<tr bgcolor=#f0f0f0><td><a href="class136581.html#refoperation132613"><b>known</b></a></td><td><a href="class136581.html#refclass136581"><b>AssetManager</b></a></td><td>@return true if the given id is registered in the internal asset DB</td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class131333.html#refoperation129413"><b>play</b></a></td><td><a href="class131333.html#refclass131333"><b>RenderEngine</b></a></td><td>TODO: will probably be handled differently (see Cehteh)</td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class136581.html#refoperation132357"><b>register</b></a></td><td><a href="class136581.html#refclass136581"><b>AssetManager</b></a></td><td>registers an asset object in the internal DB, providing its unique key</td></tr>
<tr bgcolor=#f0f0f0><td><a href="class136581.html#refoperation132741"><b>remove</b></a></td><td><a href="class136581.html#refclass136581"><b>AssetManager</b></a></td><td>remove the given asset &lt;i&gt;together with all its dependants&lt;/i&gt; from the internal DB</td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class128645.html#refoperation128005"><b>resolve</b></a></td><td><a href="class128645.html#refclass128645"><b>Placement</b></a></td><td>create an actual (explicit) placement while trying to satisfy the network of adjacent objects and placements.</td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class135557.html#refoperation131973"><b>rootCause</b></a></td><td><a href="class135557.html#refclass135557"><b>Error</b></a></td><td>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</td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class134405.html#refoperation130693"><b>treat</b></a></td><td><a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a></td><td></td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class134405.html#refoperation130565"><b>treat</b></a></td><td><a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class134405.html#refoperation130437"><b>treat</b></a></td><td><a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a></td><td></td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class134405.html#refoperation130309"><b>treat</b></a></td><td><a href="class134405.html#refclass134405"><b>NodeCreatorTool</b></a></td><td></td></tr>
switch to the backported BOUML version 2.27-2 which gives us stable image links. Note 2.28 introduces major format changes and is not bug-free at the moment, so I rather backported only the needed functionallity
2007-06-25 09:02:09 +02:00
<tr bgcolor=#f0f0f0><td><a href="class134277.html#refoperation129925"><b>treat</b></a></td><td><a href="class134277.html#refclass134277"><b>SegmentationTool</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class134277.html#refoperation130053"><b>treat</b></a></td><td><a href="class134277.html#refclass134277"><b>SegmentationTool</b></a></td><td></td></tr>
class/modelling refinements
2007-08-05 04:51:55 +02:00
<tr bgcolor=#f0f0f0><td><a href="class134277.html#refoperation130181"><b>treat</b></a></td><td><a href="class134277.html#refclass134277"><b>SegmentationTool</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class134149.html#refoperation129797"><b>treat</b></a></td><td><a href="class134149.html#refclass134149"><b>Tool</b></a></td><td>This operation is to be overloaded for the specific MObject subclasses to be treated.</td></tr>
upgraded UML-Model to BOUML 2.29-1 To help with the conversion, which will create a bunch of new object instance nodes, I separated out the Object diagrams into a separate use case view
2007-08-03 18:40:18 +02:00
<tr bgcolor=#f0f0f0><td><a href="class129333.html#refoperation128010"><b>useFile</b></a></td><td><a href="class129333.html#refclass129333"><b>FileProvider</b></a></td><td>Announces that the application intends to use this file with mode (READ|WRITE|READWRITE)</td></tr>
<tr bgcolor=#f0f0f0><td><a href="class129333.html#refoperation128138"><b>useTemporaryStorage</b></a></td><td><a href="class129333.html#refclass129333"><b>FileProvider</b></a></td><td>Provides a pool for interminate frames</td></tr>
Preliminary Design of the Asset Subsystem. While I don't want to target this complex now, I designed some of the fundamental aspects as far as needed to be able to add Objects to the EDL and build a render graph from them.
2007-09-02 17:51:46 +02:00
<tr bgcolor=#f0f0f0><td><a href="class135557.html#refoperation131845"><b>what</b></a></td><td><a href="class135557.html#refclass135557"><b>Error</b></a></td><td></td></tr>
<tr bgcolor=#f0f0f0><td><a href="class136325.html#refoperation131717"><b>what</b></a></td><td><a href="class136325.html#refclass136325"><b>std::exception</b></a></td><td>the base class of all exceptions thrown by the standard library</td></tr>
Some notes to the wiki, including first verion of the UML diagrams
2007-06-19 09:22:52 +02:00
</table>
</body>
</html>
Reference in a new issue Copy permalink