python-awips/_modules/awips/TimeUtil.html
2022-01-05 21:21:19 +00:00

191 lines
No EOL
15 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>awips.TimeUtil &mdash; python-awips documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="../../about.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> python-awips
</a>
<div class="version">
18.1.8
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../api/index.html">API Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../datatypes.html">Available Data Types</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../examples/index.html">Data Plotting Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev.html">Development Guide</a></li>
<li class="toctree-l1"><a class="reference external" href="http://unidata.github.io/awips2/appendix/appendix-grid-parameters/">AWIPS Grid Parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../about.html">About Unidata AWIPS</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">python-awips</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../index.html">Module code</a> &raquo;</li>
<li>awips.TimeUtil</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for awips.TimeUtil</h1><div class="highlight"><pre>
<span></span><span class="c1"># ----------------------------------------------------------------------------</span>
<span class="c1"># This software is in the public domain, furnished &quot;as is&quot;, without technical</span>
<span class="c1"># support, and with no warranty, express or implied, as to its usefulness for</span>
<span class="c1"># any purpose.</span>
<span class="c1">#</span>
<span class="c1"># offsetTime.py</span>
<span class="c1"># Handles Displaced Real Time for various applications</span>
<span class="c1">#</span>
<span class="c1"># Author: hansen/romberg</span>
<span class="c1"># ----------------------------------------------------------------------------</span>
<span class="kn">import</span> <span class="nn">string</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="c1"># Given the timeStr, return the offset (in seconds)</span>
<span class="c1"># from the current time.</span>
<span class="c1"># Also return the launchStr i.e. Programs launched from this</span>
<span class="c1"># offset application will use the launchStr as the -z argument.</span>
<span class="c1"># The offset will be positive for time in the future,</span>
<span class="c1"># negative for time in the past.</span>
<span class="c1">#</span>
<span class="c1"># May still want it to be normalized to the most recent midnight.</span>
<span class="c1">#</span>
<span class="c1"># NOTES about synchronizing:</span>
<span class="c1"># --With synchronizing on, the &quot;current time&quot; for all processes started</span>
<span class="c1"># within a given hour will be the same.</span>
<span class="c1"># This guarantees that GFE&#39;s have the same current time and ISC grid</span>
<span class="c1"># time stamps are syncrhonized and can be exchanged.</span>
<span class="c1"># Formatters launched from the GFE in this mode will be synchronized as</span>
<span class="c1"># well by setting the launchStr to use the time difference format</span>
<span class="c1"># (YYYYMMDD_HHMM,YYYYMMDD_HHMM).</span>
<span class="c1"># --This does not solve the problem in the general case.</span>
<span class="c1"># For example, if someone starts the GFE at 12:59 and someone</span>
<span class="c1"># else starts it at 1:01, they will have different offsets and</span>
<span class="c1"># current times.</span>
<span class="c1"># --With synchronizing off, when the process starts, the current time</span>
<span class="c1"># matches the drtTime in the command line. However, with synchronizing</span>
<span class="c1"># on, the current time will be offset by the fraction of the hour at</span>
<span class="c1"># which the process was started. Examples:</span>
<span class="c1"># Actual Starting time: 20040617_1230</span>
<span class="c1"># drtTime 20040616_0000</span>
<span class="c1"># Synchronizing off:</span>
<span class="c1"># GFE Spatial Editor at StartUp: 20040616_0000</span>
<span class="c1"># Synchronizing on:</span>
<span class="c1"># GFE Spatial Editor at StartUp: 20040616_0030</span>
<span class="c1">#</span>
<div class="viewcode-block" id="determineDrtOffset"><a class="viewcode-back" href="../../api/TimeUtil.html#awips.TimeUtil.determineDrtOffset">[docs]</a><span class="k">def</span> <span class="nf">determineDrtOffset</span><span class="p">(</span><span class="n">timeStr</span><span class="p">):</span>
<span class="n">launchStr</span> <span class="o">=</span> <span class="n">timeStr</span>
<span class="c1"># Check for time difference</span>
<span class="k">if</span> <span class="n">timeStr</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s2">&quot;,&quot;</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">times</span> <span class="o">=</span> <span class="n">timeStr</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;,&quot;</span><span class="p">)</span>
<span class="n">t1</span> <span class="o">=</span> <span class="n">makeTime</span><span class="p">(</span><span class="n">times</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">t2</span> <span class="o">=</span> <span class="n">makeTime</span><span class="p">(</span><span class="n">times</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="k">return</span> <span class="n">t1</span><span class="o">-</span><span class="n">t2</span><span class="p">,</span> <span class="n">launchStr</span>
<span class="c1"># Check for synchronized mode</span>
<span class="n">synch</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="n">timeStr</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;S&quot;</span><span class="p">:</span>
<span class="n">timeStr</span> <span class="o">=</span> <span class="n">timeStr</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="n">synch</span> <span class="o">=</span> <span class="mi">1</span>
<span class="n">drt_t</span> <span class="o">=</span> <span class="n">makeTime</span><span class="p">(</span><span class="n">timeStr</span><span class="p">)</span>
<span class="n">gm</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">gmtime</span><span class="p">()</span>
<span class="n">cur_t</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">(</span><span class="n">gm</span><span class="p">)</span>
<span class="c1"># Synchronize to most recent hour</span>
<span class="c1"># i.e. &quot;truncate&quot; cur_t to most recent hour.</span>
<span class="k">if</span> <span class="n">synch</span><span class="p">:</span>
<span class="n">cur_t</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">((</span><span class="n">gm</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">gm</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">gm</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span> <span class="n">gm</span><span class="p">[</span><span class="mi">3</span><span class="p">],</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
<span class="n">curStr</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="si">%4s%2s%2s</span><span class="s1">_</span><span class="si">%2s</span><span class="s1">00</span><span class="se">\n</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">gm</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span> <span class="nb">repr</span><span class="p">(</span><span class="n">gm</span><span class="p">[</span><span class="mi">1</span><span class="p">]),</span>
<span class="nb">repr</span><span class="p">(</span><span class="n">gm</span><span class="p">[</span><span class="mi">2</span><span class="p">]),</span> <span class="nb">repr</span><span class="p">(</span><span class="n">gm</span><span class="p">[</span><span class="mi">3</span><span class="p">]))</span>
<span class="n">curStr</span> <span class="o">=</span> <span class="n">curStr</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39; &#39;</span><span class="p">,</span> <span class="s1">&#39;0&#39;</span><span class="p">)</span>
<span class="n">launchStr</span> <span class="o">=</span> <span class="n">timeStr</span> <span class="o">+</span> <span class="s2">&quot;,&quot;</span> <span class="o">+</span> <span class="n">curStr</span>
<span class="n">offset</span> <span class="o">=</span> <span class="n">drt_t</span> <span class="o">-</span> <span class="n">cur_t</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">offset</span><span class="p">),</span> <span class="n">launchStr</span></div>
<div class="viewcode-block" id="makeTime"><a class="viewcode-back" href="../../api/TimeUtil.html#awips.TimeUtil.makeTime">[docs]</a><span class="k">def</span> <span class="nf">makeTime</span><span class="p">(</span><span class="n">timeStr</span><span class="p">):</span>
<span class="n">year</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">atoi</span><span class="p">(</span><span class="n">timeStr</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">4</span><span class="p">])</span>
<span class="n">month</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">atoi</span><span class="p">(</span><span class="n">timeStr</span><span class="p">[</span><span class="mi">4</span><span class="p">:</span><span class="mi">6</span><span class="p">])</span>
<span class="n">day</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">atoi</span><span class="p">(</span><span class="n">timeStr</span><span class="p">[</span><span class="mi">6</span><span class="p">:</span><span class="mi">8</span><span class="p">])</span>
<span class="n">hour</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">atoi</span><span class="p">(</span><span class="n">timeStr</span><span class="p">[</span><span class="mi">9</span><span class="p">:</span><span class="mi">11</span><span class="p">])</span>
<span class="n">minute</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">atoi</span><span class="p">(</span><span class="n">timeStr</span><span class="p">[</span><span class="mi">11</span><span class="p">:</span><span class="mi">13</span><span class="p">])</span>
<span class="c1"># Do not use daylight savings because gmtime is not in daylight</span>
<span class="c1"># savings time.</span>
<span class="k">return</span> <span class="n">time</span><span class="o">.</span><span class="n">mktime</span><span class="p">((</span><span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span> <span class="n">day</span><span class="p">,</span> <span class="n">hour</span><span class="p">,</span> <span class="n">minute</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2018, Unidata.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>