source: branches/PublicaMundi_David-devel/docs/_build/html/api/zoo-process.html @ 659

Last change on this file since 659 was 659, checked in by nbozon, 9 years ago

Massive update of zoo docs
File size: 16.1 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8  <meta name="viewport" content="width=device-width, initial-scale=1.0">
9 
10  <title>ZOO.Process &mdash; ZOO-Project 1.4a0 documentation</title>
11 
12  <link href="http://fonts.googleapis.com/css?family=Days+One" rel="stylesheet" type="text/css">
13 
14 
15
16 
17
18 
19 
20   
21      <link rel="search" type="application/opensearchdescription+xml" title="Search within ZOO-Project 1.4a0 documentation" href="../_static/opensearch.xml"/>
22   
23
24 
25
26 
27 
28    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
29 
30
31 
32
33 
34    <link rel="top" title="ZOO-Project 1.4a0 documentation" href="../index.html"/>
35        <link rel="up" title="ZOO-API Classes" href="classes.html"/>
36        <link rel="next" title="ZOO.Request" href="zoo-request.html"/>
37        <link rel="prev" title="ZOO.Format.WPS" href="zoo-format-wps.html"/> 
38
39 
40  <script src="_static/js/modernizr.min.js"></script>
41
42</head>
43
44<body class="wy-body-for-nav" role="document">
45
46  <div class="wy-grid-for-nav">
47
48   
49    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
50      <div class="wy-side-nav-search">
51       
52
53       
54          <a class="shrink" href="http://zoo-project.org"><img src="http://zoo-project.org/img/zoo-sun-logo.png" class="img-responsive sun" style="display: inline;"> ZOO</a>
55       
56
57       
58        </a>
59
60       
61<div role="search">
62  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
63    <input type="text" name="q" placeholder="Search docs" />
64    <input type="hidden" name="check_keywords" value="yes" />
65    <input type="hidden" name="area" value="default" />
66  </form>
67</div>
68
69       
70      </div>
71
72      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
73       
74         
75         
76              <ul class="current">
77<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a><ul>
78<li class="toctree-l2"><a class="reference internal" href="../intro.html#what-is-zoo-project">What is ZOO-Project ?</a></li>
79<li class="toctree-l2"><a class="reference internal" href="../intro.html#zoo-project-components">ZOO-Project components</a></li>
80<li class="toctree-l2"><a class="reference internal" href="../intro.html#open-source">Open Source</a></li>
81</ul>
82</li>
83<li class="toctree-l1"><a class="reference internal" href="../install/index.html">ZOO-Project installation</a><ul>
84<li class="toctree-l2"><a class="reference internal" href="../install/install-prerequisites.html">Prerequisites</a></li>
85<li class="toctree-l2"><a class="reference internal" href="../install/install-download.html">Download</a></li>
86<li class="toctree-l2"><a class="reference internal" href="../install/install-confoptions.html">Configure options</a></li>
87<li class="toctree-l2"><a class="reference internal" href="../install/install-installation.html">Installation on Unix/Linux</a></li>
88<li class="toctree-l2"><a class="reference internal" href="../install/install-onwindows.html">Installation on Windows ™</a></li>
89<li class="toctree-l2"><a class="reference internal" href="../install/install-onmacos.html">Installation on MacOSX ™</a></li>
90</ul>
91</li>
92<li class="toctree-l1"><a class="reference internal" href="../kernel/index.html">ZOO-Kernel</a><ul>
93<li class="toctree-l2"><a class="reference internal" href="../kernel/what.html">What is ZOO-Kernel ?</a></li>
94<li class="toctree-l2"><a class="reference internal" href="../kernel/configuration.html">ZOO-Kernel configuration</a></li>
95<li class="toctree-l2"><a class="reference internal" href="../kernel/mapserver.html">Optional MapServer support</a></li>
96<li class="toctree-l2"><a class="reference internal" href="../kernel/orfeotoolbox.html">Optional Orfeo Toolbox support</a></li>
97<li class="toctree-l2"><a class="reference internal" href="../kernel/sagagis.html">Optional SAGA GIS support</a></li>
98</ul>
99</li>
100<li class="toctree-l1"><a class="reference internal" href="../services/index.html">ZOO-Services</a><ul>
101<li class="toctree-l2"><a class="reference internal" href="../services/what.html">What are ZOO-Services ?</a></li>
102<li class="toctree-l2"><a class="reference internal" href="../services/zcfg-reference.html">ZOO-Service configuration file</a></li>
103<li class="toctree-l2"><a class="reference internal" href="../services/process-profiles.html">Process profiles registry</a></li>
104<li class="toctree-l2"><a class="reference internal" href="../services/howtos.html">Create your own ZOO-Services</a></li>
105<li class="toctree-l2"><a class="reference internal" href="../services/status.html">ZOO Status Service</a></li>
106<li class="toctree-l2"><a class="reference internal" href="../services/debug.html">Debugging ZOO Services</a></li>
107<li class="toctree-l2"><a class="reference internal" href="../services/zoo-services.html">Available ZOO-Services</a></li>
108</ul>
109</li>
110<li class="toctree-l1 current"><a class="reference internal" href="index.html">ZOO-API</a><ul class="current">
111<li class="toctree-l2"><a class="reference internal" href="what.html">What is ZOO-API ?</a></li>
112<li class="toctree-l2"><a class="reference internal" href="howto.html">Using ZOO-API</a></li>
113<li class="toctree-l2 current"><a class="reference internal" href="classes.html">ZOO-API Classes</a></li>
114<li class="toctree-l2"><a class="reference internal" href="examples.html">Examples</a></li>
115</ul>
116</li>
117<li class="toctree-l1"><a class="reference internal" href="../client/index.html">ZOO-Client</a><ul>
118<li class="toctree-l2"><a class="reference internal" href="../client/what.html">What is ZOO-Client ?</a></li>
119<li class="toctree-l2"><a class="reference internal" href="../client/howto.html">Using ZOO-Client</a></li>
120<li class="toctree-l2"><a class="reference internal" href="../client/example.html">Example application</a></li>
121</ul>
122</li>
123<li class="toctree-l1"><a class="reference internal" href="../contribute/index.html">Contributor Guide</a><ul>
124<li class="toctree-l2"><a class="reference internal" href="../contribute/howto.html">How to contribute ?</a></li>
125<li class="toctree-l2"><a class="reference internal" href="../contribute/code.html">Contribute code</a></li>
126</ul>
127</li>
128</ul>
129
130         
131       
132      </div>
133      &nbsp;
134    </nav>
135
136    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
137
138     
139      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
140        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
141        <a href="../contents.html">ZOO-Project</a>
142      </nav>
143
144
145     
146      <div class="wy-nav-content">
147        <div class="rst-content">
148          <div role="navigation" aria-label="breadcrumbs navigation">
149  <ul class="wy-breadcrumbs">
150
151    <li><a href="../contents.html"> Docs</a> &#8725; &#160;</li>
152     
153          <li><a href="index.html">ZOO-API</a> &#8725; &#160;</li>
154     
155          <li><a href="classes.html">ZOO-API Classes</a> &#8725; &#160;</li>
156     
157    <li>ZOO.Process</li>
158      <li class="wy-breadcrumbs-aside">
159       
160          <a href="../_sources/api/zoo-process.txt" rel="nofollow"> View page source</a>
161       
162      </li>
163  </ul>
164  <hr/>
165</div>
166          <div role="main" class="document">
167           
168  <div class="section" id="zoo-process">
169<span id="api-zoo-process"></span><h1>ZOO.Process<a class="headerlink" href="#zoo-process" title="Permalink to this headline"></a></h1>
170<p>Used to query OGC WPS process defined by its URL and its identifier.  Useful for chaining localhost process.</p>
171<div class="section" id="properties-and-functions">
172<h2>Properties and Functions<a class="headerlink" href="#properties-and-functions" title="Permalink to this headline"></a></h2>
173<table border="1" class="docutils">
174<colgroup>
175<col width="23%" />
176<col width="77%" />
177</colgroup>
178<thead valign="bottom">
179<tr class="row-odd"><th class="head">NAME</th>
180<th class="head">DESCRIPTION</th>
181</tr>
182</thead>
183<tbody valign="top">
184<tr class="row-even"><td><a class="reference internal" href="#schemalocation"><span>schemaLocation</span></a></td>
185<td>{String} Schema location for a particular minor version.</td>
186</tr>
187<tr class="row-odd"><td><a class="reference internal" href="#namespaces"><span>namespaces</span></a></td>
188<td>{Object} Mapping of namespace aliases to namespace URIs.</td>
189</tr>
190<tr class="row-even"><td><a class="reference internal" href="#url"><span>url</span></a></td>
191<td>{String} The OGC&#8217;s Web PRocessing Service URL, default is <a class="reference external" href="http://localhost/zoo">http://localhost/zoo</a>.</td>
192</tr>
193<tr class="row-odd"><td><a class="reference internal" href="#identifier"><span>identifier</span></a></td>
194<td>{String} Process identifier in the OGC&#8217;s Web Processing Service.</td>
195</tr>
196<tr class="row-even"><td><a class="reference internal" href="#id1"><span>ZOO.Process</span></a></td>
197<td>Create a new Process</td>
198</tr>
199<tr class="row-odd"><td><a class="reference internal" href="#execute"><span>Execute</span></a></td>
200<td>Query the OGC&#8217;s Web PRocessing Servcie to Execute the process.</td>
201</tr>
202<tr class="row-even"><td><a class="reference internal" href="#buildinput"><span>buildInput</span></a></td>
203<td>Object containing methods to build WPS inputs.</td>
204</tr>
205<tr class="row-odd"><td><a class="reference internal" href="#buildinput-complex"><span>buildInput.complex</span></a></td>
206<td>Given an E4XElement representing the WPS complex data input.</td>
207</tr>
208<tr class="row-even"><td><a class="reference internal" href="#buildinput-reference"><span>buildInput.reference</span></a></td>
209<td>Given an E4XElement representing the WPS reference input.</td>
210</tr>
211<tr class="row-odd"><td><a class="reference internal" href="#buildinput-literal"><span>buildInput.literal</span></a></td>
212<td>Given an E4XElement representing the WPS literal data input.</td>
213</tr>
214<tr class="row-even"><td><a class="reference internal" href="#builddatainputsnode"><span>buildDataInputsNode</span></a></td>
215<td>Method to build the WPS DataInputs element.</td>
216</tr>
217</tbody>
218</table>
219<dl class="docutils" id="schemalocation">
220<dt>schemaLocation</dt>
221<dd><code class="docutils literal"><span class="pre">{String}</span></code> Schema location for a particular minor version.</dd>
222</dl>
223<dl class="docutils" id="namespaces">
224<dt>namespaces</dt>
225<dd><code class="docutils literal"><span class="pre">{Object}</span></code> Mapping of namespace aliases to namespace URIs.</dd>
226</dl>
227<dl class="docutils" id="url">
228<dt>url</dt>
229<dd><code class="docutils literal"><span class="pre">{String}</span></code> The OGC&#8217;s Web PRocessing Service URL, default is <a class="reference external" href="http://localhost/zoo">http://localhost/zoo</a>.</dd>
230</dl>
231<dl class="docutils" id="identifier">
232<dt>identifier</dt>
233<dd><code class="docutils literal"><span class="pre">{String}</span></code> Process identifier in the OGC&#8217;s Web Processing Service.</dd>
234</dl>
235<dl class="docutils" id="id1">
236<dt>ZOO.Process</dt>
237<dd><p class="first">Create a new Process</p>
238<p><em>Parameters</em></p>
239<div class="last line-block">
240<div class="line"><code class="docutils literal"><span class="pre">url</span> <span class="pre">{String}</span></code> The OGC&#8217;s Web Processing Service URL.</div>
241<div class="line"><code class="docutils literal"><span class="pre">identifier</span> <span class="pre">{String}</span></code> The process identifier in the OGC&#8217;s Web Processing Service.</div>
242</div>
243</dd>
244</dl>
245<dl class="docutils" id="execute">
246<dt>Execute</dt>
247<dd><div class="first highlight-python"><div class="highlight"><pre>Execute: function(inputs)
248</pre></div>
249</div>
250<p>Query the OGC&#8217;s Web PRocessing Servcie to Execute the process.</p>
251<p><em>Parameters</em></p>
252<p><code class="docutils literal"><span class="pre">inputs</span> <span class="pre">{Object}</span></code></p>
253<p><em>Returns</em></p>
254<p class="last"><code class="docutils literal"><span class="pre">{String}</span></code> The OGC&#8217;s Web processing Service XML response.  The result needs to be interpreted.</p>
255</dd>
256</dl>
257<dl class="docutils" id="buildinput">
258<dt>buildInput</dt>
259<dd>Object containing methods to build WPS inputs.</dd>
260</dl>
261<dl class="docutils" id="buildinput-complex">
262<dt>buildInput.complex</dt>
263<dd><p class="first">Given an E4XElement representing the WPS complex data input.</p>
264<p><em>Parameters</em></p>
265<div class="line-block">
266<div class="line"><code class="docutils literal"><span class="pre">identifier</span> <span class="pre">{String}</span></code> the input indetifier</div>
267<div class="line"><code class="docutils literal"><span class="pre">data</span> <span class="pre">{Object}</span></code> A WPS complex data input.</div>
268</div>
269<p><em>Returns</em></p>
270<p class="last"><code class="docutils literal"><span class="pre">{E4XElement}</span></code> A WPS Input node.</p>
271</dd>
272</dl>
273<dl class="docutils" id="buildinput-reference">
274<dt>buildInput.reference</dt>
275<dd><p class="first">Given an E4XElement representing the WPS reference input.</p>
276<p><em>Parameters</em></p>
277<div class="line-block">
278<div class="line"><code class="docutils literal"><span class="pre">identifier</span> <span class="pre">{String}</span></code> the input indetifier</div>
279<div class="line"><code class="docutils literal"><span class="pre">data</span> <span class="pre">{Object}</span></code> A WPS reference input.</div>
280</div>
281<p><em>Returns</em></p>
282<p class="last"><code class="docutils literal"><span class="pre">{E4XElement}</span></code> A WPS Input node.</p>
283</dd>
284</dl>
285<dl class="docutils" id="buildinput-literal">
286<dt>buildInput.literal</dt>
287<dd><p class="first">Given an E4XElement representing the WPS literal data input.</p>
288<p><em>Parameters</em></p>
289<div class="line-block">
290<div class="line"><code class="docutils literal"><span class="pre">identifier</span> <span class="pre">{String}</span></code> the input indetifier</div>
291<div class="line"><code class="docutils literal"><span class="pre">data</span> <span class="pre">{Object}</span></code> A WPS literal data input.</div>
292</div>
293<p><em>Returns</em></p>
294<p class="last"><code class="docutils literal"><span class="pre">{E4XElement}</span></code> The WPS Input node.</p>
295</dd>
296</dl>
297<dl class="docutils" id="builddatainputsnode">
298<dt>buildDataInputsNode</dt>
299<dd><div class="first highlight-python"><div class="highlight"><pre>buildDataInputsNode:function(inputs)
300</pre></div>
301</div>
302<p>Method to build the WPS DataInputs element.</p>
303<p><em>Parameters</em></p>
304<p><code class="docutils literal"><span class="pre">inputs</span> <span class="pre">{Object}</span></code></p>
305<p><em>Returns</em></p>
306<p class="last"><code class="docutils literal"><span class="pre">{E4XElement}</span></code> The WPS DataInputs node for Execute query.</p>
307</dd>
308</dl>
309</div>
310</div>
311
312
313          </div>
314          <footer>
315 
316    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
317     
318        <a href="zoo-request.html" class="btn btn-neutral float-right" title="ZOO.Request">Next <span class="fa fa-arrow-circle-right"></span></a>
319     
320     
321        <a href="zoo-format-wps.html" class="btn btn-neutral" title="ZOO.Format.WPS"><span class="fa fa-arrow-circle-left"></span> Previous</a>
322     
323    </div>
324 
325
326  <hr/>
327  <div class="pfoot">
328  <div role="contentinfo">
329    <p>
330        &copy; Copyright 2009-2015, ZOO-Project team.
331    </p>
332  </div>
333  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> inspired by <a href="https://readthedocs.org">Read the Docs</a>.
334</div>
335</footer>
336
337        </div>
338      </div>
339
340    </section>
341
342  </div>
343 
344
345
346 
347
348    <script type="text/javascript">
349        var DOCUMENTATION_OPTIONS = {
350            URL_ROOT:'../',
351            VERSION:'1.4a0',
352            COLLAPSE_INDEX:false,
353            FILE_SUFFIX:'.html',
354            HAS_SOURCE:  true
355        };
356    </script>
357      <script type="text/javascript" src="../_static/jquery.js"></script>
358      <script type="text/javascript" src="../_static/underscore.js"></script>
359      <script type="text/javascript" src="../_static/doctools.js"></script>
360
361 
362
363 
364 
365    <script type="text/javascript" src="../_static/js/theme.js"></script>
366 
367
368 
369 
370  <script type="text/javascript">
371      jQuery(function () {
372          SphinxRtdTheme.StickyNav.enable();
373      });
374  </script>
375   
376
377</body>
378</html>
Note: See TracBrowser for help on using the repository browser.

Download now !

Search

Context Navigation

Main Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png