add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / util / timefuncs.html
diff --git a/doc/sphinx/_build/html/_modules/nepi/util/timefuncs.html b/doc/sphinx/_build/html/_modules/nepi/util/timefuncs.html
new file mode 100644 (file)
index 0000000..398babe
--- /dev/null
@@ -0,0 +1,213 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>nepi.util.timefuncs &mdash; NEPI 3.0 documentation</title>
+    
+    <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
+    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
+    
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../../../',
+        VERSION:     '3.0',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="../../../_static/jquery.js"></script>
+    <script type="text/javascript" src="../../../_static/underscore.js"></script>
+    <script type="text/javascript" src="../../../_static/doctools.js"></script>
+    <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
+    <link rel="up" title="Module code" href="../../index.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+  <h3>Quick search</h3>
+    <form class="search" action="../../../search.html" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="Go" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+    <p class="searchtip" style="font-size: 90%">
+    Enter search terms or a module, class or function name.
+    </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  <h1>Source code for nepi.util.timefuncs</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c">#    NEPI, a framework to manage network experiments</span>
+<span class="c">#    Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c">#    This program is free software: you can redistribute it and/or modify</span>
+<span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
+<span class="c">#    published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c">#    This program is distributed in the hope that it will be useful,</span>
+<span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<span class="c">#    GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c">#    You should have received a copy of the GNU General Public License</span>
+<span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
+
+
+<span class="kn">import</span> <span class="nn">datetime</span>
+<span class="kn">import</span> <span class="nn">re</span>
+
+<span class="n">_strf</span> <span class="o">=</span> <span class="s">&quot;%Y%m</span><span class="si">%d</span><span class="s">%H%M%S</span><span class="si">%f</span><span class="s">&quot;</span>
+<span class="n">_reabs</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">&quot;^\d{20}$&quot;</span><span class="p">)</span>
+<span class="n">_rerel</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">&quot;^(?P&lt;time&gt;\d+(.\d+)?)(?P&lt;units&gt;h|m|s|ms|us)$&quot;</span><span class="p">)</span>
+
+<span class="c"># Work around to fix &quot;ImportError: Failed to import _strptime because the import lock is held by another thread.&quot;</span>
+<span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="s">&quot;20120807124732894211&quot;</span><span class="p">,</span> <span class="n">_strf</span><span class="p">)</span>
+
+<div class="viewcode-block" id="stformat"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.stformat">[docs]</a><span class="k">def</span> <span class="nf">stformat</span><span class="p">(</span><span class="n">sdate</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot; Constructs a datetime object from a string date with</span>
+<span class="sd">    format YYYYMMddHHMMSSffff </span>
+
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">sdate</span><span class="p">,</span> <span class="n">_strf</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="tsformat"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tsformat">[docs]</a><span class="k">def</span> <span class="nf">tsformat</span><span class="p">(</span><span class="n">date</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot; Formats a datetime object to a string with format YYYYMMddHHMMSSffff.</span>
+<span class="sd">    If no date is given, the current date is used.</span>
+<span class="sd">    </span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">date</span><span class="p">:</span>
+        <span class="n">date</span> <span class="o">=</span> <span class="n">tnow</span><span class="p">()</span>
+
+    <span class="k">return</span> <span class="n">date</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="n">_strf</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="tnow"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tnow">[docs]</a><span class="k">def</span> <span class="nf">tnow</span><span class="p">():</span>
+    <span class="sd">&quot;&quot;&quot; Returns datetime object with the current time &quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
+</div>
+<div class="viewcode-block" id="tdiff"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tdiff">[docs]</a><span class="k">def</span> <span class="nf">tdiff</span><span class="p">(</span><span class="n">date1</span><span class="p">,</span> <span class="n">date2</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot; Returns difference ( date1 - date2 ) as a datetime object,</span>
+<span class="sd">    where date1 and date 2 are datetime objects </span>
+<span class="sd">    </span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">return</span> <span class="n">date1</span> <span class="o">-</span> <span class="n">date2</span>
+</div>
+<span class="k">def</span> <span class="nf">_get_total_seconds</span><span class="p">(</span><span class="n">td</span><span class="p">):</span> 
+    <span class="k">return</span> <span class="p">(</span><span class="n">td</span><span class="o">.</span><span class="n">microseconds</span> <span class="o">+</span> <span class="p">(</span><span class="n">td</span><span class="o">.</span><span class="n">seconds</span> <span class="o">+</span> <span class="n">td</span><span class="o">.</span><span class="n">days</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">3600</span><span class="p">)</span> <span class="o">*</span> <span class="mf">1e6</span><span class="p">)</span> <span class="o">/</span> <span class="mf">1e6</span>
+
+<div class="viewcode-block" id="tdiffsec"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.tdiffsec">[docs]</a><span class="k">def</span> <span class="nf">tdiffsec</span><span class="p">(</span><span class="n">date1</span><span class="p">,</span> <span class="n">date2</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot; Returns the date difference ( date1 - date2 ) in seconds,</span>
+<span class="sd">    where date1 and date 2 are datetime objects </span>
+<span class="sd">    </span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">diff</span> <span class="o">=</span> <span class="n">tdiff</span><span class="p">(</span><span class="n">date1</span><span class="p">,</span> <span class="n">date2</span><span class="p">)</span>
+    <span class="k">return</span> <span class="n">_get_total_seconds</span><span class="p">(</span><span class="n">diff</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="stabsformat"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.stabsformat">[docs]</a><span class="k">def</span> <span class="nf">stabsformat</span><span class="p">(</span><span class="n">sdate</span><span class="p">,</span> <span class="n">dbase</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot; Constructs a datetime object from a string date.</span>
+<span class="sd">    The string date can be expressed as an absolute date</span>
+<span class="sd">    ( i.e. format YYYYMMddHHMMSSffff ) or as a relative time</span>
+<span class="sd">    ( e.g. format &#39;5m&#39; or &#39;10s&#39;). </span>
+<span class="sd">    If the date is a relative time and the dbase parameter </span>
+<span class="sd">    is given (dbase must be datetime object), the returned</span>
+<span class="sd">    date will be dbase + sdate. If dbase is None, </span>
+<span class="sd">    current time will be used instead as base time.</span>
+
+<span class="sd">    :param date : string date  </span>
+<span class="sd">    :type date : date </span>
+
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="c"># No date given, return current datetime</span>
+    <span class="k">if</span> <span class="ow">not</span> <span class="n">sdate</span><span class="p">:</span>
+        <span class="k">return</span> <span class="n">tnow</span><span class="p">()</span>
+
+    <span class="c"># Absolute date is given</span>
+    <span class="k">if</span> <span class="n">_reabs</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">sdate</span><span class="p">):</span>
+        <span class="k">return</span> <span class="n">stformat</span><span class="p">(</span><span class="n">sdate</span><span class="p">)</span>
+
+    <span class="c"># Relative time is given</span>
+    <span class="n">m</span> <span class="o">=</span> <span class="n">_rerel</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">sdate</span><span class="p">)</span>
+    <span class="k">if</span> <span class="n">m</span><span class="p">:</span>
+        <span class="n">time</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">m</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()[</span><span class="s">&#39;time&#39;</span><span class="p">])</span>
+        <span class="n">units</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()[</span><span class="s">&#39;units&#39;</span><span class="p">]</span>
+        <span class="k">if</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;h&#39;</span><span class="p">:</span>
+            <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span> <span class="o">=</span> <span class="n">time</span><span class="p">)</span> 
+        <span class="k">elif</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;m&#39;</span><span class="p">:</span>
+            <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span> <span class="o">=</span> <span class="n">time</span><span class="p">)</span> 
+        <span class="k">elif</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;s&#39;</span><span class="p">:</span>
+            <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">seconds</span> <span class="o">=</span> <span class="n">time</span><span class="p">)</span> 
+        <span class="k">elif</span> <span class="n">units</span> <span class="o">==</span> <span class="s">&#39;ms&#39;</span><span class="p">:</span>
+            <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">microseconds</span> <span class="o">=</span> <span class="p">(</span><span class="n">time</span><span class="o">*</span><span class="mi">1000</span><span class="p">))</span> 
+        <span class="k">else</span><span class="p">:</span>
+            <span class="n">delta</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">microseconds</span> <span class="o">=</span> <span class="n">time</span><span class="p">)</span>
+        
+        <span class="k">if</span> <span class="ow">not</span> <span class="n">dbase</span><span class="p">:</span>
+            <span class="n">dbase</span> <span class="o">=</span> <span class="n">tnow</span><span class="p">()</span>
+
+        <span class="k">return</span> <span class="n">dbase</span> <span class="o">+</span> <span class="n">delta</span>
+
+    <span class="k">return</span> <span class="bp">None</span>
+</div>
+<div class="viewcode-block" id="compute_delay_ms"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.timefuncs.compute_delay_ms">[docs]</a><span class="k">def</span> <span class="nf">compute_delay_ms</span><span class="p">(</span><span class="n">timestamp2</span><span class="p">,</span> <span class="n">timestamp1</span><span class="p">):</span>
+    <span class="n">d1</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">timestamp1</span><span class="p">))</span>
+    <span class="n">d2</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">timestamp2</span><span class="p">))</span>
+    <span class="n">delay</span> <span class="o">=</span> <span class="n">d2</span> <span class="o">-</span> <span class="n">d1</span>
+
+    <span class="c"># round up resolution - round up to miliseconds</span>
+    <span class="k">return</span> <span class="n">delay</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">()</span> <span class="o">*</span> <span class="mi">1000</span>
+</pre></div></div>
+
+          </div>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../../../genindex.html" title="General Index"
+             >index</a></li>
+        <li class="right" >
+          <a href="../../../py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
+          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+        &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+    </div>
+  </body>
+</html>
\ No newline at end of file