doc/api/python/build.ec.history.HistoryFileManager-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>build.ec.history.HistoryFileManager</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="build-module.html">Package&nbsp;build</a> ::
       
    38         <a href="build.ec-module.html">Package&nbsp;ec</a> ::
       
    39         <a href="build.ec.history-module.html">Module&nbsp;history</a> ::
       
    40         Class&nbsp;HistoryFileManager
       
    41       </span>
       
    42     </td>
       
    43     <td>
       
    44       <table cellpadding="0" cellspacing="0">
       
    45         <!-- hide/show private -->
       
    46         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    47     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    48         <tr><td align="right"><span class="options"
       
    49             >[<a href="frames.html" target="_top">frames</a
       
    50             >]&nbsp;|&nbsp;<a href="build.ec.history.HistoryFileManager-class.html"
       
    51             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    52       </table>
       
    53     </td>
       
    54   </tr>
       
    55 </table>
       
    56 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    57 <h1 class="epydoc">Class HistoryFileManager</h1><span class="codelink"><a href="build.ec.history-pysrc.html#HistoryFileManager">source&nbsp;code</a></span><br /><br />
       
    58 To manage EC history files.<br /><br />
       
    59 
       
    60 <!-- ==================== INSTANCE METHODS ==================== -->
       
    61 <a name="section-InstanceMethods"></a>
       
    62 <table class="summary" border="1" cellpadding="3"
       
    63        cellspacing="0" width="100%" bgcolor="white">
       
    64 <tr bgcolor="#70b0f0" class="table-header">
       
    65   <td colspan="2" class="table-header">
       
    66     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    67       <tr valign="top">
       
    68         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    69         <td align="right" valign="top"
       
    70          ><span class="options">[<a href="#section-InstanceMethods"
       
    71          class="privatelink" onclick="toggle_private();"
       
    72          >hide private</a>]</span></td>
       
    73       </tr>
       
    74     </table>
       
    75   </td>
       
    76 </tr>
       
    77 <tr>
       
    78     <td width="15%" align="right" valign="top" class="summary">
       
    79       <span class="summary-type">&nbsp;</span>
       
    80     </td><td class="summary">
       
    81       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    82         <tr>
       
    83           <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
       
    84         <span class="summary-sig-arg">arg1</span>,
       
    85         <span class="summary-sig-arg">arg2</span>,
       
    86         <span class="summary-sig-arg">arg3</span>)</span><br />
       
    87       Constructor.</td>
       
    88           <td align="right" valign="top">
       
    89             <span class="codelink"><a href="build.ec.history-pysrc.html#HistoryFileManager.__init__">source&nbsp;code</a></span>
       
    90             
       
    91           </td>
       
    92         </tr>
       
    93       </table>
       
    94       
       
    95     </td>
       
    96   </tr>
       
    97 <tr>
       
    98     <td width="15%" align="right" valign="top" class="summary">
       
    99       <span class="summary-type">&nbsp;</span>
       
   100     </td><td class="summary">
       
   101       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   102         <tr>
       
   103           <td><span class="summary-sig"><a href="build.ec.history.HistoryFileManager-class.html#findActualFilePath" class="summary-sig-name">findActualFilePath</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
   104       Find the new path where the history file will be updated based on the week number and branch.</td>
       
   105           <td align="right" valign="top">
       
   106             <span class="codelink"><a href="build.ec.history-pysrc.html#HistoryFileManager.findActualFilePath">source&nbsp;code</a></span>
       
   107             
       
   108           </td>
       
   109         </tr>
       
   110       </table>
       
   111       
       
   112     </td>
       
   113   </tr>
       
   114 <tr>
       
   115     <td width="15%" align="right" valign="top" class="summary">
       
   116       <span class="summary-type">&nbsp;</span>
       
   117     </td><td class="summary">
       
   118       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   119         <tr>
       
   120           <td><span class="summary-sig"><a name="findHistoryFilePath"></a><span class="summary-sig-name">findHistoryFilePath</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   121       Finds the path of the history file based on input
       
   122 branch and week number.</td>
       
   123           <td align="right" valign="top">
       
   124             <span class="codelink"><a href="build.ec.history-pysrc.html#HistoryFileManager.findHistoryFilePath">source&nbsp;code</a></span>
       
   125             
       
   126           </td>
       
   127         </tr>
       
   128       </table>
       
   129       
       
   130     </td>
       
   131   </tr>
       
   132 <tr>
       
   133     <td width="15%" align="right" valign="top" class="summary">
       
   134       <span class="summary-type">&nbsp;</span>
       
   135     </td><td class="summary">
       
   136       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   137         <tr>
       
   138           <td><span class="summary-sig"><a name="findFile"></a><span class="summary-sig-name">findFile</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   139       Finds the closest history file match to week number.</td>
       
   140           <td align="right" valign="top">
       
   141             <span class="codelink"><a href="build.ec.history-pysrc.html#HistoryFileManager.findFile">source&nbsp;code</a></span>
       
   142             
       
   143           </td>
       
   144         </tr>
       
   145       </table>
       
   146       
       
   147     </td>
       
   148   </tr>
       
   149 </table>
       
   150 <!-- ==================== CLASS VARIABLES ==================== -->
       
   151 <a name="section-ClassVariables"></a>
       
   152 <table class="summary" border="1" cellpadding="3"
       
   153        cellspacing="0" width="100%" bgcolor="white">
       
   154 <tr bgcolor="#70b0f0" class="table-header">
       
   155   <td colspan="2" class="table-header">
       
   156     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   157       <tr valign="top">
       
   158         <td align="left"><span class="table-header">Class Variables</span></td>
       
   159         <td align="right" valign="top"
       
   160          ><span class="options">[<a href="#section-ClassVariables"
       
   161          class="privatelink" onclick="toggle_private();"
       
   162          >hide private</a>]</span></td>
       
   163       </tr>
       
   164     </table>
       
   165   </td>
       
   166 </tr>
       
   167 <tr>
       
   168     <td width="15%" align="right" valign="top" class="summary">
       
   169       <span class="summary-type">&nbsp;</span>
       
   170     </td><td class="summary">
       
   171         <a name="weak_num"></a><span class="summary-name">weak_num</span> = <code title="&quot;&quot;">&quot;&quot;</code>
       
   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 name="branch_name"></a><span class="summary-name">branch_name</span> = <code title="&quot;&quot;">&quot;&quot;</code>
       
   179     </td>
       
   180   </tr>
       
   181 <tr>
       
   182     <td width="15%" align="right" valign="top" class="summary">
       
   183       <span class="summary-type">&nbsp;</span>
       
   184     </td><td class="summary">
       
   185         <a name="file_dict"></a><span class="summary-name">file_dict</span> = <code title="{}">{}</code>
       
   186     </td>
       
   187   </tr>
       
   188 </table>
       
   189 <!-- ==================== METHOD DETAILS ==================== -->
       
   190 <a name="section-MethodDetails"></a>
       
   191 <table class="details" border="1" cellpadding="3"
       
   192        cellspacing="0" width="100%" bgcolor="white">
       
   193 <tr bgcolor="#70b0f0" class="table-header">
       
   194   <td colspan="2" class="table-header">
       
   195     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   196       <tr valign="top">
       
   197         <td align="left"><span class="table-header">Method Details</span></td>
       
   198         <td align="right" valign="top"
       
   199          ><span class="options">[<a href="#section-MethodDetails"
       
   200          class="privatelink" onclick="toggle_private();"
       
   201          >hide private</a>]</span></td>
       
   202       </tr>
       
   203     </table>
       
   204   </td>
       
   205 </tr>
       
   206 </table>
       
   207 <a name="findActualFilePath"></a>
       
   208 <div>
       
   209 <table class="details" border="1" cellpadding="3"
       
   210        cellspacing="0" width="100%" bgcolor="white">
       
   211 <tr><td>
       
   212   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   213   <tr valign="top"><td>
       
   214   <h3 class="epydoc"><span class="sig"><span class="sig-name">findActualFilePath</span>(<span class="sig-arg">self</span>)</span>
       
   215   </h3>
       
   216   </td><td align="right" valign="top"
       
   217     ><span class="codelink"><a href="build.ec.history-pysrc.html#HistoryFileManager.findActualFilePath">source&nbsp;code</a></span>&nbsp;
       
   218     </td>
       
   219   </table>
       
   220   
       
   221   <p>Find the new path where the history file will be updated based on the week number and branch.</p>
       
   222 <p>This will normally the same path as used to copy from net drive to local drive.
       
   223 But for new branch / week number, the path will be different.</p>
       
   224   <dl class="fields">
       
   225   </dl>
       
   226 </td></tr></table>
       
   227 </div>
       
   228 <br />
       
   229 <!-- ==================== NAVIGATION BAR ==================== -->
       
   230 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   231        bgcolor="#a0c0ff" cellspacing="0">
       
   232   <tr valign="middle">
       
   233 
       
   234   <!-- Tree link -->
       
   235       <th>&nbsp;&nbsp;&nbsp;<a
       
   236         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   237 
       
   238   <!-- Index link -->
       
   239       <th>&nbsp;&nbsp;&nbsp;<a
       
   240         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   241 
       
   242   <!-- Help link -->
       
   243       <th>&nbsp;&nbsp;&nbsp;<a
       
   244         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   245 
       
   246       <th class="navbar" width="100%"></th>
       
   247   </tr>
       
   248 </table>
       
   249 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   250   <tr>
       
   251     <td align="left" class="footer">
       
   252     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   253     </td>
       
   254     <td align="right" class="footer">
       
   255       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   256     </td>
       
   257   </tr>
       
   258 </table>
       
   259 
       
   260 <script type="text/javascript">
       
   261   <!--
       
   262   // Private objects are initially displayed (because if
       
   263   // javascript is turned off then we want them to be
       
   264   // visible); but by default, we want to hide them.  So hide
       
   265   // them unless we have a cookie that says to show them.
       
   266   checkCookie()
       
   267   // -->
       
   268 </script>
       
   269   
       
   270 </body>
       
   271 </html>