python-awips/api/IDataRequest.html

<!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>IDataRequest (newDataRequest()) &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="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.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="PyData" href="PyData.html" />
    <link rel="prev" title="DataAccessLayer" href="DataAccessLayer.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 current"><a class="current reference internal" href="#">IDataRequest (newDataRequest())</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#awips.dataaccess.IDataRequest"><code class="docutils literal notranslate"><span class="pre">IDataRequest</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.__weakref__"><code class="docutils literal notranslate"><span class="pre">IDataRequest.__weakref__</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.addIdentifier"><code class="docutils literal notranslate"><span class="pre">IDataRequest.addIdentifier()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.getDatatype"><code class="docutils literal notranslate"><span class="pre">IDataRequest.getDatatype()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.getEnvelope"><code class="docutils literal notranslate"><span class="pre">IDataRequest.getEnvelope()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.getIdentifiers"><code class="docutils literal notranslate"><span class="pre">IDataRequest.getIdentifiers()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.getLevels"><code class="docutils literal notranslate"><span class="pre">IDataRequest.getLevels()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.getLocationNames"><code class="docutils literal notranslate"><span class="pre">IDataRequest.getLocationNames()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.setDatatype"><code class="docutils literal notranslate"><span class="pre">IDataRequest.setDatatype()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.setEnvelope"><code class="docutils literal notranslate"><span class="pre">IDataRequest.setEnvelope()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.setLevels"><code class="docutils literal notranslate"><span class="pre">IDataRequest.setLevels()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.setLocationNames"><code class="docutils literal notranslate"><span class="pre">IDataRequest.setLocationNames()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#awips.dataaccess.IDataRequest.setParameters"><code class="docutils literal notranslate"><span class="pre">IDataRequest.setParameters()</span></code></a></li>
</ul>
</li>
</ul>
</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"><a class="reference internal" href="DateTimeConverter.html">DateTimeConverter</a></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">IDataRequest (newDataRequest())</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/api/IDataRequest.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="idatarequest-newdatarequest">
<h1>IDataRequest (newDataRequest())<a class="headerlink" href="#idatarequest-newdatarequest" title="Permalink to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">awips.dataaccess.</span></span><span class="sig-name descname"><span class="pre">IDataRequest</span></span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest" title="Permalink to this definition"></a></dt>
<dd><p>An IDataRequest to be submitted to the DataAccessLayer to retrieve data.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.__weakref__">
<span class="sig-name descname"><span class="pre">__weakref__</span></span><a class="headerlink" href="#awips.dataaccess.IDataRequest.__weakref__" title="Permalink to this definition"></a></dt>
<dd><p>list of weak references to the object (if defined)</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.addIdentifier">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">addIdentifier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.addIdentifier"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.addIdentifier" title="Permalink to this definition"></a></dt>
<dd><p>Adds an identifier to the request.  Identifiers are specific to the
datatype being requested.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>key: the string key of the identifier
value: the value of the identifier</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.getDatatype">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">getDatatype</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.getDatatype"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.getDatatype" title="Permalink to this definition"></a></dt>
<dd><p>Gets the datatype of the request</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>the datatype set on the request</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.getEnvelope">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">getEnvelope</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.getEnvelope"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.getEnvelope" title="Permalink to this definition"></a></dt>
<dd><p>Gets the envelope on the request</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>a rectangular shapely geometry</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.getIdentifiers">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">getIdentifiers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.getIdentifiers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.getIdentifiers" title="Permalink to this definition"></a></dt>
<dd><p>Gets the identifiers on the request</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>a dictionary of the identifiers</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.getLevels">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">getLevels</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.getLevels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.getLevels" title="Permalink to this definition"></a></dt>
<dd><p>Gets the levels on the request</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>a list of strings of the levels</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.getLocationNames">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">getLocationNames</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.getLocationNames"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.getLocationNames" title="Permalink to this definition"></a></dt>
<dd><p>Gets the location names on the request</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>a list of strings of the location names</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.setDatatype">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setDatatype</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datatype</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.setDatatype"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.setDatatype" title="Permalink to this definition"></a></dt>
<dd><p>Sets the datatype of the request.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>datatype: A string of the datatype, such as “grid”, “radar”, “gfe”, “obs”</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.setEnvelope">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setEnvelope</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.setEnvelope"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.setEnvelope" title="Permalink to this definition"></a></dt>
<dd><p>Sets the envelope of the request.  If supported by the datatype factory,
the data returned for the request will be constrained to only the data
within the envelope.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>env: a shapely geometry</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.setLevels">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setLevels</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">levels</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.setLevels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.setLevels" title="Permalink to this definition"></a></dt>
<dd><p>Sets the levels of data to request.  Not all datatypes support levels.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>levels: a list of strings of level abbreviations to request</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.setLocationNames">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setLocationNames</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">locationNames</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.setLocationNames"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.setLocationNames" title="Permalink to this definition"></a></dt>
<dd><p>Sets the location names of the request.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>locationNames: a list of strings of location names to request</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="awips.dataaccess.IDataRequest.setParameters">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">setParameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">params</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/awips/dataaccess.html#IDataRequest.setParameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#awips.dataaccess.IDataRequest.setParameters" title="Permalink to this definition"></a></dt>
<dd><p>Sets the parameters of data to request.</p>
<dl class="simple">
<dt>Args:</dt><dd><p>params: a list of strings of parameters to request</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="DataAccessLayer.html" class="btn btn-neutral float-left" title="DataAccessLayer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="PyData.html" class="btn btn-neutral float-right" title="PyData" 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>