source: trunk/docs/api/zoo.txt @ 348

Last change on this file since 348 was 348, checked in by neteler, 8 years ago

set correctly svn propset

  • Property svn:eol-style set to native
  • Property svn:keywords set to HeadURL Date Author Id Rev
  • Property svn:mime-type set to text/plain
File size: 3.7 KB
Line 
1.. _api-zoo:
2
3ZOO
4===
5
6The following constants and functions are available for the ZOO class:
7
8Constants
9---------
10
11.. list-table::
12   :widths: 30 50
13   :header-rows: 1
14
15   * - NAME
16     - DESCRIPTION
17   * - :ref:`SERVICE_ACCEPTED <service_accepted>`
18     - {Integer} used for
19   * - :ref:`SERVICE_STARTED <service_started>`
20     - {Integer} used for   
21   * - :ref:`SERVICE_PAUSED <service_paused>`
22     - {Integer} used for
23   * - :ref:`SERVICE_SUCCEEDED <service_succeeded>`
24     - {Integer} used for     
25   * - :ref:`SERVICE_FAILED <service_failed>`
26     - {Integer} used for       
27
28Functions
29---------
30
31.. list-table::
32   :widths: 12 50
33   :header-rows: 1
34
35   * - NAME
36     - DESCRIPTION
37   * - :ref:`removeItem <removeItem>`
38     - Remove an object from an array.   
39   * - :ref:`indexOf <indexOf>`
40     -
41   * - :ref:`extend <extend>`
42     - Copy all properties of a source object to a destination object. 
43   * - :ref:`rad <rad>` 
44     -     
45   * - :ref:`distVincenty <distVincenty>`
46     - Given two objects representing points with geographic coordinates,
47       this calculates the distance between those points on the surface of an 
48       ellipsoid.
49   * - :ref:`Class <Class>`
50     - Method used to create ZOO classes.
51   * - :ref:`UpdateStatus <UpdateStatus>`
52     - Method used to update the status of the process     
53
54**Constants**
55
56.. _service_accepted:
57
58SERVICE_ACCEPTED       
59  ``{Integer}`` used for
60 
61.. _service_started:
62
63SERVICE_STARTED
64  ``{Integer}`` used for
65 
66.. _service_paused: 
67
68SERVICE_PAUSED 
69  ``{Integer}`` used for
70 
71.. _service_succeeded: 
72
73SERVICE_SUCCEEDED
74  ``{Integer}`` used for
75 
76.. _service_failed:   
77 
78SERVICE_FAILED 
79  ``{Integer}`` used for
80
81**Functions**
82
83.. _removeItem:
84
85removeItem     
86  ::
87 
88    removeItem: function(array,item)
89 
90  Remove an object from an array.  Iterates through the array to find the item, then removes it.
91 
92  *Parameters*
93 
94  | ``array {Array}``
95  | ``item {Object}``
96 
97  *Returns*
98   
99  ``{Array}`` A reference to the array
100 
101.. _indexOf:
102
103indexOf
104  ::
105 
106    indexOf: function(array,obj)
107
108  *Parameters*
109   
110  | ``array {Array}``
111  | ``obj {Object}``
112
113  *Returns*
114
115  ``{Integer}`` The index at, which the first object was found in the array.  If not found, returns -1.
116
117.. _extend:
118
119extend
120  ::
121 
122    extend: function(destination,source)
123
124  Copy all properties of a source object to a destination object.  Modifies the passed in destination object. 
125  Any properties on the source object that are set to undefined will not be (re)set on the destination object.
126
127  *Parameters*
128 
129  | ``destination {Object}`` The object that will be modified
130  | ``source {Object}`` The object with properties to be set on the destination
131
132  *Returns*
133
134  ``{Object}`` The destination object.
135 
136.. _rad: 
137 
138rad     
139  ::
140 
141    rad: function(x)
142
143  *Parameters*
144 
145  | ``x {Float}``
146
147  *Returns*
148
149  ``{Float}``
150
151.. _distVincenty:
152
153distVincenty
154  ::
155
156    distVincenty: function(p1,p2)
157
158  Given two objects representing points with geographic coordinates, this calculates the distance between
159  those points on the surface of an ellipsoid.
160
161  *Parameters:*
162
163  | ``p1`` :ref:`{ZOO.Geometry.Point} <api-zoo-geometry-point>` (or any object with both .x, .y properties)
164  | ``p2`` :ref:`{ZOO.Geometry.Point} <api-zoo-geometry-point>` (or any object with both .x, .y properties)
165
166.. _Class:
167
168Class   
169  ::
170 
171    Class: function()
172
173  Method used to create ZOO classes.  Includes support for multiple inheritance.
174 
175.. _UpdateStatus: 
176 
177UpdateStatus   
178  ::
179 
180    UpdateStatus: function(env,value)
181
182  Method used to update the status of the process
183
184  *Parameters*
185 
186  | ``env {Object}`` The environment object
187  | ``value {Float}`` The status value between 0 to 100
188
Note: See TracBrowser for help on using the repository browser.

Search

Context 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