doc/api/python/sysdef.api.Option-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>sysdef.api.Option</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="sysdef-module.html">Package&nbsp;sysdef</a> ::
       
    38         <a href="sysdef.api-module.html">Module&nbsp;api</a> ::
       
    39         Class&nbsp;Option
       
    40       </span>
       
    41     </td>
       
    42     <td>
       
    43       <table cellpadding="0" cellspacing="0">
       
    44         <!-- hide/show private -->
       
    45         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    46     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    47         <tr><td align="right"><span class="options"
       
    48             >[<a href="frames.html" target="_top">frames</a
       
    49             >]&nbsp;|&nbsp;<a href="sysdef.api.Option-class.html"
       
    50             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    51       </table>
       
    52     </td>
       
    53   </tr>
       
    54 </table>
       
    55 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    56 <h1 class="epydoc">Class Option</h1><span class="codelink"><a href="sysdef.api-pysrc.html#Option">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58    object --+    
       
    59             |    
       
    60 <a href="sysdef.api.SysDefElement-class.html">SysDefElement</a> --+
       
    61                 |
       
    62                <strong class="uidshort">Option</strong>
       
    63 </pre>
       
    64 
       
    65 <hr />
       
    66 Represents an option used in abld calls.<br /><br />
       
    67 
       
    68 <!-- ==================== INSTANCE METHODS ==================== -->
       
    69 <a name="section-InstanceMethods"></a>
       
    70 <table class="summary" border="1" cellpadding="3"
       
    71        cellspacing="0" width="100%" bgcolor="white">
       
    72 <tr bgcolor="#70b0f0" class="table-header">
       
    73   <td colspan="2" class="table-header">
       
    74     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    75       <tr valign="top">
       
    76         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    77         <td align="right" valign="top"
       
    78          ><span class="options">[<a href="#section-InstanceMethods"
       
    79          class="privatelink" onclick="toggle_private();"
       
    80          >hide private</a>]</span></td>
       
    81       </tr>
       
    82     </table>
       
    83   </td>
       
    84 </tr>
       
    85 <tr>
       
    86     <td width="15%" align="right" valign="top" class="summary">
       
    87       <span class="summary-type">&nbsp;</span>
       
    88     </td><td class="summary">
       
    89       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    90         <tr>
       
    91           <td><span class="summary-sig"><a href="sysdef.api.Option-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    92         <span class="summary-sig-arg">node</span>,
       
    93         <span class="summary-sig-arg">sysDef</span>)</span><br />
       
    94       Initialisation</td>
       
    95           <td align="right" valign="top">
       
    96             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.__init__">source&nbsp;code</a></span>
       
    97             
       
    98           </td>
       
    99         </tr>
       
   100       </table>
       
   101       
       
   102     </td>
       
   103   </tr>
       
   104 <tr class="private">
       
   105     <td width="15%" align="right" valign="top" class="summary">
       
   106       <span class="summary-type">&nbsp;</span>
       
   107     </td><td class="summary">
       
   108       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   109         <tr>
       
   110           <td><span class="summary-sig"><a name="__getname"></a><span class="summary-sig-name">__getname</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   111       Name getter method.</td>
       
   112           <td align="right" valign="top">
       
   113             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.__getname">source&nbsp;code</a></span>
       
   114             
       
   115           </td>
       
   116         </tr>
       
   117       </table>
       
   118       
       
   119     </td>
       
   120   </tr>
       
   121 <tr class="private">
       
   122     <td width="15%" align="right" valign="top" class="summary">
       
   123       <span class="summary-type">&nbsp;</span>
       
   124     </td><td class="summary">
       
   125       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   126         <tr>
       
   127           <td><span class="summary-sig"><a name="__getabldOption"></a><span class="summary-sig-name">__getabldOption</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   128       Abld option getter method.</td>
       
   129           <td align="right" valign="top">
       
   130             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.__getabldOption">source&nbsp;code</a></span>
       
   131             
       
   132           </td>
       
   133         </tr>
       
   134       </table>
       
   135       
       
   136     </td>
       
   137   </tr>
       
   138 <tr class="private">
       
   139     <td width="15%" align="right" valign="top" class="summary">
       
   140       <span class="summary-type">&nbsp;</span>
       
   141     </td><td class="summary">
       
   142       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   143         <tr>
       
   144           <td><span class="summary-sig"><a name="__getenable"></a><span class="summary-sig-name">__getenable</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   145       Unit Parallel getter method (boolean).</td>
       
   146           <td align="right" valign="top">
       
   147             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.__getenable">source&nbsp;code</a></span>
       
   148             
       
   149           </td>
       
   150         </tr>
       
   151       </table>
       
   152       
       
   153     </td>
       
   154   </tr>
       
   155 <tr class="private">
       
   156     <td width="15%" align="right" valign="top" class="summary">
       
   157       <span class="summary-type">&nbsp;</span>
       
   158     </td><td class="summary">
       
   159       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   160         <tr>
       
   161           <td><span class="summary-sig"><a name="__getfilteredOption"></a><span class="summary-sig-name">__getfilteredOption</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   162       Filtered abld option getter method.</td>
       
   163           <td align="right" valign="top">
       
   164             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.__getfilteredOption">source&nbsp;code</a></span>
       
   165             
       
   166           </td>
       
   167         </tr>
       
   168       </table>
       
   169       
       
   170     </td>
       
   171   </tr>
       
   172 <tr>
       
   173     <td width="15%" align="right" valign="top" class="summary">
       
   174       <span class="summary-type">&nbsp;</span>
       
   175     </td><td class="summary">
       
   176       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   177         <tr>
       
   178           <td><span class="summary-sig"><a name="name"></a><span class="summary-sig-name">name</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   179       Name getter method.</td>
       
   180           <td align="right" valign="top">
       
   181             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.name">source&nbsp;code</a></span>
       
   182             
       
   183           </td>
       
   184         </tr>
       
   185       </table>
       
   186       
       
   187     </td>
       
   188   </tr>
       
   189 <tr>
       
   190     <td width="15%" align="right" valign="top" class="summary">
       
   191       <span class="summary-type">&nbsp;</span>
       
   192     </td><td class="summary">
       
   193       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   194         <tr>
       
   195           <td><span class="summary-sig"><a name="abldOption"></a><span class="summary-sig-name">abldOption</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   196       Abld option getter method.</td>
       
   197           <td align="right" valign="top">
       
   198             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.abldOption">source&nbsp;code</a></span>
       
   199             
       
   200           </td>
       
   201         </tr>
       
   202       </table>
       
   203       
       
   204     </td>
       
   205   </tr>
       
   206 <tr>
       
   207     <td width="15%" align="right" valign="top" class="summary">
       
   208       <span class="summary-type">&nbsp;</span>
       
   209     </td><td class="summary">
       
   210       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   211         <tr>
       
   212           <td><span class="summary-sig"><a name="enable"></a><span class="summary-sig-name">enable</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   213       Unit Parallel getter method (boolean).</td>
       
   214           <td align="right" valign="top">
       
   215             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.enable">source&nbsp;code</a></span>
       
   216             
       
   217           </td>
       
   218         </tr>
       
   219       </table>
       
   220       
       
   221     </td>
       
   222   </tr>
       
   223 <tr>
       
   224     <td width="15%" align="right" valign="top" class="summary">
       
   225       <span class="summary-type">&nbsp;</span>
       
   226     </td><td class="summary">
       
   227       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   228         <tr>
       
   229           <td><span class="summary-sig"><a name="filteredOption"></a><span class="summary-sig-name">filteredOption</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   230       Filtered abld option getter method.</td>
       
   231           <td align="right" valign="top">
       
   232             <span class="codelink"><a href="sysdef.api-pysrc.html#Option.filteredOption">source&nbsp;code</a></span>
       
   233             
       
   234           </td>
       
   235         </tr>
       
   236       </table>
       
   237       
       
   238     </td>
       
   239   </tr>
       
   240   <tr>
       
   241     <td colspan="2" class="summary">
       
   242     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="sysdef.api.SysDefElement-class.html">SysDefElement</a></code></b>:
       
   243       <code><a href="sysdef.api.SysDefElement-class.html#__str__">__str__</a></code>,
       
   244       <code><a href="sysdef.api.SysDefElement-class.html#get_id">get_id</a></code>
       
   245       </p>
       
   246     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="sysdef.api.SysDefElement-class.html">SysDefElement</a></code></b> (private):
       
   247       <code><a href="sysdef.api.SysDefElement-class.html#_getname">_getname</a></code>
       
   248       </p></div>
       
   249     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   250       <code>__delattr__</code>,
       
   251       <code>__getattribute__</code>,
       
   252       <code>__hash__</code>,
       
   253       <code>__new__</code>,
       
   254       <code>__reduce__</code>,
       
   255       <code>__reduce_ex__</code>,
       
   256       <code>__repr__</code>,
       
   257       <code>__setattr__</code>
       
   258       </p>
       
   259     </td>
       
   260   </tr>
       
   261 </table>
       
   262 <!-- ==================== PROPERTIES ==================== -->
       
   263 <a name="section-Properties"></a>
       
   264 <table class="summary" border="1" cellpadding="3"
       
   265        cellspacing="0" width="100%" bgcolor="white">
       
   266 <tr bgcolor="#70b0f0" class="table-header">
       
   267   <td colspan="2" class="table-header">
       
   268     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   269       <tr valign="top">
       
   270         <td align="left"><span class="table-header">Properties</span></td>
       
   271         <td align="right" valign="top"
       
   272          ><span class="options">[<a href="#section-Properties"
       
   273          class="privatelink" onclick="toggle_private();"
       
   274          >hide private</a>]</span></td>
       
   275       </tr>
       
   276     </table>
       
   277   </td>
       
   278 </tr>
       
   279   <tr>
       
   280     <td colspan="2" class="summary">
       
   281     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   282       <code>__class__</code>
       
   283       </p>
       
   284     </td>
       
   285   </tr>
       
   286 </table>
       
   287 <!-- ==================== METHOD DETAILS ==================== -->
       
   288 <a name="section-MethodDetails"></a>
       
   289 <table class="details" border="1" cellpadding="3"
       
   290        cellspacing="0" width="100%" bgcolor="white">
       
   291 <tr bgcolor="#70b0f0" class="table-header">
       
   292   <td colspan="2" class="table-header">
       
   293     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   294       <tr valign="top">
       
   295         <td align="left"><span class="table-header">Method Details</span></td>
       
   296         <td align="right" valign="top"
       
   297          ><span class="options">[<a href="#section-MethodDetails"
       
   298          class="privatelink" onclick="toggle_private();"
       
   299          >hide private</a>]</span></td>
       
   300       </tr>
       
   301     </table>
       
   302   </td>
       
   303 </tr>
       
   304 </table>
       
   305 <a name="__init__"></a>
       
   306 <div>
       
   307 <table class="details" border="1" cellpadding="3"
       
   308        cellspacing="0" width="100%" bgcolor="white">
       
   309 <tr><td>
       
   310   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   311   <tr valign="top"><td>
       
   312   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   313         <span class="sig-arg">node</span>,
       
   314         <span class="sig-arg">sysDef</span>)</span>
       
   315     <br /><em class="fname">(Constructor)</em>
       
   316   </h3>
       
   317   </td><td align="right" valign="top"
       
   318     ><span class="codelink"><a href="sysdef.api-pysrc.html#Option.__init__">source&nbsp;code</a></span>&nbsp;
       
   319     </td>
       
   320   </table>
       
   321   
       
   322   Initialisation
       
   323   <dl class="fields">
       
   324     <dt>Overrides:
       
   325       <a href="sysdef.api.SysDefElement-class.html#__init__">SysDefElement.__init__</a>
       
   326     </dt>
       
   327   </dl>
       
   328 </td></tr></table>
       
   329 </div>
       
   330 <br />
       
   331 <!-- ==================== NAVIGATION BAR ==================== -->
       
   332 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   333        bgcolor="#a0c0ff" cellspacing="0">
       
   334   <tr valign="middle">
       
   335 
       
   336   <!-- Tree link -->
       
   337       <th>&nbsp;&nbsp;&nbsp;<a
       
   338         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   339 
       
   340   <!-- Index link -->
       
   341       <th>&nbsp;&nbsp;&nbsp;<a
       
   342         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   343 
       
   344   <!-- Help link -->
       
   345       <th>&nbsp;&nbsp;&nbsp;<a
       
   346         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   347 
       
   348       <th class="navbar" width="100%"></th>
       
   349   </tr>
       
   350 </table>
       
   351 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   352   <tr>
       
   353     <td align="left" class="footer">
       
   354     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009
       
   355     </td>
       
   356     <td align="right" class="footer">
       
   357       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   358     </td>
       
   359   </tr>
       
   360 </table>
       
   361 
       
   362 <script type="text/javascript">
       
   363   <!--
       
   364   // Private objects are initially displayed (because if
       
   365   // javascript is turned off then we want them to be
       
   366   // visible); but by default, we want to hide them.  So hide
       
   367   // them unless we have a cookie that says to show them.
       
   368   checkCookie()
       
   369   // -->
       
   370 </script>
       
   371   
       
   372 </body>
       
   373 </html>