Mercurial > hg > ltpda

view m-toolbox/html_help/help/ug/class_desc_collection_content.html @ 36:5eb86f6881ef database-connection-manager

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Remove commented-out code
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_collection_content.html,v 1.3 2011/05/12 19:47:55 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_collection.html#top_properties">Properties</a>
                </td>
                <td>Properties of the class</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_collection.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_collection.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: 'objs' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection.objs')">objs</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>objects in collection</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- Property: 'hist' -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection.hist')">hist</a></p>
          </td>
          <td>
            <p>history of the object (history object)</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- Property: 'procinfo' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection.procinfo')">procinfo</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>plist with additional information for an object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- Property: 'plotinfo' -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection.plotinfo')">plotinfo</a></p>
          </td>
          <td>
            <p>plist with the plot information</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- Property: 'name' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection.name')">name</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>name of the object</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uo</p>
          </td>
        </tr>
        <!-- Property: 'description' -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection.description')">description</a></p>
          </td>
          <td>
            <p>description of the object</p>
          </td>
          <td>
            <p>ltpda_uo</p>
          </td>
        </tr>
        <!-- Property: 'mdlfile' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection.mdlfile')">mdlfile</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>model xml file of the LTPDAworkbench</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uo</p>
          </td>
        </tr>
        <!-- Property: 'UUID' -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection.UUID')">UUID</a></p>
          </td>
          <td>
            <p>Universally Unique Identifier of 128-bit</p>
          </td>
          <td>
            <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_collection.html#constructor">Constructor</a>
                </td>
                <td>Constructor of this class</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_collection.html#helper">Helper</a>
                </td>
                <td>Helper methods only for internal usage</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_collection.html#internal">Internal</a>
                </td>
                <td>Internal methods only for internal usage</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_collection.html#output">Output</a>
                </td>
                <td>Output methods</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_collection.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>
        <!-- collection/collection -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection')">collection</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>COLLECTION constructor for collection class.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- ltpda_uoh/rebuild -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/rebuild')">rebuild</a></p>
          </td>
          <td>
            <p>REBUILD rebuilds the input objects using the history.</p>
          </td>
          <td>
            <p>ltpda_uoh</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>
        <!-- collection/addObjects -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/addObjects')">addObjects</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ADDOBJECTS adds the given objects to the collection.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- collection/getObjectAtIndex -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/getObjectAtIndex')">getObjectAtIndex</a></p>
          </td>
          <td>
            <p>GETOBJECTATINDEX index into the inner objects of one collection object.</p>
          </td>
          <td>
            <p>collection</p>
          </td>
        </tr>
        <!-- collection/getObjectsOfClass -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/getObjectsOfClass')">getObjectsOfClass</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>GETOBJECTSOFCLASS returns all objects of the specified class in a collection-object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- collection/nobjs -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/nobjs')">nobjs</a></p>
          </td>
          <td>
            <p>NOBJS Returns the number of objects in the inner object array.</p>
          </td>
          <td>
            <p>collection</p>
          </td>
        </tr>
        <!-- collection/removeObjectAtIndex -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/removeObjectAtIndex')">removeObjectAtIndex</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>REMOVEOBJECTATINDEX removes the object at the specified position from the collection.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- collection/setObjectAtIndex -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/setObjectAtIndex')">setObjectAtIndex</a></p>
          </td>
          <td>
            <p>SETOBJECTATINDEX sets an input object to the collection.</p>
          </td>
          <td>
            <p>collection</p>
          </td>
        </tr>
        <!-- collection/setObjs -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/setObjs')">setObjs</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETOBJS sets the 'objs' property of a collection object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- ltpda_obj/get -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/get')">get</a></p>
          </td>
          <td>
            <p>GET get a property of a object.</p>
          </td>
          <td>
            <p>ltpda_obj</p>
          </td>
        </tr>
        <!-- ltpda_uoh/created -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/created')">created</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>CREATED Returns a time object of the last modification.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/creator -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/creator')">creator</a></p>
          </td>
          <td>
            <p>CREATOR Extract the creator(s) from the history.</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/csvexport -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/csvexport')">csvexport</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>CSVEXPORT Exports the data of an object to a csv file.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/index -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/index')">index</a></p>
          </td>
          <td>
            <p>INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/requirements -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/requirements')">requirements</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/setDescription -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/setDescription')">setDescription</a></p>
          </td>
          <td>
            <p>SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/setMdlfile -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/setMdlfile')">setMdlfile</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/setName -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/setName')">setName</a></p>
          </td>
          <td>
            <p>SETNAME Sets the property 'name' of an ltpda_uoh object.</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/setPlotinfo -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/setPlotinfo')">setPlotinfo</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/setProcinfo -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/setProcinfo')">setProcinfo</a></p>
          </td>
          <td>
            <p>SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.</p>
          </td>
          <td>
            <p>ltpda_uoh</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>
        <!-- collection/generateConstructorPlist -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/generateConstructorPlist')">generateConstructorPlist</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- ltpda_obj/isprop -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/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>
        <!-- ltpda_uo/bsubmit -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/bsubmit')">bsubmit</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uo</p>
          </td>
        </tr>
        <!-- ltpda_uo/submit -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/submit')">submit</a></p>
          </td>
          <td>
            <p>SUBMIT Submits the given objects to an LTPDA repository</p>
          </td>
          <td>
            <p>ltpda_uo</p>
          </td>
        </tr>
        <!-- ltpda_uo/update -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/update')">update</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>UPDATE Updates the given object in an LTPDA repository</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uo</p>
          </td>
        </tr>
        <!-- ltpda_uoh/string -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/string')">string</a></p>
          </td>
          <td>
            <p>STRING writes a command string that can be used to recreate the input object(s).</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/type -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/type')">type</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>TYPE converts the input objects to MATLAB functions.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</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>
        <!-- collection/char -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/char')">char</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>CHAR convert a collection object into a string.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>collection</p>
          </td>
        </tr>
        <!-- collection/display -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/display')">display</a></p>
          </td>
          <td>
            <p>DISPLAY overloads display functionality for collection objects.</p>
          </td>
          <td>
            <p>collection</p>
          </td>
        </tr>
        <!-- ltpda_uo/save -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/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>
        <!-- ltpda_uoh/report -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('collection/report')">report</a></p>
          </td>
          <td>
            <p>REPORT generates an HTML report about the input objects.</p>
          </td>
          <td>
            <p>ltpda_uoh</p>
          </td>
        </tr>
        <!-- ltpda_uoh/viewHistory -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('collection/viewHistory')">viewHistory</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>ltpda_uoh</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('collection/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('collection/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                  -->
  <!-- ================================================== -->