Mercurial > hg > ltpda
view m-toolbox/html_help/help/ug/class_desc_history_content.html @ 8:2f5c9bd7d95d database-connection-manager
Clarify ltpda_uo.retrieve parameters handling
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Mon, 05 Dec 2011 16:20:06 +0100 |
parents | f0afece42f48 |
children |
line wrap: on
line source
<!-- $Id: class_desc_history_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_history.html#top_properties">Properties</a> </td> <td>Properties of the class</td> </tr> <tr valign="top"> <td> <a href="class_desc_history.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: 'methodInfo' --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><tt>methodInfo</tt></p> </td> <td bgcolor="#f3f4f5"> <p>minfo-object which is created in the called method.</p> </td> <td bgcolor="#f3f4f5"> <p>history</p> </td> </tr> <!-- Property: 'plistUsed' --> <tr valign="top"> <td> <p><tt>plistUsed</tt></p> </td> <td> <p>plist-object which is used in the called method.</p> </td> <td> <p>history</p> </td> </tr> <!-- Property: 'methodInvars' --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><tt>methodInvars</tt></p> </td> <td bgcolor="#f3f4f5"> <p>Variable names which are used for the called method.</p> </td> <td bgcolor="#f3f4f5"> <p>history</p> </td> </tr> <!-- Property: 'inhists' --> <tr valign="top"> <td> <p><tt>inhists</tt></p> </td> <td> <p>The older history-objects</p> </td> <td> <p>history</p> </td> </tr> <!-- Property: 'proctime' --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><tt>proctime</tt></p> </td> <td bgcolor="#f3f4f5"> <p>Creation time of the history object (unix epoch time)</p> </td> <td bgcolor="#f3f4f5"> <p>history</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>history</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_history.html#constructor">Constructor</a> </td> <td>Constructor of this class</td> </tr> <tr valign="top"> <td> <a href="class_desc_history.html#helper">Helper</a> </td> <td>Helper methods only for internal usage</td> </tr> <tr valign="top"> <td> <a href="class_desc_history.html#internal">Internal</a> </td> <td>Internal methods only for internal usage</td> </tr> <tr valign="top"> <td> <a href="class_desc_history.html#output">Output</a> </td> <td>Output methods</td> </tr> <tr valign="top"> <td> <a href="class_desc_history.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> <!-- history/history --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('history')">history</a></p> </td> <td bgcolor="#f3f4f5"> <p>HISTORY History object class constructor.</p> </td> <td bgcolor="#f3f4f5"> <p>history</p> </td> </tr> <!-- history/rebuild --> <tr valign="top"> <td> <p><a href="matlab:doc('history/rebuild')">rebuild</a></p> </td> <td> <p>REBUILD rebuilds the orignal object using the history.</p> </td> <td> <p>history</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: Internal ===== --> <h3 class="title"><a name="internal"/>Internal</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> <!-- history/getNodes --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('history/getNodes')">getNodes</a></p> </td> <td bgcolor="#f3f4f5"> <p>GETNODES converts a history object to a nodes structure suitable for plotting as a tree.</p> </td> <td bgcolor="#f3f4f5"> <p>history</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> <!-- history/char --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('history/char')">char</a></p> </td> <td bgcolor="#f3f4f5"> <p>CHAR convert a param object into a string.</p> </td> <td bgcolor="#f3f4f5"> <p>history</p> </td> </tr> <!-- history/display --> <tr valign="top"> <td> <p><a href="matlab:doc('history/display')">display</a></p> </td> <td> <p>DISPLAY implement terminal display for history object.</p> </td> <td> <p>history</p> </td> </tr> <!-- history/dotview --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('history/dotview')">dotview</a></p> </td> <td bgcolor="#f3f4f5"> <p>DOTVIEW view history of an object via the DOT interpreter.</p> </td> <td bgcolor="#f3f4f5"> <p>history</p> </td> </tr> <!-- history/hist2dot --> <tr valign="top"> <td> <p><a href="matlab:doc('history/hist2dot')">hist2dot</a></p> </td> <td> <p>HIST2DOT converts a history object to a 'DOT' file suitable for processing with graphviz</p> </td> <td> <p>history</p> </td> </tr> <!-- history/hist2m --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('history/hist2m')">hist2m</a></p> </td> <td bgcolor="#f3f4f5"> <p>HIST2M writes a new m-file that reproduces the analysis described in the history object.</p> </td> <td bgcolor="#f3f4f5"> <p>history</p> </td> </tr> <!-- history/plot --> <tr valign="top"> <td> <p><a href="matlab:doc('history/plot')">plot</a></p> </td> <td> <p>PLOT plots a history object as a tree diagram.</p> </td> <td> <p>history</p> </td> </tr> <!-- history/string --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('history/string')">string</a></p> </td> <td bgcolor="#f3f4f5"> <p>STRING writes a command string that can be used to recreate the input history object.</p> </td> <td bgcolor="#f3f4f5"> <p>history</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 --> <!-- ================================================== -->