view m-toolbox/html_help/help/ug/class_desc_unit_content.html @ 7:1e91f84a4be8
database-connection-manager
Make ltpda_up.retrieve work with java.sql.Connection objects
| author |
Daniele Nicolodi <nicolodi@science.unitn.it> |
| date |
Mon, 05 Dec 2011 16:20:06 +0100 (2011-12-05) |
| parents |
f0afece42f48 |
| children |
|
line source
<!-- $Id: class_desc_unit_content.html,v 1.3 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_unit.html#top_properties">Properties</a>
</td>
<td>Properties of the class</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_unit.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: 'strs' -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><tt>strs</tt></p>
</td>
<td bgcolor="#f3f4f5">
<p>Unit character</p>
</td>
<td bgcolor="#f3f4f5">
<p>unit</p>
</td>
</tr>
<!-- Property: 'exps' -->
<tr valign="top">
<td>
<p><tt>exps</tt></p>
</td>
<td>
<p>Exponent of the unit</p>
</td>
<td>
<p>unit</p>
</td>
</tr>
<!-- Property: 'vals' -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><tt>vals</tt></p>
</td>
<td bgcolor="#f3f4f5">
<p>Number of the used unit prefix (mm -> 1e-3)</p>
</td>
<td bgcolor="#f3f4f5">
<p>unit</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>unit</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_unit.html#constructor">Constructor</a>
</td>
<td>Constructor of this class</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_unit.html#helper">Helper</a>
</td>
<td>Helper methods only for internal usage</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_unit.html#output">Output</a>
</td>
<td>Output methods</td>
</tr>
<tr valign="top">
<td>
<a href="class_desc_unit.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>
<!-- unit/unit -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('unit')">unit</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>UNIT a helper class for implementing units in LTPDA.</p>
</td>
<td bgcolor="#f3f4f5">
<p>unit</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>
<!-- unit/string -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('unit/string')">string</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>STRING converts a unit object to a command string which will recreate the unit object.</p>
</td>
<td bgcolor="#f3f4f5">
<p>unit</p>
</td>
</tr>
<!-- unit/tolabel -->
<tr valign="top">
<td>
<p><a href="matlab:doc('unit/tolabel')">tolabel</a></p>
</td>
<td>
<p>TOLABEL converts a unit object to LaTeX string suitable for use as axis</p>
</td>
<td>
<p>unit</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>
<!-- unit/display -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('unit/display')">display</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>DISPLAY display an unit object.</p>
</td>
<td bgcolor="#f3f4f5">
<p>unit</p>
</td>
</tr>
<!-- unit/factor -->
<tr valign="top">
<td>
<p><a href="matlab:doc('unit/factor')">factor</a></p>
</td>
<td>
<p>FACTOR factorises units in to numerator and denominator units.</p>
</td>
<td>
<p>unit</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>
<!-- unit/eq -->
<tr valign="top">
<td bgcolor="#f3f4f5">
<p><a href="matlab:doc('unit/eq')">eq</a></p>
</td>
<td bgcolor="#f3f4f5">
<p>EQ overloads the == operator for ltpda unit objects.</p>
</td>
<td bgcolor="#f3f4f5">
<p>unit</p>
</td>
</tr>
<!-- unit/ne -->
<tr valign="top">
<td>
<p><a href="matlab:doc('unit/ne')">ne</a></p>
</td>
<td>
<p>NE overloads the ~= operator for ltpda unit objects.</p>
</td>
<td>
<p>unit</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 -->
<!-- ================================================== -->
