Mercurial > hg > ltpda
view m-toolbox/html_help/help/ug/class_desc_plist.html @ 47:dd93c9ba6624 database-connection-manager
Fix Java dialog
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Tue, 06 Dec 2011 19:07:27 +0100 |
parents | f0afece42f48 |
children |
line wrap: on
line source
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> <html lang="en"> <head> <meta name="generator" content= "HTML Tidy for Mac OS X (vers 1st December 2004), see www.w3.org"> <meta http-equiv="Content-Type" content= "text/html; charset=us-ascii"> <title>plist Class (LTPDA Toolbox)</title> <link rel="stylesheet" href="docstyle.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.52.2"> <meta name="description" content= "Presents an overview of the features, system requirements, and starting the toolbox."> </head> <body> <a name="top_of_page" id="top_of_page"></a> <p style="font-size:1px;"> </p> <table class="nav" summary="Navigation aid" border="0" width= "100%" cellpadding="0" cellspacing="0"> <tr> <td valign="baseline"><b>LTPDA Toolbox</b></td><td><a href="../helptoc.html">contents</a></td> <td valign="baseline" align="right"><a href= "class_desc_pest.html"><img src="b_prev.gif" border="0" align= "bottom" alt="pest Class"></a> <a href= "class_desc_pzmodel.html"><img src="b_next.gif" border="0" align= "bottom" alt="pzmodel Class"></a></td> </tr> </table> <h1 class="title"><a name="f3-12899" id="f3-12899"></a>plist Class</h1> <hr> <p> <!-- ================================================== --> <!-- 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_plist.html#top_properties">Properties</a> </td> <td>Properties of the class</td> </tr> <tr valign="top"> <td> <a href="class_desc_plist.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_plist.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: 'params' --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist.params')">params</a></p> </td> <td bgcolor="#f3f4f5"> <p>list of param-objects</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- Property: 'name' --> <tr valign="top"> <td> <p><a href="matlab:doc('plist.name')">name</a></p> </td> <td> <p>name of the object</p> </td> <td> <p>ltpda_uo</p> </td> </tr> <!-- Property: 'description' --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist.description')">description</a></p> </td> <td bgcolor="#f3f4f5"> <p>description of the object</p> </td> <td bgcolor="#f3f4f5"> <p>ltpda_uo</p> </td> </tr> <!-- Property: 'mdlfile' --> <tr valign="top"> <td> <p><a href="matlab:doc('plist.mdlfile')">mdlfile</a></p> </td> <td> <p>model xml file of the LTPDAworkbench</p> </td> <td> <p>ltpda_uo</p> </td> </tr> <!-- Property: 'UUID' --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist.UUID')">UUID</a></p> </td> <td bgcolor="#f3f4f5"> <p>Universally Unique Identifier of 128-bit</p> </td> <td bgcolor="#f3f4f5"> <p>ltpda_uo</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_plist.html#constructor">Constructor</a> </td> <td>Constructor of this class</td> </tr> <tr valign="top"> <td> <a href="class_desc_plist.html#helper">Helper</a> </td> <td>Helper methods only for internal usage</td> </tr> <tr valign="top"> <td> <a href="class_desc_plist.html#internal">Internal</a> </td> <td>Internal methods only for internal usage</td> </tr> <tr valign="top"> <td> <a href="class_desc_plist.html#output">Output</a> </td> <td>Output methods</td> </tr> <tr valign="top"> <td> <a href="class_desc_plist.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> <!-- plist/plist --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist')">plist</a></p> </td> <td bgcolor="#f3f4f5"> <p>PLIST Plist class object constructor.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</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('plist/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> <!-- plist/append --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/append')">append</a></p> </td> <td> <p>APPEND append a param-object, plist-object or a key/value pair to the parameter list.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/combine --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/combine')">combine</a></p> </td> <td bgcolor="#f3f4f5"> <p>COMBINE multiple parameter lists (plist objects) into a single plist.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/find --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/find')">find</a></p> </td> <td> <p>FIND overloads find routine for a parameter list.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/getIndexForKey --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/getIndexForKey')">getIndexForKey</a></p> </td> <td bgcolor="#f3f4f5"> <p>GETINDEXFORKEY returns the index of a parameter with the given key.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/getKeys --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/getKeys')">getKeys</a></p> </td> <td> <p>GETKEYS Return all the keys of the parameter list.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/getOptionsForParam --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/getOptionsForParam')">getOptionsForParam</a></p> </td> <td bgcolor="#f3f4f5"> <p>GETOPTIONSFORPARAM Returns the options for the specified parameter key.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/getParamValueForParam --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/getParamValueForParam')">getParamValueForParam</a></p> </td> <td> <p>GETPARAMVALUEFORPARAM Returns the paramValue for the specified parameter key.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/getSelectionForParam --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/getSelectionForParam')">getSelectionForParam</a></p> </td> <td bgcolor="#f3f4f5"> <p>GETSELECTIONFORPARAM Returns the selection mode for the specified parameter key.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/isparam --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/isparam')">isparam</a></p> </td> <td> <p>ISPARAM look for a given key in the parameter lists.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/merge --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/merge')">merge</a></p> </td> <td bgcolor="#f3f4f5"> <p>MERGE the values for the same key of multiple parameter lists together.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/mfind --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/mfind')">mfind</a></p> </td> <td> <p>MFIND multiple-arguments find routine for a parameter list.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/nparams --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/nparams')">nparams</a></p> </td> <td bgcolor="#f3f4f5"> <p>NPARAMS returns the number of param objects in the list.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/pset --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/pset')">pset</a></p> </td> <td> <p>PSET set or add a key/value pairor a param-object into the parameter list.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/remove --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/remove')">remove</a></p> </td> <td bgcolor="#f3f4f5"> <p>REMOVE remove a parameter from the parameter list.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/removeKeys --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/removeKeys')">removeKeys</a></p> </td> <td> <p>REMOVEKEYS removes keys from a PLIST.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/setDefaultForParam --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/setDefaultForParam')">setDefaultForParam</a></p> </td> <td bgcolor="#f3f4f5"> <p>SETDEFAULTFORPARAM Sets the default value of the param object in dependencies of the 'key'</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/setDescription --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/setDescription')">setDescription</a></p> </td> <td> <p>SETDESCRIPTION sets the 'description' property of a plist object.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/setDescriptionForParam --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/setDescriptionForParam')">setDescriptionForParam</a></p> </td> <td bgcolor="#f3f4f5"> <p>SETDESCRIPTIONFORPARAM Sets the property 'desc' of the param object in dependencies of the 'key'</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/setMdlfile --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/setMdlfile')">setMdlfile</a></p> </td> <td> <p>SETMDLFILE sets the 'mdlfile' property of a ltpda_uo object.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/setName --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/setName')">setName</a></p> </td> <td bgcolor="#f3f4f5"> <p>SETNAME Sets the property 'name' of a plist object.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/setOptionsForParam --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/setOptionsForParam')">setOptionsForParam</a></p> </td> <td> <p>SETOPTIONSFORPARAM Sets the options of the param object in dependencies of the 'key'</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/setSelectionForParam --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/setSelectionForParam')">setSelectionForParam</a></p> </td> <td bgcolor="#f3f4f5"> <p>SETSELECTIONFORPARAM Sets the selection mode of the param object in dependencies of the 'key'</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/string --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/string')">string</a></p> </td> <td> <p>STRING converts a plist object to a command string which will recreate the plist object.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/subset --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/subset')">subset</a></p> </td> <td bgcolor="#f3f4f5"> <p>SUBSET returns a subset of a parameter list.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</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> <!-- ltpda_obj/isprop --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/isprop')">isprop</a></p> </td> <td bgcolor="#f3f4f5"> <p>ISPROP tests if the given field is one of the object properties.</p> </td> <td bgcolor="#f3f4f5"> <p>ltpda_obj</p> </td> </tr> <!-- ltpda_uo/bsubmit --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/bsubmit')">bsubmit</a></p> </td> <td> <p>BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository</p> </td> <td> <p>ltpda_uo</p> </td> </tr> <!-- ltpda_uo/submit --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/submit')">submit</a></p> </td> <td bgcolor="#f3f4f5"> <p>SUBMIT Submits the given objects to an LTPDA repository</p> </td> <td bgcolor="#f3f4f5"> <p>ltpda_uo</p> </td> </tr> <!-- ltpda_uo/update --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/update')">update</a></p> </td> <td> <p>UPDATE Updates the given object in an LTPDA repository</p> </td> <td> <p>ltpda_uo</p> </td> </tr> <!-- plist/getDescriptionForParam --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/getDescriptionForParam')">getDescriptionForParam</a></p> </td> <td bgcolor="#f3f4f5"> <p>GETDESCRIPTIONFORPARAM Returns the description for the specified parameter key.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/getSetRandState --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/getSetRandState')">getSetRandState</a></p> </td> <td> <p>GETSETRANDSTATE gets or sets the random state of the MATLAB functions 'rand' and 'randn'</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/parse --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/parse')">parse</a></p> </td> <td bgcolor="#f3f4f5"> <p>PARSE a plist for strings which can be converted into numbers</p> </td> <td bgcolor="#f3f4f5"> <p>plist</p> </td> </tr> <!-- plist/plist2cmds --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/plist2cmds')">plist2cmds</a></p> </td> <td> <p>PLIST2CMDS convert a plist to a set of commands.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/shouldIgnore --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/shouldIgnore')">shouldIgnore</a></p> </td> <td bgcolor="#f3f4f5"> <p>SHOULDIGNORE True for plists which have the key 'ignore' with the value true.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</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> <!-- ltpda_uo/save --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/save')">save</a></p> </td> <td bgcolor="#f3f4f5"> <p>SAVE overloads save operator for ltpda objects.</p> </td> <td bgcolor="#f3f4f5"> <p>ltpda_uo</p> </td> </tr> <!-- plist/char --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/char')">char</a></p> </td> <td> <p>CHAR convert a parameter list into a string.</p> </td> <td> <p>plist</p> </td> </tr> <!-- plist/display --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/display')">display</a></p> </td> <td bgcolor="#f3f4f5"> <p>DISPLAY display plist object.</p> </td> <td bgcolor="#f3f4f5"> <p>plist</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/ne --> <tr valign="top"> <td bgcolor="#f3f4f5"> <p><a href="matlab:doc('plist/ne')">ne</a></p> </td> <td bgcolor="#f3f4f5"> <p>NE overloads the ~= operator for ltpda objects.</p> </td> <td bgcolor="#f3f4f5"> <p>ltpda_obj</p> </td> </tr> <!-- plist/eq --> <tr valign="top"> <td> <p><a href="matlab:doc('plist/eq')">eq</a></p> </td> <td> <p>EQ overloads the == operator for ltpda plist objects.</p> </td> <td> <p>plist</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 --> <!-- ================================================== --> </p> <br> <br> <table class="nav" summary="Navigation aid" border="0" width= "100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td align="left" width="20"><a href="class_desc_pest.html"><img src= "b_prev.gif" border="0" align="bottom" alt= "pest Class"></a> </td> <td align="left">pest Class</td> <td> </td> <td align="right">pzmodel Class</td> <td align="right" width="20"><a href= "class_desc_pzmodel.html"><img src="b_next.gif" border="0" align= "bottom" alt="pzmodel Class"></a></td> </tr> </table><br> <p class="copy">©LTP Team</p> </body> </html>