Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 4fccfe23f6486142b4197d1daac0cf21 > files > 29

Falcon-doc-0.9.6.6-2.fc15.noarch.rpm

<html>
<head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>Class Method - Class Method</title>
   <link href="faldoc.css" rel="stylesheet" type="text/css"/>
   <link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body class="faldoc_body">
<div class="navitop">
   <div class="tabs">
      <ul>
         <li><a href="./index.html"><span>Main</span></a></li>
         <li><a href="./pages.html"><span>Related pages</span></a></li>
         <li><a href="./groups.html"><span>Groups</span></a></li>
         <li><a href="./funset.html"><span>Function sets</span></a></li>
         <li><a href="./classes.html"><span>Classes</span></a></li>
         <li><a href="./objects.html"><span>Objects</span></a></li>
         <li><a href="./functions.html"><span>All functions</span></a></li>
         <li><a href="./globals.html"><span>Globals</span></a></li>
         
      </ul>
   </div>
</div>
<hr/>

<h1 class="faldoc_title">Class Method</h1>

<p class="faldoc_brief">Metaclass of method items. </p>
<p class="faldoc_funcdecl">
<b>class</b> Method \
      <b>from</b> <a href="./class_BOM.html">BOM</a>
</p>


   <p class="faldoc_brief"><a href="#more">more...</a></p>
   <h2 class="faldoc_title">Summary</h2>
   <table class="faldoc_list">
   
      
         <tr><td><a href="#attributes">attributes()</a></td><td>Returns the attributes associated with the method function. </td></tr>
      
         <tr><td><a href="#base">base()</a></td><td>Returns the function or the array associated with this method. </td></tr>
      
         <tr><td><a href="#source">source()</a></td><td>Returns the object associated with this method. </td></tr>
      
   
   </table>





   <h3 class="faldoc_title">Inherited methods</h3>
   <table class="faldoc_list">
   
      <tr><td><a href="./class_BOM.html#__add">__add</a> from BOM&nbsp;</td><td>Overrides binary addition operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__call">__call</a> from BOM&nbsp;</td><td>Overrides call operator "self()". </td></tr>
   
      <tr><td><a href="./class_BOM.html#__dec">__dec</a> from BOM&nbsp;</td><td>Overrides decrement unary prefix operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__decpost">__decpost</a> from BOM&nbsp;</td><td>Overrides decrement unary postfix operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__div">__div</a> from BOM&nbsp;</td><td>Overrides binary division operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__getIndex">__getIndex</a> from BOM&nbsp;</td><td>Overrides array access operator [] </td></tr>
   
      <tr><td><a href="./class_BOM.html#__inc">__inc</a> from BOM&nbsp;</td><td>Overrides increment unary prefix operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__incpost">__incpost</a> from BOM&nbsp;</td><td>Overrides increment unary postifx operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__mod">__mod</a> from BOM&nbsp;</td><td>Overrides modulo operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__mul">__mul</a> from BOM&nbsp;</td><td>Overrides binary multiplication operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__pow">__pow</a> from BOM&nbsp;</td><td>Overrides power operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#__setIndex">__setIndex</a> from BOM&nbsp;</td><td>Overrides array write operator [] </td></tr>
   
      <tr><td><a href="./class_BOM.html#__sub">__sub</a> from BOM&nbsp;</td><td>Overrides binary subtraction operand. </td></tr>
   
      <tr><td><a href="./class_BOM.html#baseClass">baseClass</a> from BOM&nbsp;</td><td>Returns the class item from which an object has been instantiated. </td></tr>
   
      <tr><td><a href="./class_BOM.html#bound">bound</a> from BOM&nbsp;</td><td>Determines if an item is bound or not. </td></tr>
   
      <tr><td><a href="./class_BOM.html#className">className</a> from BOM&nbsp;</td><td>Returns the name of the class an instance is instantiated from. </td></tr>
   
      <tr><td><a href="./class_BOM.html#clone">clone</a> from BOM&nbsp;</td><td>Performs a deep copy of the item. </td></tr>
   
      <tr><td><a href="./class_BOM.html#compare">compare</a> from BOM&nbsp;</td><td>Performs a lexicographical comparison. </td></tr>
   
      <tr><td><a href="./class_BOM.html#derivedFrom">derivedFrom</a> from BOM&nbsp;</td><td>Checks if this item has a given parent. </td></tr>
   
      <tr><td><a href="./class_BOM.html#describe">describe</a> from BOM&nbsp;</td><td>Returns the deep contents of an item on a string representation. </td></tr>
   
      <tr><td><a href="./class_BOM.html#isCallable">isCallable</a> from BOM&nbsp;</td><td>Determines if an item is callable. </td></tr>
   
      <tr><td><a href="./class_BOM.html#len">len</a> from BOM&nbsp;</td><td>Retrieves the length of a collection </td></tr>
   
      <tr><td><a href="./class_BOM.html#metaclass">metaclass</a> from BOM&nbsp;</td><td>Returns the metaclass associated with this item. </td></tr>
   
      <tr><td><a href="./class_BOM.html#ptr">ptr</a> from BOM&nbsp;</td><td>Returns a raw memory pointer out of this data (as an integer). </td></tr>
   
      <tr><td><a href="./class_BOM.html#serialize">serialize</a> from BOM&nbsp;</td><td>Serialize the item on a stream for persistent storage. </td></tr>
   
      <tr><td><a href="./class_BOM.html#toString">toString</a> from BOM&nbsp;</td><td>Coverts the object to string. </td></tr>
   
      <tr><td><a href="./class_BOM.html#typeId">typeId</a> from BOM&nbsp;</td><td>Returns an integer indicating the type of this item. </td></tr>
   
   </table>



<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>

<p class="faldoc_funcdecl">
<b>class</b> Method \
      <b>from</b> <a href="./class_BOM.html">BOM</a>
</p>
<table class="faldoc_function">


</table>
<br/>
<p class="item_brief">Metaclass of method items. </p>
<p class="faldoc_text">This is the class reflecting falcon method items. A method is a set of an item and a function applied to that. The item can be a method again, as it is possible to apply methods to method items. </p>




   <h2 class="faldoc_title">Methods</h2>
   
      <h3 class="faldoc_funcname"><a name="attributes">attributes()</a></h3>
      <p class="item_brief">Returns the attributes associated with the method function. </p>
      <p class="faldoc_funcdecl">Method.attributes( )</p>
      
         <table class="faldoc_function">
         
         
         <tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">Nil if the function has no attributes, or a string-indexed dictionary. </td></tr>
         
         </table>
      
      
   
      <h3 class="faldoc_funcname"><a name="base">base()</a></h3>
      <p class="item_brief">Returns the function or the array associated with this method. </p>
      <p class="faldoc_funcdecl">Method.base( )</p>
      
         <table class="faldoc_function">
         
         
         <tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The function or array that is applied on the associated object. </td></tr>
         
         </table>
      
      <p class="faldoc_text"><p class="faldoc_text">Returns a function or a callable array that is associated with the object in this method. </p>
<p class="faldoc_text">This method cannot return external functions; only function generated by Falcon native modules can be returned. This is because externa functions are not suited to be extracted from methods and eventually re-associated with other objects. </p>
<p class="faldoc_text">This method will raise an error in case it refers to an external function. However, it can be safely used to extract base callable arrays. </p>
</p>
   
      <h3 class="faldoc_funcname"><a name="source">source()</a></h3>
      <p class="item_brief">Returns the object associated with this method. </p>
      <p class="faldoc_funcdecl">Method.source( )</p>
      
         <table class="faldoc_function">
         
         
         <tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The object from which this method was created. </td></tr>
         
         </table>
      
      <p class="faldoc_text"><p class="faldoc_text">Returns an object (or an item, in case this is a BOM method) that gave birth to this method. </p>
</p>
   

<hr/>
<div class="navibottom">
   <center>
      <a href="./index.html">Main</a>&nbsp;&nbsp;-&nbsp;&nbsp;<a href="./pages.html">Related pages</a>&nbsp;&nbsp;-&nbsp;&nbsp;<a href="./groups.html">Groups</a>&nbsp;&nbsp;-&nbsp;&nbsp;<a href="./funset.html">Function sets</a>&nbsp;&nbsp;-&nbsp;&nbsp;<a href="./classes.html">Classes</a>&nbsp;&nbsp;-&nbsp;&nbsp;<a href="./objects.html">Objects</a>&nbsp;&nbsp;-&nbsp;&nbsp;<a href="./functions.html">All functions</a>&nbsp;&nbsp;-&nbsp;&nbsp;<a href="./globals.html">Globals</a>
   </center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>