Mercurial > hg > ltpda

diff m-toolbox/html_help/help/ug/class_desc_provenance_content.html @ 0:f0afece42f48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/html_help/help/ug/class_desc_provenance_content.html	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,486 @@
+<!-- $Id: class_desc_provenance_content.html,v 1.11 2009/03/17 16:52:04 ingo Exp $ -->
+
+  <!-- ================================================== -->
+  <!--                 BEGIN CONTENT FILE                 -->
+  <!-- ================================================== -->
+  <!-- ===== link box: Begin ===== -->
+  <p>
+    <table border="1"  width="80%">
+      <tr>
+        <td>
+          <table border="0" cellpadding="5" class="categorylist" width="100%">
+            <colgroup>
+              <col width="37%"/>
+              <col width="63%"/>
+            </colgroup>
+            <tbody>
+              <tr valign="top">
+                <td>
+                  <a href="class_desc_provenance.html#top_properties">Properties</a>
+                </td>
+                <td>Properties of the class</td>
+              </tr>
+              <tr valign="top">
+                <td>
+                  <a href="class_desc_provenance.html#top_methods">Methods</a>
+                </td>
+                <td>All Methods of the class ordered by category.</td>
+              </tr>
+              <tr valign="top">
+                <td>
+                  <a href="constructor_examples_main.html">Examples</a>
+                </td>
+                <td>Some constructor examples</td>
+              </tr>
+            </tbody>
+          </table>
+        </td>
+      </tr>
+    </table>
+  </p>
+  <!-- ===== link box: End ====== -->
+
+  <!-- ===== Back to Class descriptions ===== -->
+  <a href="class_desc_main.html">
+    <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/>
+    Back to Class descriptions
+  </a>
+
+  <h2 class="title"><a name="top_properties"/>Properties</h2>
+  <p>
+    The LTPDA toolbox restrict access of the properties.<br></br>
+    The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br>
+    <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre>
+    The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
+    <pre class="programlisting">
+For example:
+obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span>
+obj.setName(<span class="string">'my name'</span>);        <span class="comment">% This command applies to obj</span>    </pre>
+  </p>
+  <!-- ===== Properties ===== -->
+  <p>
+    <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
+      <colgroup>
+        <col width="15%"/>
+        <col width="73%"/>
+        <col width="12%"/>
+      </colgroup>
+      <thead>
+        <tr valign="top">
+          <th class="categorylist">Properties</th>
+          <th class="categorylist">Description</th>
+          <th class="categorylist">Defined in class</th>
+        </tr>
+      </thead>
+      <tbody>
+        <!-- Property: 'creator' -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><tt>creator</tt></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>Current user of the LTPDA toolbox</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'ip' -->
+        <tr valign="top">
+          <td>
+            <p><tt>ip</tt></p>
+          </td>
+          <td>
+            <p>IP address of the creator</p>
+          </td>
+          <td>
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'hostname' -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><tt>hostname</tt></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>Hostname of the creator</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'os' -->
+        <tr valign="top">
+          <td>
+            <p><tt>os</tt></p>
+          </td>
+          <td>
+            <p>Used system of the creator</p>
+          </td>
+          <td>
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'matlab_version' -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><tt>matlab_version</tt></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>MATLAB version</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'sigproc_version' -->
+        <tr valign="top">
+          <td>
+            <p><tt>sigproc_version</tt></p>
+          </td>
+          <td>
+            <p>Signal Processing Toolbox version</p>
+          </td>
+          <td>
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'symbolic_math_version' -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><tt>symbolic_math_version</tt></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>Symbolic Math Toolbox version</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'optimization_version' -->
+        <tr valign="top">
+          <td>
+            <p><tt>optimization_version</tt></p>
+          </td>
+          <td>
+            <p>Optimization Toolbox version</p>
+          </td>
+          <td>
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'database_version' -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><tt>database_version</tt></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>Database Toolbox version</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'control_version' -->
+        <tr valign="top">
+          <td>
+            <p><tt>control_version</tt></p>
+          </td>
+          <td>
+            <p></p>
+          </td>
+          <td>
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'ltpda_version' -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><tt>ltpda_version</tt></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>LTPDA Toolbox version</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- Property: 'version' -->
+        <tr valign="top">
+          <td>
+            <p><tt>version</tt></p>
+          </td>
+          <td>
+            <p>CVS version string of the constructor</p>
+          </td>
+          <td>
+            <p>provenance</p>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+  </p>
+
+  <!-- ===== Top of page ===== -->
+  <a href="#top_of_page">
+    <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
+    Back to Top
+  </a>
+
+  <h2 class="title"><a name="top_methods"/>Methods</h2>
+  <!-- ===== link box: Begin ===== -->
+  <p>
+    <table border="1"  width="80%">
+      <tr>
+        <td>
+          <table border="0" cellpadding="5" class="subcategorylist" width="100%">
+            <colgroup>
+              <col width="37%"/>
+              <col width="63%"/>
+            </colgroup>
+            <tbody>
+              <tr valign="top">
+                <td>
+                  <a href="class_desc_provenance.html#constructor">Constructor</a>
+                </td>
+                <td>Constructor of this class</td>
+              </tr>
+              <tr valign="top">
+                <td>
+                  <a href="class_desc_provenance.html#helper">Helper</a>
+                </td>
+                <td>Helper methods only for internal usage</td>
+              </tr>
+              <tr valign="top">
+                <td>
+                  <a href="class_desc_provenance.html#output">Output</a>
+                </td>
+                <td>Output methods</td>
+              </tr>
+              <tr valign="top">
+                <td>
+                  <a href="class_desc_provenance.html#relational_operator">Relational Operator</a>
+                </td>
+                <td>Relational operator methods</td>
+              </tr>
+            </tbody>
+          </table>
+        </td>
+      </tr>
+    </table>
+  </p>
+  <!-- ===== link box: End ====== -->
+
+  <!-- ===== Top of page ===== -->
+  <a href="#top_of_page">
+    <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
+    Back to Top
+  </a>
+
+  <!-- ===== Methods Category: Constructor ===== -->
+  <h3 class="title"><a name="constructor"/>Constructor</h3>
+  <p>
+    <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
+      <colgroup>
+        <col width="15%"/>
+        <col width="73%"/>
+        <col width="12%"/>
+      </colgroup>
+      <thead>
+        <tr valign="top">
+          <th class="categorylist">Methods</th>
+          <th class="categorylist">Description</th>
+          <th class="categorylist">Defined in class</th>
+        </tr>
+      </thead>
+      <tbody>
+        <!-- provenance/provenance -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><a href="matlab:doc('provenance')">provenance</a></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>PROVENANCE constructors for provenance class.</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+    <!-- ===== Back to Top of Methods ===== -->
+    <a href="#top_methods">
+      <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
+      Back to Top of Section
+    </a>
+
+  </p>
+
+  <!-- ===== Methods Category: Helper ===== -->
+  <h3 class="title"><a name="helper"/>Helper</h3>
+  <p>
+    <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
+      <colgroup>
+        <col width="15%"/>
+        <col width="73%"/>
+        <col width="12%"/>
+      </colgroup>
+      <thead>
+        <tr valign="top">
+          <th class="categorylist">Methods</th>
+          <th class="categorylist">Description</th>
+          <th class="categorylist">Defined in class</th>
+        </tr>
+      </thead>
+      <tbody>
+        <!-- ltpda_obj/get -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>GET get a property of a object.</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>ltpda_obj</p>
+          </td>
+        </tr>
+        <!-- ltpda_obj/isprop -->
+        <tr valign="top">
+          <td>
+            <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
+          </td>
+          <td>
+            <p>ISPROP tests if the given field is one of the object properties.</p>
+          </td>
+          <td>
+            <p>ltpda_obj</p>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+    <!-- ===== Back to Top of Methods ===== -->
+    <a href="#top_methods">
+      <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
+      Back to Top of Section
+    </a>
+
+  </p>
+
+  <!-- ===== Methods Category: Output ===== -->
+  <h3 class="title"><a name="output"/>Output</h3>
+  <p>
+    <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
+      <colgroup>
+        <col width="15%"/>
+        <col width="73%"/>
+        <col width="12%"/>
+      </colgroup>
+      <thead>
+        <tr valign="top">
+          <th class="categorylist">Methods</th>
+          <th class="categorylist">Description</th>
+          <th class="categorylist">Defined in class</th>
+        </tr>
+      </thead>
+      <tbody>
+        <!-- provenance/char -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><a href="matlab:doc('provenance/char')">char</a></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>CHAR convert a provenance object into a string.</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- provenance/display -->
+        <tr valign="top">
+          <td>
+            <p><a href="matlab:doc('provenance/display')">display</a></p>
+          </td>
+          <td>
+            <p>DISPLAY overload terminal display for provenance objects.</p>
+          </td>
+          <td>
+            <p>provenance</p>
+          </td>
+        </tr>
+        <!-- provenance/string -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><a href="matlab:doc('provenance/string')">string</a></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>STRING writes a command string that can be used to recreate the input provenance object.</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>provenance</p>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+    <!-- ===== Back to Top of Methods ===== -->
+    <a href="#top_methods">
+      <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
+      Back to Top of Section
+    </a>
+
+  </p>
+
+  <!-- ===== Methods Category: Relational_Operator ===== -->
+  <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
+  <p>
+    <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
+      <colgroup>
+        <col width="15%"/>
+        <col width="73%"/>
+        <col width="12%"/>
+      </colgroup>
+      <thead>
+        <tr valign="top">
+          <th class="categorylist">Methods</th>
+          <th class="categorylist">Description</th>
+          <th class="categorylist">Defined in class</th>
+        </tr>
+      </thead>
+      <tbody>
+        <!-- ltpda_obj/eq -->
+        <tr valign="top">
+          <td bgcolor="#f3f4f5">
+            <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>EQ overloads the == operator for ltpda objects.</p>
+          </td>
+          <td bgcolor="#f3f4f5">
+            <p>ltpda_obj</p>
+          </td>
+        </tr>
+        <!-- ltpda_obj/ne -->
+        <tr valign="top">
+          <td>
+            <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
+          </td>
+          <td>
+            <p>NE overloads the ~= operator for ltpda objects.</p>
+          </td>
+          <td>
+            <p>ltpda_obj</p>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+    <!-- ===== Back to Top of Methods ===== -->
+    <a href="#top_methods">
+      <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
+      Back to Top of Section
+    </a>
+
+  </p>
+
+  <!-- ================================================== -->
+  <!--                  END CONTENT FILE                  -->
+  <!-- ================================================== -->