VES5.0/doxygen-1.8.12/html/examples/pyexample/html/classpyexample_1_1PyClass.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.12"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>Python: pyexample.PyClass Class Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">Python
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.12 -->
  30 <script type="text/javascript" src="menudata.js"></script>
  31 <script type="text/javascript" src="menu.js"></script>
  32 <script type="text/javascript">
  33 $(function() {
  34   initMenu('',false,false,'search.php','Search');
  35 });
  36 </script>
  37 <div id="main-nav"></div>
  38 <div id="nav-path" class="navpath">
  39   <ul>
  40 <li class="navelem"><a class="el" href="namespacepyexample.html">pyexample</a></li><li class="navelem"><a class="el" href="classpyexample_1_1PyClass.html">PyClass</a></li>  </ul>
  41 </div>
  42 </div><!-- top -->
  43 <div class="header">
  44   <div class="summary">
  45 <a href="#pub-methods">Public Member Functions</a> &#124;
  46 <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  47 <a href="classpyexample_1_1PyClass-members.html">List of all members</a>  </div>
  48   <div class="headertitle">
  49 <div class="title">pyexample.PyClass Class Reference</div>  </div>
  50 </div><!--header-->
  51 <div class="contents">
  52
  53 <p>Documentation for a class.
  54  <a href="classpyexample_1_1PyClass.html#details">More...</a></p>
  55 <table class="memberdecls">
  56 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  57 Public Member Functions</h2></td></tr>
  58 <tr class="memitem:a87e20fe7e81cb5a1c04e620c076ab8ac"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyexample_1_1PyClass.html#a87e20fe7e81cb5a1c04e620c076ab8ac">__init__</a> (self)</td></tr>
  59 <tr class="memdesc:a87e20fe7e81cb5a1c04e620c076ab8ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">The constructor.  <a href="#a87e20fe7e81cb5a1c04e620c076ab8ac">More...</a><br /></td></tr>
  60 <tr class="separator:a87e20fe7e81cb5a1c04e620c076ab8ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:a654596774eb28a0c6d26eea565de3a9d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyexample_1_1PyClass.html#a654596774eb28a0c6d26eea565de3a9d">PyMethod</a> (self)</td></tr>
  62 <tr class="memdesc:a654596774eb28a0c6d26eea565de3a9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Documentation for a method.  <a href="#a654596774eb28a0c6d26eea565de3a9d">More...</a><br /></td></tr>
  63 <tr class="separator:a654596774eb28a0c6d26eea565de3a9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 </table><table class="memberdecls">
  65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  66 Static Public Attributes</h2></td></tr>
  67 <tr class="memitem:abd17aff54e5b0ca194020c796c733546"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpyexample_1_1PyClass.html#abd17aff54e5b0ca194020c796c733546">classVar</a> = 0;</td></tr>
  68 <tr class="memdesc:abd17aff54e5b0ca194020c796c733546"><td class="mdescLeft">&#160;</td><td class="mdescRight">A class variable.  <a href="#abd17aff54e5b0ca194020c796c733546">More...</a><br /></td></tr>
  69 <tr class="separator:abd17aff54e5b0ca194020c796c733546"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 </table>
  71 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  72 <div class="textblock"><p>Documentation for a class. </p>
  73 <p>More details. </p>
  74 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  75 <a id="a87e20fe7e81cb5a1c04e620c076ab8ac"></a>
  76 <h2 class="memtitle"><span class="permalink"><a href="#a87e20fe7e81cb5a1c04e620c076ab8ac">&sect;&nbsp;</a></span>__init__()</h2>
  77
  78 <div class="memitem">
  79 <div class="memproto">
  80       <table class="memname">
  81         <tr>
  82           <td class="memname">def pyexample.PyClass.__init__ </td>
  83           <td>(</td>
  84           <td class="paramtype">&#160;</td>
  85           <td class="paramname"><em>self</em></td><td>)</td>
  86           <td></td>
  87         </tr>
  88       </table>
  89 </div><div class="memdoc">
  90
  91 <p>The constructor. </p>
  92
  93 </div>
  94 </div>
  95 <h2 class="groupheader">Member Function Documentation</h2>
  96 <a id="a654596774eb28a0c6d26eea565de3a9d"></a>
  97 <h2 class="memtitle"><span class="permalink"><a href="#a654596774eb28a0c6d26eea565de3a9d">&sect;&nbsp;</a></span>PyMethod()</h2>
  98
  99 <div class="memitem">
 100 <div class="memproto">
 101       <table class="memname">
 102         <tr>
 103           <td class="memname">def pyexample.PyClass.PyMethod </td>
 104           <td>(</td>
 105           <td class="paramtype">&#160;</td>
 106           <td class="paramname"><em>self</em></td><td>)</td>
 107           <td></td>
 108         </tr>
 109       </table>
 110 </div><div class="memdoc">
 111
 112 <p>Documentation for a method. </p>
 113 <dl class="params"><dt>Parameters</dt><dd>
 114   <table class="params">
 115     <tr><td class="paramname">self</td><td>The object pointer. </td></tr>
 116   </table>
 117   </dd>
 118 </dl>
 119
 120 </div>
 121 </div>
 122 <h2 class="groupheader">Member Data Documentation</h2>
 123 <a id="abd17aff54e5b0ca194020c796c733546"></a>
 124 <h2 class="memtitle"><span class="permalink"><a href="#abd17aff54e5b0ca194020c796c733546">&sect;&nbsp;</a></span>classVar</h2>
 125
 126 <div class="memitem">
 127 <div class="memproto">
 128 <table class="mlabels">
 129   <tr>
 130   <td class="mlabels-left">
 131       <table class="memname">
 132         <tr>
 133           <td class="memname">int pyexample.PyClass.classVar = 0;</td>
 134         </tr>
 135       </table>
 136   </td>
 137   <td class="mlabels-right">
 138 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 139   </tr>
 140 </table>
 141 </div><div class="memdoc">
 142
 143 <p>A class variable. </p>
 144
 145 </div>
 146 </div>
 147 <hr/>The documentation for this class was generated from the following file:<ul>
 148 <li>pyexample.py</li>
 149 </ul>
 150 </div><!-- contents -->
 151 <!-- start footer part -->
 152 <hr class="footer"/><address class="footer"><small>
 153 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 154 <img class="footer" src="doxygen.png" alt="doxygen"/>
 155 </a> 1.8.12
 156 </small></address>
 157 </body>
 158 </html>