doc/api/python/ats3.aste.AsteTestPlan-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>ats3.aste.AsteTestPlan</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="ats3-module.html">Package&nbsp;ats3</a> ::
       
    38         <a href="ats3.aste-module.html">Module&nbsp;aste</a> ::
       
    39         Class&nbsp;AsteTestPlan
       
    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="ats3.aste.AsteTestPlan-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 AsteTestPlan</h1><span class="codelink"><a href="ats3.aste-pysrc.html#AsteTestPlan">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58 object --+
       
    59          |
       
    60         <strong class="uidshort">AsteTestPlan</strong>
       
    61 </pre>
       
    62 
       
    63 <hr />
       
    64 <p>Tells ASTE server what to test and how.</p>
       
    65 <p>The ASTE test plan from which the test.xml file can be written. The test
       
    66 plan requires TestAsset(s) to perform the tests</p><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="ats3.aste.AsteTestPlan-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    92         <span class="summary-sig-arg">config</span>)</span><br />
       
    93       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
       
    94           <td align="right" valign="top">
       
    95             <span class="codelink"><a href="ats3.aste-pysrc.html#AsteTestPlan.__init__">source&nbsp;code</a></span>
       
    96             
       
    97           </td>
       
    98         </tr>
       
    99       </table>
       
   100       
       
   101     </td>
       
   102   </tr>
       
   103 <tr>
       
   104     <td width="15%" align="right" valign="top" class="summary">
       
   105       <span class="summary-type">&nbsp;</span>
       
   106     </td><td class="summary">
       
   107       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   108         <tr>
       
   109           <td><span class="summary-sig"><a name="insert_set"></a><span class="summary-sig-name">insert_set</span>(<span class="summary-sig-arg">self</span>,
       
   110         <span class="summary-sig-arg">image_files</span>=<span class="summary-sig-default">None</span>,
       
   111         <span class="summary-sig-arg">test_timeout</span>=<span class="summary-sig-default">None</span>)</span><br />
       
   112       Insert a test set into the test plan.</td>
       
   113           <td align="right" valign="top">
       
   114             <span class="codelink"><a href="ats3.aste-pysrc.html#AsteTestPlan.insert_set">source&nbsp;code</a></span>
       
   115             
       
   116           </td>
       
   117         </tr>
       
   118       </table>
       
   119       
       
   120     </td>
       
   121   </tr>
       
   122 <tr>
       
   123     <td width="15%" align="right" valign="top" class="summary">
       
   124       <span class="summary-type">&nbsp;</span>
       
   125     </td><td class="summary">
       
   126       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   127         <tr>
       
   128           <td><span class="summary-sig"><a href="ats3.aste.AsteTestPlan-class.html#post_actions" class="summary-sig-name">post_actions</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
   129       ATS3 and ASTE post actions.</td>
       
   130           <td align="right" valign="top">
       
   131             <span class="codelink"><a href="ats3.aste-pysrc.html#AsteTestPlan.post_actions">source&nbsp;code</a></span>
       
   132             
       
   133           </td>
       
   134         </tr>
       
   135       </table>
       
   136       
       
   137     </td>
       
   138   </tr>
       
   139 <tr>
       
   140     <td width="15%" align="right" valign="top" class="summary">
       
   141       <span class="summary-type">&nbsp;</span>
       
   142     </td><td class="summary">
       
   143       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   144         <tr>
       
   145           <td><span class="summary-sig"><a name="__getitem__"></a><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-arg">self</span>,
       
   146         <span class="summary-sig-arg">key</span>)</span></td>
       
   147           <td align="right" valign="top">
       
   148             <span class="codelink"><a href="ats3.aste-pysrc.html#AsteTestPlan.__getitem__">source&nbsp;code</a></span>
       
   149             
       
   150           </td>
       
   151         </tr>
       
   152       </table>
       
   153       
       
   154     </td>
       
   155   </tr>
       
   156   <tr>
       
   157     <td colspan="2" class="summary">
       
   158     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   159       <code>__delattr__</code>,
       
   160       <code>__getattribute__</code>,
       
   161       <code>__hash__</code>,
       
   162       <code>__new__</code>,
       
   163       <code>__reduce__</code>,
       
   164       <code>__reduce_ex__</code>,
       
   165       <code>__repr__</code>,
       
   166       <code>__setattr__</code>,
       
   167       <code>__str__</code>
       
   168       </p>
       
   169     </td>
       
   170   </tr>
       
   171 </table>
       
   172 <!-- ==================== CLASS VARIABLES ==================== -->
       
   173 <a name="section-ClassVariables"></a>
       
   174 <table class="summary" border="1" cellpadding="3"
       
   175        cellspacing="0" width="100%" bgcolor="white">
       
   176 <tr bgcolor="#70b0f0" class="table-header">
       
   177   <td colspan="2" class="table-header">
       
   178     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   179       <tr valign="top">
       
   180         <td align="left"><span class="table-header">Class Variables</span></td>
       
   181         <td align="right" valign="top"
       
   182          ><span class="options">[<a href="#section-ClassVariables"
       
   183          class="privatelink" onclick="toggle_private();"
       
   184          >hide private</a>]</span></td>
       
   185       </tr>
       
   186     </table>
       
   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         <a href="ats3.aste.AsteTestPlan-class.html#EMAIL_SUBJECT" class="summary-name">EMAIL_SUBJECT</a> = <code title="u&quot;ATS3 report for &#167;RUN_NAME&#167; &#167;RUN_START_DATE&#167; &quot; u&quot;&#167;RUN_START_TIME&#167;&quot;">u&quot;ATS3 report for &#167;RUN_NAME&#167; &#167;RUN_START_DATE&#167; <code class="variable-ellipsis">...</code></code>
       
   194     </td>
       
   195   </tr>
       
   196 <tr>
       
   197     <td width="15%" align="right" valign="top" class="summary">
       
   198       <span class="summary-type">&nbsp;</span>
       
   199     </td><td class="summary">
       
   200         <a name="REPORT_PATH"></a><span class="summary-name">REPORT_PATH</span> = <code title="u&quot;&#167;RUN_NAME&#167;\&#167;RUN_START_DATE&#167;_&#167;RUN_START_TIME&#167;&quot;">u&quot;&#167;RUN_NAME&#167;\&#167;RUN_START_DATE&#167;_&#167;RUN_START_TIME&#167;&quot;</code>
       
   201     </td>
       
   202   </tr>
       
   203 </table>
       
   204 <!-- ==================== PROPERTIES ==================== -->
       
   205 <a name="section-Properties"></a>
       
   206 <table class="summary" border="1" cellpadding="3"
       
   207        cellspacing="0" width="100%" bgcolor="white">
       
   208 <tr bgcolor="#70b0f0" class="table-header">
       
   209   <td colspan="2" class="table-header">
       
   210     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   211       <tr valign="top">
       
   212         <td align="left"><span class="table-header">Properties</span></td>
       
   213         <td align="right" valign="top"
       
   214          ><span class="options">[<a href="#section-Properties"
       
   215          class="privatelink" onclick="toggle_private();"
       
   216          >hide private</a>]</span></td>
       
   217       </tr>
       
   218     </table>
       
   219   </td>
       
   220 </tr>
       
   221   <tr>
       
   222     <td colspan="2" class="summary">
       
   223     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   224       <code>__class__</code>
       
   225       </p>
       
   226     </td>
       
   227   </tr>
       
   228 </table>
       
   229 <!-- ==================== METHOD DETAILS ==================== -->
       
   230 <a name="section-MethodDetails"></a>
       
   231 <table class="details" border="1" cellpadding="3"
       
   232        cellspacing="0" width="100%" bgcolor="white">
       
   233 <tr bgcolor="#70b0f0" class="table-header">
       
   234   <td colspan="2" class="table-header">
       
   235     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   236       <tr valign="top">
       
   237         <td align="left"><span class="table-header">Method Details</span></td>
       
   238         <td align="right" valign="top"
       
   239          ><span class="options">[<a href="#section-MethodDetails"
       
   240          class="privatelink" onclick="toggle_private();"
       
   241          >hide private</a>]</span></td>
       
   242       </tr>
       
   243     </table>
       
   244   </td>
       
   245 </tr>
       
   246 </table>
       
   247 <a name="__init__"></a>
       
   248 <div>
       
   249 <table class="details" border="1" cellpadding="3"
       
   250        cellspacing="0" width="100%" bgcolor="white">
       
   251 <tr><td>
       
   252   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   253   <tr valign="top"><td>
       
   254   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   255         <span class="sig-arg">config</span>)</span>
       
   256     <br /><em class="fname">(Constructor)</em>
       
   257   </h3>
       
   258   </td><td align="right" valign="top"
       
   259     ><span class="codelink"><a href="ats3.aste-pysrc.html#AsteTestPlan.__init__">source&nbsp;code</a></span>&nbsp;
       
   260     </td>
       
   261   </table>
       
   262   
       
   263   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
       
   264   <dl class="fields">
       
   265     <dt>Overrides:
       
   266       object.__init__
       
   267         <dd><em class="note">(inherited documentation)</em></dd>
       
   268     </dt>
       
   269   </dl>
       
   270 </td></tr></table>
       
   271 </div>
       
   272 <a name="post_actions"></a>
       
   273 <div>
       
   274 <table class="details" border="1" cellpadding="3"
       
   275        cellspacing="0" width="100%" bgcolor="white">
       
   276 <tr><td>
       
   277   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   278   <tr valign="top"><td>
       
   279   <h3 class="epydoc"><span class="sig"><span class="sig-name">post_actions</span>(<span class="sig-arg">self</span>)</span>
       
   280   </h3>
       
   281   </td><td align="right" valign="top"
       
   282     ><span class="codelink"><a href="ats3.aste-pysrc.html#AsteTestPlan.post_actions">source&nbsp;code</a></span>&nbsp;
       
   283     </td>
       
   284   </table>
       
   285   
       
   286   ATS3 and ASTE post actions.
       
   287   <dl class="fields">
       
   288     <dt>Decorators:</dt>
       
   289     <dd><ul class="nomargin-top">
       
   290         <li><code>@property</code></li>
       
   291     </ul></dd>
       
   292   </dl>
       
   293 </td></tr></table>
       
   294 </div>
       
   295 <br />
       
   296 <!-- ==================== CLASS VARIABLE DETAILS ==================== -->
       
   297 <a name="section-ClassVariableDetails"></a>
       
   298 <table class="details" border="1" cellpadding="3"
       
   299        cellspacing="0" width="100%" bgcolor="white">
       
   300 <tr bgcolor="#70b0f0" class="table-header">
       
   301   <td colspan="2" class="table-header">
       
   302     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   303       <tr valign="top">
       
   304         <td align="left"><span class="table-header">Class Variable Details</span></td>
       
   305         <td align="right" valign="top"
       
   306          ><span class="options">[<a href="#section-ClassVariableDetails"
       
   307          class="privatelink" onclick="toggle_private();"
       
   308          >hide private</a>]</span></td>
       
   309       </tr>
       
   310     </table>
       
   311   </td>
       
   312 </tr>
       
   313 </table>
       
   314 <a name="EMAIL_SUBJECT"></a>
       
   315 <div>
       
   316 <table class="details" border="1" cellpadding="3"
       
   317        cellspacing="0" width="100%" bgcolor="white">
       
   318 <tr><td>
       
   319   <h3 class="epydoc">EMAIL_SUBJECT</h3>
       
   320   
       
   321   <dl class="fields">
       
   322   </dl>
       
   323   <dl class="fields">
       
   324     <dt>Value:</dt>
       
   325       <dd><table><tr><td><pre class="variable">
       
   326 u&quot;ATS3 report for &#167;RUN_NAME&#167; &#167;RUN_START_DATE&#167; &quot; u&quot;&#167;RUN_START_TIME&#167;&quot;
       
   327 </pre></td></tr></table>
       
   328 </dd>
       
   329   </dl>
       
   330 </td></tr></table>
       
   331 </div>
       
   332 <br />
       
   333 <!-- ==================== NAVIGATION BAR ==================== -->
       
   334 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   335        bgcolor="#a0c0ff" cellspacing="0">
       
   336   <tr valign="middle">
       
   337 
       
   338   <!-- Tree link -->
       
   339       <th>&nbsp;&nbsp;&nbsp;<a
       
   340         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   341 
       
   342   <!-- Index link -->
       
   343       <th>&nbsp;&nbsp;&nbsp;<a
       
   344         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   345 
       
   346   <!-- Help link -->
       
   347       <th>&nbsp;&nbsp;&nbsp;<a
       
   348         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   349 
       
   350       <th class="navbar" width="100%"></th>
       
   351   </tr>
       
   352 </table>
       
   353 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   354   <tr>
       
   355     <td align="left" class="footer">
       
   356     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   357     </td>
       
   358     <td align="right" class="footer">
       
   359       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   360     </td>
       
   361   </tr>
       
   362 </table>
       
   363 
       
   364 <script type="text/javascript">
       
   365   <!--
       
   366   // Private objects are initially displayed (because if
       
   367   // javascript is turned off then we want them to be
       
   368   // visible); but by default, we want to hide them.  So hide
       
   369   // them unless we have a cookie that says to show them.
       
   370   checkCookie()
       
   371   // -->
       
   372 </script>
       
   373   
       
   374 </body>
       
   375 </html>