31 lines
3.2 KiB
HTML
31 lines
3.2 KiB
HTML
<!-- Documentation produced by the Html generator of Bouml (http://bouml.free.fr) -->
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
|
<head>
|
|
<title>Public Properties Index</title>
|
|
<link rel="stylesheet" href="style.css" type="text/css" />
|
|
</head>
|
|
|
|
<body bgcolor="#ffffff">
|
|
|
|
<div class = "title">Public Properties Index</div>
|
|
<p></p>
|
|
|
|
<!-- ============================================================= -->
|
|
|
|
<table>
|
|
<tr bgcolor=#f0f0f0><td align=center><b>Property</b></td><td align=center><b>Class</b></td><td align=center><b>Description</b></td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refrelation140421"><b>category</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>primary tree like classification of the asset</td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class139653.html#refrelation144773"><b>current</b></a></td><td><a href="class139653.html#refclass139653"><b>Session</b></a></td><td>Standard access path to get at the current session via the Session Manager, which acts as a "PImpl" smart pointer</td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refattribute130437"><b>id</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>Asset primary key.</td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refattribute130565"><b>name</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>element ID, comprehensible but sanitized. The tuple (category, name, org) is unique.</td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class139141.html#refrelation144133"><b>nodes</b></a></td><td><a href="class139141.html#refclass139141"><b>DoAttach</b></a></td><td></td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refattribute130821"><b>org</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>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".</td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class139141.html#refattribute131461"><b>point</b></a></td><td><a href="class139141.html#refclass139141"><b>DoAttach</b></a></td><td>identifying the point where the nodes should be attached</td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class128389.html#refrelation147205"><b>subTracks</b></a></td><td><a href="class128389.html#refclass128389"><b>Track</b></a></td><td>Child tracks in a tree structure</td></tr>
|
|
<tr bgcolor=#f0f0f0><td><a href="class136453.html#refattribute130949"><b>version</b></a></td><td><a href="class136453.html#refclass136453"><b>Asset</b></a></td><td>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.</td></tr>
|
|
</table>
|
|
</body>
|
|
</html>
|