source: branches/PublicaMundi_David-devel/docs/_build/html/api/zoo.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.9 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 &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.Format.WPS" href="zoo-format-wps.html"/>
37        <link rel="prev" title="ZOO-API Classes" href="classes.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</li>
158      <li class="wy-breadcrumbs-aside">
159       
160          <a href="../_sources/api/zoo.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">
169<span id="api-zoo"></span><h1>ZOO<a class="headerlink" href="#zoo" title="Permalink to this headline"></a></h1>
170<p>The following constants and functions are available for the ZOO class:</p>
171<div class="section" id="constants">
172<h2>Constants<a class="headerlink" href="#constants" title="Permalink to this headline"></a></h2>
173<table border="1" class="docutils">
174<colgroup>
175<col width="38%" />
176<col width="63%" />
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="#service-accepted"><span>SERVICE_ACCEPTED</span></a></td>
185<td>{Integer} used for</td>
186</tr>
187<tr class="row-odd"><td><a class="reference internal" href="#service-started"><span>SERVICE_STARTED</span></a></td>
188<td>{Integer} used for</td>
189</tr>
190<tr class="row-even"><td><a class="reference internal" href="#service-paused"><span>SERVICE_PAUSED</span></a></td>
191<td>{Integer} used for</td>
192</tr>
193<tr class="row-odd"><td><a class="reference internal" href="#service-succeeded"><span>SERVICE_SUCCEEDED</span></a></td>
194<td>{Integer} used for</td>
195</tr>
196<tr class="row-even"><td><a class="reference internal" href="#service-failed"><span>SERVICE_FAILED</span></a></td>
197<td>{Integer} used for</td>
198</tr>
199</tbody>
200</table>
201</div>
202<div class="section" id="functions">
203<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h2>
204<table border="1" class="docutils">
205<colgroup>
206<col width="19%" />
207<col width="81%" />
208</colgroup>
209<thead valign="bottom">
210<tr class="row-odd"><th class="head">NAME</th>
211<th class="head">DESCRIPTION</th>
212</tr>
213</thead>
214<tbody valign="top">
215<tr class="row-even"><td><a class="reference internal" href="#removeitem"><span>removeItem</span></a></td>
216<td>Remove an object from an array.</td>
217</tr>
218<tr class="row-odd"><td><a class="reference internal" href="#indexof"><span>indexOf</span></a></td>
219<td>&nbsp;</td>
220</tr>
221<tr class="row-even"><td><a class="reference internal" href="#extend"><span>extend</span></a></td>
222<td>Copy all properties of a source object to a destination object.</td>
223</tr>
224<tr class="row-odd"><td><a class="reference internal" href="#rad"><span>rad</span></a></td>
225<td>&nbsp;</td>
226</tr>
227<tr class="row-even"><td><a class="reference internal" href="#distvincenty"><span>distVincenty</span></a></td>
228<td>Given two objects representing points with geographic coordinates,
229this calculates the distance between those points on the surface of an
230ellipsoid.</td>
231</tr>
232<tr class="row-odd"><td><a class="reference internal" href="#class"><span>Class</span></a></td>
233<td>Method used to create ZOO classes.</td>
234</tr>
235<tr class="row-even"><td><a class="reference internal" href="#updatestatus"><span>UpdateStatus</span></a></td>
236<td>Method used to update the status of the process</td>
237</tr>
238</tbody>
239</table>
240<p><strong>Constants</strong></p>
241<dl class="docutils" id="service-accepted">
242<dt>SERVICE_ACCEPTED</dt>
243<dd><code class="docutils literal"><span class="pre">{Integer}</span></code> used for</dd>
244</dl>
245<dl class="docutils" id="service-started">
246<dt>SERVICE_STARTED</dt>
247<dd><code class="docutils literal"><span class="pre">{Integer}</span></code> used for</dd>
248</dl>
249<dl class="docutils" id="service-paused">
250<dt>SERVICE_PAUSED</dt>
251<dd><code class="docutils literal"><span class="pre">{Integer}</span></code> used for</dd>
252</dl>
253<dl class="docutils" id="service-succeeded">
254<dt>SERVICE_SUCCEEDED</dt>
255<dd><code class="docutils literal"><span class="pre">{Integer}</span></code> used for</dd>
256</dl>
257<dl class="docutils" id="service-failed">
258<dt>SERVICE_FAILED</dt>
259<dd><code class="docutils literal"><span class="pre">{Integer}</span></code> used for</dd>
260</dl>
261<p><strong>Functions</strong></p>
262<dl class="docutils" id="removeitem">
263<dt>removeItem</dt>
264<dd><div class="first highlight-python"><div class="highlight"><pre>removeItem: function(array,item)
265</pre></div>
266</div>
267<p>Remove an object from an array.  Iterates through the array to find the item, then removes it.</p>
268<p><em>Parameters</em></p>
269<div class="line-block">
270<div class="line"><code class="docutils literal"><span class="pre">array</span> <span class="pre">{Array}</span></code></div>
271<div class="line"><code class="docutils literal"><span class="pre">item</span> <span class="pre">{Object}</span></code></div>
272</div>
273<p><em>Returns</em></p>
274<p class="last"><code class="docutils literal"><span class="pre">{Array}</span></code> A reference to the array</p>
275</dd>
276</dl>
277<dl class="docutils" id="indexof">
278<dt>indexOf</dt>
279<dd><div class="first highlight-python"><div class="highlight"><pre>indexOf: function(array,obj)
280</pre></div>
281</div>
282<p><em>Parameters</em></p>
283<div class="line-block">
284<div class="line"><code class="docutils literal"><span class="pre">array</span> <span class="pre">{Array}</span></code></div>
285<div class="line"><code class="docutils literal"><span class="pre">obj</span> <span class="pre">{Object}</span></code></div>
286</div>
287<p><em>Returns</em></p>
288<p class="last"><code class="docutils literal"><span class="pre">{Integer}</span></code> The index at, which the first object was found in the array.  If not found, returns -1.</p>
289</dd>
290</dl>
291<dl class="docutils" id="extend">
292<dt>extend</dt>
293<dd><div class="first highlight-python"><div class="highlight"><pre>extend: function(destination,source)
294</pre></div>
295</div>
296<p>Copy all properties of a source object to a destination object.  Modifies the passed in destination object.
297Any properties on the source object that are set to undefined will not be (re)set on the destination object.</p>
298<p><em>Parameters</em></p>
299<div class="line-block">
300<div class="line"><code class="docutils literal"><span class="pre">destination</span> <span class="pre">{Object}</span></code> The object that will be modified</div>
301<div class="line"><code class="docutils literal"><span class="pre">source</span> <span class="pre">{Object}</span></code> The object with properties to be set on the destination</div>
302</div>
303<p><em>Returns</em></p>
304<p class="last"><code class="docutils literal"><span class="pre">{Object}</span></code> The destination object.</p>
305</dd>
306</dl>
307<dl class="docutils" id="rad">
308<dt>rad</dt>
309<dd><div class="first highlight-python"><div class="highlight"><pre>rad: function(x)
310</pre></div>
311</div>
312<p><em>Parameters</em></p>
313<div class="line-block">
314<div class="line"><code class="docutils literal"><span class="pre">x</span> <span class="pre">{Float}</span></code></div>
315</div>
316<p><em>Returns</em></p>
317<p class="last"><code class="docutils literal"><span class="pre">{Float}</span></code></p>
318</dd>
319</dl>
320<dl class="docutils" id="distvincenty">
321<dt>distVincenty</dt>
322<dd><div class="first highlight-python"><div class="highlight"><pre>distVincenty: function(p1,p2)
323</pre></div>
324</div>
325<p>Given two objects representing points with geographic coordinates, this calculates the distance between
326those points on the surface of an ellipsoid.</p>
327<p><em>Parameters:</em></p>
328<div class="last line-block">
329<div class="line"><code class="docutils literal"><span class="pre">p1</span></code> <span class="xref std std-ref">{ZOO.Geometry.Point}</span> (or any object with both .x, .y properties)</div>
330<div class="line"><code class="docutils literal"><span class="pre">p2</span></code> <span class="xref std std-ref">{ZOO.Geometry.Point}</span> (or any object with both .x, .y properties)</div>
331</div>
332</dd>
333</dl>
334<dl class="docutils" id="class">
335<dt>Class</dt>
336<dd><div class="first highlight-python"><div class="highlight"><pre>Class: function()
337</pre></div>
338</div>
339<p class="last">Method used to create ZOO classes.  Includes support for multiple inheritance.</p>
340</dd>
341</dl>
342<dl class="docutils" id="updatestatus">
343<dt>UpdateStatus</dt>
344<dd><div class="first highlight-python"><div class="highlight"><pre>UpdateStatus: function(env,value)
345</pre></div>
346</div>
347<p>Method used to update the status of the process</p>
348<p><em>Parameters</em></p>
349<div class="last line-block">
350<div class="line"><code class="docutils literal"><span class="pre">env</span> <span class="pre">{Object}</span></code> The environment object</div>
351<div class="line"><code class="docutils literal"><span class="pre">value</span> <span class="pre">{Float}</span></code> The status value between 0 to 100</div>
352</div>
353</dd>
354</dl>
355</div>
356</div>
357
358
359          </div>
360          <footer>
361 
362    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
363     
364        <a href="zoo-format-wps.html" class="btn btn-neutral float-right" title="ZOO.Format.WPS">Next <span class="fa fa-arrow-circle-right"></span></a>
365     
366     
367        <a href="classes.html" class="btn btn-neutral" title="ZOO-API Classes"><span class="fa fa-arrow-circle-left"></span> Previous</a>
368     
369    </div>
370 
371
372  <hr/>
373  <div class="pfoot">
374  <div role="contentinfo">
375    <p>
376        &copy; Copyright 2009-2015, ZOO-Project team.
377    </p>
378  </div>
379  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>.
380</div>
381</footer>
382
383        </div>
384      </div>
385
386    </section>
387
388  </div>
389 
390
391
392 
393
394    <script type="text/javascript">
395        var DOCUMENTATION_OPTIONS = {
396            URL_ROOT:'../',
397            VERSION:'1.4a0',
398            COLLAPSE_INDEX:false,
399            FILE_SUFFIX:'.html',
400            HAS_SOURCE:  true
401        };
402    </script>
403      <script type="text/javascript" src="../_static/jquery.js"></script>
404      <script type="text/javascript" src="../_static/underscore.js"></script>
405      <script type="text/javascript" src="../_static/doctools.js"></script>
406
407 
408
409 
410 
411    <script type="text/javascript" src="../_static/js/theme.js"></script>
412 
413
414 
415 
416  <script type="text/javascript">
417      jQuery(function () {
418          SphinxRtdTheme.StickyNav.enable();
419      });
420  </script>
421   
422
423</body>
424</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