source:
branches/PublicaMundi_David-devel/docs/api/zoo.rst
@
963
Last change on this file since 963 was 696, checked in by djay, 9 years ago | |
---|---|
|
|
File size: 3.7 KB |
ZOO
The following constants and functions are available for the ZOO class:
Constants
NAME | DESCRIPTION |
---|---|
{Integer} used for | |
{Integer} used for | |
{Integer} used for | |
{Integer} used for | |
{Integer} used for |
Functions
NAME | DESCRIPTION |
---|---|
Remove an object from an array. | |
Copy all properties of a source object to a destination object. | |
Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid. | |
Method used to create ZOO classes. | |
Method used to update the status of the process |
Constants
- SERVICE_ACCEPTED
- {Integer} used for
- SERVICE_STARTED
- {Integer} used for
- SERVICE_PAUSED
- {Integer} used for
- SERVICE_SUCCEEDED
- {Integer} used for
- SERVICE_FAILED
- {Integer} used for
Functions
- removeItem
removeItem: function(array,item)
Remove an object from an array. Iterates through the array to find the item, then removes it.
Parameters
array {Array}item {Object}Returns
{Array} A reference to the array
- indexOf
indexOf: function(array,obj)
Parameters
array {Array}obj {Object}Returns
{Integer} The index at, which the first object was found in the array. If not found, returns -1.
- extend
extend: function(destination,source)
Copy all properties of a source object to a destination object. Modifies the passed in destination object. Any properties on the source object that are set to undefined will not be (re)set on the destination object.
Parameters
destination {Object} The object that will be modifiedsource {Object} The object with properties to be set on the destinationReturns
{Object} The destination object.
- rad
rad: function(x)
Parameters
x {Float}Returns
{Float}
- distVincenty
distVincenty: function(p1,p2)
Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid.
Parameters:
p1 :ref:`{ZOO.Geometry.Point} <api-zoo-geometry-point>` (or any object with both .x, .y properties)p2 :ref:`{ZOO.Geometry.Point} <api-zoo-geometry-point>` (or any object with both .x, .y properties)
- Class
Class: function()
Method used to create ZOO classes. Includes support for multiple inheritance.
- UpdateStatus
UpdateStatus: function(env,value)
Method used to update the status of the process
Parameters
env {Object} The environment objectvalue {Float} The status value between 0 to 100