xan/python-awips
1
0
Fork 0
mirror of https://github.com/Unidata/python-awips.git synced 2025-02-23 22:57:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
python-awips/api/DateTimeConverter.html
srcarter3 b0b85752cf deploy: ef0e1a221e
2023-05-23 17:12:03 +00:00

170 lines
No EOL
9.2 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>DateTimeConverter &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 src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.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" />
<link rel="next" title="CombinedTimeQuery" href="CombinedTimeQuery.html" />
<link rel="prev" title="IFPClient" href="IFPClient.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" aria-label="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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">API Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="DataAccessLayer.html">DataAccessLayer</a></li>
<li class="toctree-l2"><a class="reference internal" href="IDataRequest.html">IDataRequest (newDataRequest())</a></li>
<li class="toctree-l2"><a class="reference internal" href="PyData.html">PyData</a></li>
<li class="toctree-l2"><a class="reference internal" href="PyGridData.html">PyGridData</a></li>
<li class="toctree-l2"><a class="reference internal" href="PyGeometryData.html">PyGeometryData</a></li>
<li class="toctree-l2"><a class="reference internal" href="ModelSounding.html">ModelSounding</a></li>
<li class="toctree-l2"><a class="reference internal" href="ThriftClientRouter.html">ThriftClientRouter</a></li>
<li class="toctree-l2"><a class="reference internal" href="ThriftClient.html">ThriftClient</a></li>
<li class="toctree-l2"><a class="reference internal" href="TimeUtil.html">TimeUtil</a></li>
<li class="toctree-l2"><a class="reference internal" href="RadarCommon.html">RadarCommon</a></li>
<li class="toctree-l2"><a class="reference internal" href="IFPClient.html">IFPClient</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">DateTimeConverter</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#awips.DateTimeConverter.constructTimeRange"><code class="docutils literal notranslate"><span class="pre">constructTimeRange()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#awips.DateTimeConverter.convertToDateTime"><code class="docutils literal notranslate"><span class="pre">convertToDateTime()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="CombinedTimeQuery.html">CombinedTimeQuery</a></li>
</ul>
</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" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="index.html">API Documentation</a></li>
<li class="breadcrumb-item active">DateTimeConverter</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/api/DateTimeConverter.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-awips.DateTimeConverter">
<span id="datetimeconverter"></span><h1>DateTimeConverter<a class="headerlink" href="#module-awips.DateTimeConverter" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="awips.DateTimeConverter.constructTimeRange">
<span class="sig-prename descclassname"><span class="pre">awips.DateTimeConverter.</span></span><span class="sig-name descname"><span class="pre">constructTimeRange</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/DateTimeConverter.html#constructTimeRange"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.DateTimeConverter.constructTimeRange" title="Permalink to this definition"></a></dt>
<dd><p>Builds a python dynamicserialize TimeRange object from the given
arguments.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>args*: must be a TimeRange or a pair of objects that can be</dt><dd><p>converted to a datetime via convertToDateTime().</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>A TimeRange.</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="awips.DateTimeConverter.convertToDateTime">
<span class="sig-prename descclassname"><span class="pre">awips.DateTimeConverter.</span></span><span class="sig-name descname"><span class="pre">convertToDateTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeArg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/DateTimeConverter.html#convertToDateTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.DateTimeConverter.convertToDateTime" title="Permalink to this definition"></a></dt>
<dd><p>Converts the given object to a python datetime object. Supports native
python representations like datetime and struct_time, but also
the dynamicserialize types like Date and Timestamp. Raises TypeError
if no conversion can be performed.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>timeArg: a python object representing a date and time. Supported
types include datetime, struct_time, float, int, long and the
dynamicserialize types Date and Timestamp.</p>
</dd>
<dt>Returns:</dt><dd><p>A datetime that represents the same date/time as the passed in object.</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="IFPClient.html" class="btn btn-neutral float-left" title="IFPClient" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="CombinedTimeQuery.html" class="btn btn-neutral float-right" title="CombinedTimeQuery" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<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>
Reference in a new issue View git blame Copy permalink