vnfs/VES5.0/doxygen-1.8.12/html/examples/tclexample/html/classns_1_1oo__class.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>Tcl: ns::oo_class 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">Tcl
  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="namespacens.html">ns</a></li><li class="navelem"><a class="el" href="classns_1_1oo__class.html">oo_class</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="#pro-methods">Protected Member Functions</a> &#124;
  48 <a href="classns_1_1oo__class-members.html">List of all members</a>  </div>
  49   <div class="headertitle">
  50 <div class="title">ns::oo_class Class Reference</div>  </div>
  51 </div><!--header-->
  52 <div class="contents">
  53
  54 <p>Documented oo class <code><a class="el" href="classns_1_1oo__class.html" title="Documented oo class oo_class . ">oo_class</a></code> .
  55  <a href="classns_1_1oo__class.html#details">More...</a></p>
  56 <table class="memberdecls">
  57 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58 Public Member Functions</h2></td></tr>
  59 <tr class="memitem:aa26b64151d4b4b0e8b4977aae7048f9b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html#aa26b64151d4b4b0e8b4977aae7048f9b">constructor</a> args</td></tr>
  60 <tr class="memdesc:aa26b64151d4b4b0e8b4977aae7048f9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create object.  <a href="#aa26b64151d4b4b0e8b4977aae7048f9b">More...</a><br /></td></tr>
  61 <tr class="separator:aa26b64151d4b4b0e8b4977aae7048f9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 <tr class="memitem:af148cfc1c090a05986c68ac9452a510a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html#af148cfc1c090a05986c68ac9452a510a">destructor</a></td></tr>
  63 <tr class="memdesc:af148cfc1c090a05986c68ac9452a510a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy object.  <a href="#af148cfc1c090a05986c68ac9452a510a">More...</a><br /></td></tr>
  64 <tr class="separator:af148cfc1c090a05986c68ac9452a510a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <tr class="memitem:a8a3cfbae3b3fca463f08adb9174a5fe8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html#a8a3cfbae3b3fca463f08adb9174a5fe8">oo_method_z</a> arg</td></tr>
  66 <tr class="memdesc:a8a3cfbae3b3fca463f08adb9174a5fe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Documented oo method <code>oo_method_z</code> .  <a href="#a8a3cfbae3b3fca463f08adb9174a5fe8">More...</a><br /></td></tr>
  67 <tr class="separator:a8a3cfbae3b3fca463f08adb9174a5fe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 </table><table class="memberdecls">
  69 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  70 Static Public Attributes</h2></td></tr>
  71 <tr class="memitem:a741f11f4a2db3876205658d4a9a279ba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html#a741f11f4a2db3876205658d4a9a279ba">oo_var</a></td></tr>
  72 <tr class="memdesc:a741f11f4a2db3876205658d4a9a279ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Documented oo var <code>oo_var</code> .  <a href="#a741f11f4a2db3876205658d4a9a279ba">More...</a><br /></td></tr>
  73 <tr class="separator:a741f11f4a2db3876205658d4a9a279ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:af46293ede16067c38ca2901416cad8ee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html#af46293ede16067c38ca2901416cad8ee">oo_var_out</a></td></tr>
  75 <tr class="memdesc:af46293ede16067c38ca2901416cad8ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outside defined variable <code>oo_var_out</code> .  <a href="#af46293ede16067c38ca2901416cad8ee">More...</a><br /></td></tr>
  76 <tr class="separator:af46293ede16067c38ca2901416cad8ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 </table><table class="memberdecls">
  78 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  79 Protected Member Functions</h2></td></tr>
  80 <tr class="memitem:ad07feb192f34010ed66d123338c7acdd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classns_1_1oo__class.html#ad07feb192f34010ed66d123338c7acdd">oo_method_y</a> arg</td></tr>
  81 <tr class="memdesc:ad07feb192f34010ed66d123338c7acdd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Documented oo method <code>oo_method_y</code> .  <a href="#ad07feb192f34010ed66d123338c7acdd">More...</a><br /></td></tr>
  82 <tr class="separator:ad07feb192f34010ed66d123338c7acdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 </table>
  84 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  85 <div class="textblock"><p>Documented oo class <code><a class="el" href="classns_1_1oo__class.html" title="Documented oo class oo_class . ">oo_class</a></code> . </p>
  86 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  87 <a id="aa26b64151d4b4b0e8b4977aae7048f9b"></a>
  88 <h2 class="memtitle"><span class="permalink"><a href="#aa26b64151d4b4b0e8b4977aae7048f9b">&sect;&nbsp;</a></span>constructor()</h2>
  89
  90 <div class="memitem">
  91 <div class="memproto">
  92       <table class="memname">
  93         <tr>
  94           <td class="memname">ns::oo_class::constructor</td>
  95           <td></td>
  96           <td class="paramtype">&#160;</td>
  97           <td class="paramname">args &#160;</td>
  98         </tr>
  99         <tr>
 100           <td></td>
 101           <td></td>
 102           <td></td><td></td>
 103         </tr>
 104       </table>
 105 </div><div class="memdoc">
 106
 107 <p>Create object. </p>
 108 <p>Configure with args </p>
 109 <div class="fragment"><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="keyword">constructor</span> {args} {<span class="keyword">eval</span> $args}</div></div><!-- fragment -->
 110 </div>
 111 </div>
 112 <a id="af148cfc1c090a05986c68ac9452a510a"></a>
 113 <h2 class="memtitle"><span class="permalink"><a href="#af148cfc1c090a05986c68ac9452a510a">&sect;&nbsp;</a></span>destructor()</h2>
 114
 115 <div class="memitem">
 116 <div class="memproto">
 117       <table class="memname">
 118         <tr>
 119           <td class="memname">ns::oo_class::destructor</td>
 120         </tr>
 121       </table>
 122 </div><div class="memdoc">
 123
 124 <p>Destroy object. </p>
 125 <p>Exit. </p>
 126 <div class="fragment"><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="keyword">destructor</span> {<span class="keyword">exit</span>}</div></div><!-- fragment -->
 127 </div>
 128 </div>
 129 <h2 class="groupheader">Member Function Documentation</h2>
 130 <a id="ad07feb192f34010ed66d123338c7acdd"></a>
 131 <h2 class="memtitle"><span class="permalink"><a href="#ad07feb192f34010ed66d123338c7acdd">&sect;&nbsp;</a></span>oo_method_y()</h2>
 132
 133 <div class="memitem">
 134 <div class="memproto">
 135 <table class="mlabels">
 136   <tr>
 137   <td class="mlabels-left">
 138       <table class="memname">
 139         <tr>
 140           <td class="memname">ns::oo_class::oo_method_y</td>
 141           <td></td>
 142           <td class="paramtype">&#160;</td>
 143           <td class="paramname">arg &#160;</td>
 144         </tr>
 145         <tr>
 146           <td></td>
 147           <td></td>
 148           <td></td><td></td>
 149         </tr>
 150       </table>
 151   </td>
 152   <td class="mlabels-right">
 153 <span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 154   </tr>
 155 </table>
 156 </div><div class="memdoc">
 157
 158 <p>Documented oo method <code>oo_method_y</code> . </p>
 159 <p>param[in] arg Argument </p>
 160 <div class="fragment"><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keyword">method</span> oo_method_y {arg} {}</div></div><!-- fragment -->
 161 </div>
 162 </div>
 163 <a id="a8a3cfbae3b3fca463f08adb9174a5fe8"></a>
 164 <h2 class="memtitle"><span class="permalink"><a href="#a8a3cfbae3b3fca463f08adb9174a5fe8">&sect;&nbsp;</a></span>oo_method_z()</h2>
 165
 166 <div class="memitem">
 167 <div class="memproto">
 168       <table class="memname">
 169         <tr>
 170           <td class="memname">ns::oo_class::oo_method_z</td>
 171           <td></td>
 172           <td class="paramtype">&#160;</td>
 173           <td class="paramname">arg &#160;</td>
 174         </tr>
 175         <tr>
 176           <td></td>
 177           <td></td>
 178           <td></td><td></td>
 179         </tr>
 180       </table>
 181 </div><div class="memdoc">
 182
 183 <p>Documented oo method <code>oo_method_z</code> . </p>
 184 <p>param[in] arg Argument </p>
 185 <div class="fragment"><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="keyword">method</span> oo_method_z {arg} {}</div></div><!-- fragment -->
 186 </div>
 187 </div>
 188 <h2 class="groupheader">Member Data Documentation</h2>
 189 <a id="a741f11f4a2db3876205658d4a9a279ba"></a>
 190 <h2 class="memtitle"><span class="permalink"><a href="#a741f11f4a2db3876205658d4a9a279ba">&sect;&nbsp;</a></span>oo_var</h2>
 191
 192 <div class="memitem">
 193 <div class="memproto">
 194 <table class="mlabels">
 195   <tr>
 196   <td class="mlabels-left">
 197       <table class="memname">
 198         <tr>
 199           <td class="memname">ns::oo_class::oo_var</td>
 200         </tr>
 201       </table>
 202   </td>
 203   <td class="mlabels-right">
 204 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 205   </tr>
 206 </table>
 207 </div><div class="memdoc">
 208
 209 <p>Documented oo var <code>oo_var</code> . </p>
 210 <p>Defined inside class </p>
 211 <div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keyword">variable</span> oo_var</div></div><!-- fragment -->
 212 </div>
 213 </div>
 214 <a id="af46293ede16067c38ca2901416cad8ee"></a>
 215 <h2 class="memtitle"><span class="permalink"><a href="#af46293ede16067c38ca2901416cad8ee">&sect;&nbsp;</a></span>oo_var_out</h2>
 216
 217 <div class="memitem">
 218 <div class="memproto">
 219 <table class="mlabels">
 220   <tr>
 221   <td class="mlabels-left">
 222       <table class="memname">
 223         <tr>
 224           <td class="memname">ns::oo_class::oo_var_out</td>
 225         </tr>
 226       </table>
 227   </td>
 228   <td class="mlabels-right">
 229 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 230   </tr>
 231 </table>
 232 </div><div class="memdoc">
 233
 234 <p>Outside defined variable <code>oo_var_out</code> . </p>
 235 <p>Inside <a class="el" href="classns_1_1oo__class.html" title="Documented oo class oo_class . ">oo_class</a> </p>
 236 <div class="fragment"><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <span class="keyword">variable</span> oo_var_out</div></div><!-- fragment -->
 237 </div>
 238 </div>
 239 <hr/>The documentation for this class was generated from the following file:<ul>
 240 <li><a class="el" href="tclexample_8tcl.html">tclexample.tcl</a></li>
 241 </ul>
 242 </div><!-- contents -->
 243 <!-- start footer part -->
 244 <hr class="footer"/><address class="footer"><small>
 245 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 246 <img class="footer" src="doxygen.png" alt="doxygen"/>
 247 </a> 1.8.12
 248 </small></address>
 249 </body>
 250 </html>