mirror of
https://github.com/Unidata/python-awips.git
synced 2025-02-24 06:57:56 -05:00
479 lines
No EOL
30 KiB
HTML
479 lines
No EOL
30 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.dataaccess — 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?v=5d32c60e"></script>
|
|
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=b3ba4146"></script>
|
|
<script src="../../_static/doctools.js?v=888ff710"></script>
|
|
<script src="../../_static/sphinx_highlight.js?v=4825356b"></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" 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>
|
|
<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" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
|
|
<li class="breadcrumb-item active">awips.dataaccess</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.dataaccess</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1">#</span>
|
|
<span class="c1"># __init__.py for awips.dataaccess package</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># SOFTWARE HISTORY</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Date Ticket# Engineer Description</span>
|
|
<span class="c1"># ------------ ---------- ----------- --------------------------</span>
|
|
<span class="c1"># 12/10/12 njensen Initial Creation.</span>
|
|
<span class="c1"># Feb 14, 2013 1614 bsteffen refactor data access framework</span>
|
|
<span class="c1"># to use single request.</span>
|
|
<span class="c1"># Apr 09, 2013 1871 njensen Add doc strings</span>
|
|
<span class="c1"># Jun 03, 2013 2023 dgilling Add getAttributes to IData, add</span>
|
|
<span class="c1"># getLatLonGrids() to IGridData.</span>
|
|
<span class="c1"># Aug 01, 2016 2416 tgurney Add INotificationSubscriber</span>
|
|
<span class="c1"># and INotificationFilter</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1">#</span>
|
|
|
|
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s1">'IData'</span><span class="p">,</span>
|
|
<span class="s1">'IDataRequest'</span><span class="p">,</span>
|
|
<span class="s1">'IGeometryData'</span><span class="p">,</span>
|
|
<span class="s1">'IGridData'</span><span class="p">,</span>
|
|
<span class="s1">'IGeometryData'</span><span class="p">,</span>
|
|
<span class="s1">'INotificationFilter'</span><span class="p">,</span>
|
|
<span class="s1">'INotificationSubscriber'</span>
|
|
<span class="p">]</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">abc</span>
|
|
<span class="kn">from</span> <span class="nn">six</span> <span class="kn">import</span> <span class="n">with_metaclass</span>
|
|
|
|
|
|
<div class="viewcode-block" id="IDataRequest"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest">[docs]</a><span class="k">class</span> <span class="nc">IDataRequest</span><span class="p">(</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="nb">object</span><span class="p">)):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> An IDataRequest to be submitted to the DataAccessLayer to retrieve data.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.setDatatype"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.setDatatype">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">setDatatype</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">datatype</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Sets the datatype of the request.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> datatype: A string of the datatype, such as "grid", "radar", "gfe", "obs"</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.addIdentifier"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.addIdentifier">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">addIdentifier</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Adds an identifier to the request. Identifiers are specific to the</span>
|
|
<span class="sd"> datatype being requested.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> key: the string key of the identifier</span>
|
|
<span class="sd"> value: the value of the identifier</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.setParameters"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.setParameters">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">setParameters</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Sets the parameters of data to request.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> params: a list of strings of parameters to request</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.setLevels"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.setLevels">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">setLevels</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">levels</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Sets the levels of data to request. Not all datatypes support levels.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> levels: a list of strings of level abbreviations to request</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.setEnvelope"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.setEnvelope">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">setEnvelope</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Sets the envelope of the request. If supported by the datatype factory,</span>
|
|
<span class="sd"> the data returned for the request will be constrained to only the data</span>
|
|
<span class="sd"> within the envelope.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> env: a shapely geometry</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.setLocationNames"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.setLocationNames">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">setLocationNames</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">locationNames</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Sets the location names of the request.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> locationNames: a list of strings of location names to request</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.getDatatype"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.getDatatype">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getDatatype</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the datatype of the request</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the datatype set on the request</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.getIdentifiers"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.getIdentifiers">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getIdentifiers</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the identifiers on the request</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a dictionary of the identifiers</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.getLevels"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.getLevels">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getLevels</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the levels on the request</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a list of strings of the levels</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.getLocationNames"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.getLocationNames">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getLocationNames</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the location names on the request</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a list of strings of the location names</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div>
|
|
|
|
<div class="viewcode-block" id="IDataRequest.getEnvelope"><a class="viewcode-back" href="../../api/IDataRequest.html#awips.dataaccess.IDataRequest.getEnvelope">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getEnvelope</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the envelope on the request</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a rectangular shapely geometry</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span></div></div>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">IData</span><span class="p">(</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="nb">object</span><span class="p">)):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> An IData representing data returned from the DataAccessLayer.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getAttribute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets an attribute of the data.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> key: the key of the attribute</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the value of the attribute</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getAttributes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the valid attributes for the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a list of strings of the attribute names</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getDataTime</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the data time of the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the data time of the data, or None if no time is associated</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getLevel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the level of the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the level of the data, or None if no level is associated</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getLocationName</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">param</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the location name of the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the location name of the data, or None if no location name is</span>
|
|
<span class="sd"> associated</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">IGridData</span><span class="p">(</span><span class="n">IData</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> An IData representing grid data that is returned by the DataAccessLayer.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getParameter</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the parameter of the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the parameter of the data</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getUnit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the unit of the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the string abbreviation of the unit, or None if no unit is associated</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getRawData</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the grid data as a numpy array.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a numpy array of the data</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getLatLonCoords</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the lat/lon coordinates of the grid data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a tuple where the first element is a numpy array of lons, and the</span>
|
|
<span class="sd"> second element is a numpy array of lats</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">IGeometryData</span><span class="p">(</span><span class="n">IData</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> An IData representing geometry data that is returned by the DataAccessLayer.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getGeometry</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the geometry of the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a shapely geometry</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getParameters</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Gets the parameters of the data.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a list of strings of the parameter names</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getString</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">param</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the string value of the specified param.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> param: the string name of the param</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the string value of the param</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getNumber</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">param</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the number value of the specified param.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> param: the string name of the param</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the number value of the param</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getUnit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">param</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the unit of the specified param.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> param: the string name of the param</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> the string abbreviation of the unit of the param</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">getType</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">param</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Gets the type of the param.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> param: the string name of the param</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> a string of the type of the parameter, such as</span>
|
|
<span class="sd"> "STRING", "INT", "LONG", "FLOAT", or "DOUBLE"</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">INotificationSubscriber</span><span class="p">(</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="nb">object</span><span class="p">)):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> An INotificationSubscriber representing a notification filter returned from</span>
|
|
<span class="sd"> the DataNotificationLayer.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">subscribe</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Subscribes to the requested data. Method will not return until close is</span>
|
|
<span class="sd"> called in a separate thread.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> callback: the method to call with the IGridData/IGeometryData</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">pass</span>
|
|
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Closes the notification subscriber"""</span>
|
|
<span class="k">pass</span>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">INotificationFilter</span><span class="p">(</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">,</span> <span class="nb">object</span><span class="p">)):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Represents data required to filter a set of URIs and</span>
|
|
<span class="sd"> return a corresponding list of IDataRequest to retrieve data for.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
|
<span class="k">def</span> <span class="nf">accept</span><span class="p">(</span><span class="n">dataUri</span><span class="p">):</span>
|
|
<span class="k">pass</span>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© 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> |