doc/api/python/ido-module.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>ido</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         Module&nbsp;ido
       
    38       </span>
       
    39     </td>
       
    40     <td>
       
    41       <table cellpadding="0" cellspacing="0">
       
    42         <!-- hide/show private -->
       
    43         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    44     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    45         <tr><td align="right"><span class="options"
       
    46             >[<a href="frames.html" target="_top">frames</a
       
    47             >]&nbsp;|&nbsp;<a href="ido-module.html"
       
    48             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    49       </table>
       
    50     </td>
       
    51   </tr>
       
    52 </table>
       
    53 <!-- ==================== MODULE DESCRIPTION ==================== -->
       
    54 <h1 class="epydoc">Module ido</h1><span class="codelink"><a href="ido-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    55 <dl class="rst-docutils">
       
    56 <dt>IDO specific features</dt>
       
    57 <dd><ul class="rst-first rst-last rst-simple">
       
    58 <li>find layer_real_source_path from sysdef file.</li>
       
    59 <li>time manipulation for robot releasing.</li>
       
    60 </ul>
       
    61 </dd>
       
    62 </dl><br /><br />
       
    63 
       
    64 <!-- ==================== FUNCTIONS ==================== -->
       
    65 <a name="section-Functions"></a>
       
    66 <table class="summary" border="1" cellpadding="3"
       
    67        cellspacing="0" width="100%" bgcolor="white">
       
    68 <tr bgcolor="#70b0f0" class="table-header">
       
    69   <td colspan="2" class="table-header">
       
    70     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    71       <tr valign="top">
       
    72         <td align="left"><span class="table-header">Functions</span></td>
       
    73         <td align="right" valign="top"
       
    74          ><span class="options">[<a href="#section-Functions"
       
    75          class="privatelink" onclick="toggle_private();"
       
    76          >hide private</a>]</span></td>
       
    77       </tr>
       
    78     </table>
       
    79   </td>
       
    80 </tr>
       
    81 <tr>
       
    82     <td width="15%" align="right" valign="top" class="summary">
       
    83       <span class="summary-type">&nbsp;</span>
       
    84     </td><td class="summary">
       
    85       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    86         <tr>
       
    87           <td><span class="summary-sig"><a name="get_sysdef_location"></a><span class="summary-sig-name">get_sysdef_location</span>(<span class="summary-sig-arg">sysdef</span>)</span><br />
       
    88       Search for layer_real_source_path entity inside the sysdef file.</td>
       
    89           <td align="right" valign="top">
       
    90             <span class="codelink"><a href="ido-pysrc.html#get_sysdef_location">source&nbsp;code</a></span>
       
    91             
       
    92           </td>
       
    93         </tr>
       
    94       </table>
       
    95       
       
    96     </td>
       
    97   </tr>
       
    98 <tr>
       
    99     <td width="15%" align="right" valign="top" class="summary">
       
   100       <span class="summary-type">&nbsp;</span>
       
   101     </td><td class="summary">
       
   102       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   103         <tr>
       
   104           <td><span class="summary-sig"><a name="get_first_day_of_cycle"></a><span class="summary-sig-name">get_first_day_of_cycle</span>(<span class="summary-sig-arg">now</span>=<span class="summary-sig-default">datetime.datetime.now()</span>)</span><br />
       
   105       This function returns a datetime object representing the monday from closest
       
   106 even week.</td>
       
   107           <td align="right" valign="top">
       
   108             <span class="codelink"><a href="ido-pysrc.html#get_first_day_of_cycle">source&nbsp;code</a></span>
       
   109             
       
   110           </td>
       
   111         </tr>
       
   112       </table>
       
   113       
       
   114     </td>
       
   115   </tr>
       
   116 <tr>
       
   117     <td width="15%" align="right" valign="top" class="summary">
       
   118       <span class="summary-type">&nbsp;</span>
       
   119     </td><td class="summary">
       
   120       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   121         <tr>
       
   122           <td><span class="summary-sig"><a name="get_absolute_date"></a><span class="summary-sig-name">get_absolute_date</span>(<span class="summary-sig-arg">day</span>,
       
   123         <span class="summary-sig-arg">time</span>,
       
   124         <span class="summary-sig-arg">now</span>=<span class="summary-sig-default">datetime.datetime.now()</span>)</span><br />
       
   125       Get the absolute date from the day and time.</td>
       
   126           <td align="right" valign="top">
       
   127             <span class="codelink"><a href="ido-pysrc.html#get_absolute_date">source&nbsp;code</a></span>
       
   128             
       
   129           </td>
       
   130         </tr>
       
   131       </table>
       
   132       
       
   133     </td>
       
   134   </tr>
       
   135 <tr>
       
   136     <td width="15%" align="right" valign="top" class="summary">
       
   137       <span class="summary-type">&nbsp;</span>
       
   138     </td><td class="summary">
       
   139       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   140         <tr>
       
   141           <td><span class="summary-sig"><a name="is_in_interval"></a><span class="summary-sig-name">is_in_interval</span>(<span class="summary-sig-arg">day1</span>,
       
   142         <span class="summary-sig-arg">time1</span>,
       
   143         <span class="summary-sig-arg">day2</span>,
       
   144         <span class="summary-sig-arg">time2</span>,
       
   145         <span class="summary-sig-arg">now</span>=<span class="summary-sig-default">datetime.datetime.now()</span>)</span><br />
       
   146       Return True is get_absolute_date(day1, time1) &lt; now &lt; get_absolute_date(day2, time2).</td>
       
   147           <td align="right" valign="top">
       
   148             <span class="codelink"><a href="ido-pysrc.html#is_in_interval">source&nbsp;code</a></span>
       
   149             
       
   150           </td>
       
   151         </tr>
       
   152       </table>
       
   153       
       
   154     </td>
       
   155   </tr>
       
   156 </table>
       
   157 <!-- ==================== VARIABLES ==================== -->
       
   158 <a name="section-Variables"></a>
       
   159 <table class="summary" border="1" cellpadding="3"
       
   160        cellspacing="0" width="100%" bgcolor="white">
       
   161 <tr bgcolor="#70b0f0" class="table-header">
       
   162   <td colspan="2" class="table-header">
       
   163     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   164       <tr valign="top">
       
   165         <td align="left"><span class="table-header">Variables</span></td>
       
   166         <td align="right" valign="top"
       
   167          ><span class="options">[<a href="#section-Variables"
       
   168          class="privatelink" onclick="toggle_private();"
       
   169          >hide private</a>]</span></td>
       
   170       </tr>
       
   171     </table>
       
   172   </td>
       
   173 </tr>
       
   174 <tr>
       
   175     <td width="15%" align="right" valign="top" class="summary">
       
   176       <span class="summary-type">&nbsp;</span>
       
   177     </td><td class="summary">
       
   178         <a href="ido-module.html#MATCH_ENTITY" class="summary-name">MATCH_ENTITY</a> = <code title="re.compile(r&quot;.*ENTITY\s+layer_real_source_path\s+\&quot;(.+)\&quot;\s*&gt;?.*&quot;)">re.compile(r&quot;.*ENTITY\s+layer_real_source_path\<code class="variable-ellipsis">...</code></code>
       
   179     </td>
       
   180   </tr>
       
   181 </table>
       
   182 <!-- ==================== VARIABLES DETAILS ==================== -->
       
   183 <a name="section-VariablesDetails"></a>
       
   184 <table class="details" border="1" cellpadding="3"
       
   185        cellspacing="0" width="100%" bgcolor="white">
       
   186 <tr bgcolor="#70b0f0" class="table-header">
       
   187   <td colspan="2" class="table-header">
       
   188     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   189       <tr valign="top">
       
   190         <td align="left"><span class="table-header">Variables Details</span></td>
       
   191         <td align="right" valign="top"
       
   192          ><span class="options">[<a href="#section-VariablesDetails"
       
   193          class="privatelink" onclick="toggle_private();"
       
   194          >hide private</a>]</span></td>
       
   195       </tr>
       
   196     </table>
       
   197   </td>
       
   198 </tr>
       
   199 </table>
       
   200 <a name="MATCH_ENTITY"></a>
       
   201 <div>
       
   202 <table class="details" border="1" cellpadding="3"
       
   203        cellspacing="0" width="100%" bgcolor="white">
       
   204 <tr><td>
       
   205   <h3 class="epydoc">MATCH_ENTITY</h3>
       
   206   
       
   207   <dl class="fields">
       
   208   </dl>
       
   209   <dl class="fields">
       
   210     <dt>Value:</dt>
       
   211       <dd><table><tr><td><pre class="variable">
       
   212 re.compile(r&quot;.*ENTITY\s+layer_real_source_path\s+\&quot;(.+)\&quot;\s*&gt;?.*&quot;)
       
   213 </pre></td></tr></table>
       
   214 </dd>
       
   215   </dl>
       
   216 </td></tr></table>
       
   217 </div>
       
   218 <br />
       
   219 <!-- ==================== NAVIGATION BAR ==================== -->
       
   220 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   221        bgcolor="#a0c0ff" cellspacing="0">
       
   222   <tr valign="middle">
       
   223 
       
   224   <!-- Tree link -->
       
   225       <th>&nbsp;&nbsp;&nbsp;<a
       
   226         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   227 
       
   228   <!-- Index link -->
       
   229       <th>&nbsp;&nbsp;&nbsp;<a
       
   230         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   231 
       
   232   <!-- Help link -->
       
   233       <th>&nbsp;&nbsp;&nbsp;<a
       
   234         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   235 
       
   236       <th class="navbar" width="100%"></th>
       
   237   </tr>
       
   238 </table>
       
   239 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   240   <tr>
       
   241     <td align="left" class="footer">
       
   242     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
       
   243     </td>
       
   244     <td align="right" class="footer">
       
   245       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   246     </td>
       
   247   </tr>
       
   248 </table>
       
   249 
       
   250 <script type="text/javascript">
       
   251   <!--
       
   252   // Private objects are initially displayed (because if
       
   253   // javascript is turned off then we want them to be
       
   254   // visible); but by default, we want to hide them.  So hide
       
   255   // them unless we have a cookie that says to show them.
       
   256   checkCookie()
       
   257   // -->
       
   258 </script>
       
   259   
       
   260 </body>
       
   261 </html>