|
Last change
on this file since 167 was
160,
checked in by jmckenna, 14 years ago
|
|
change table column width for pdf output
|
|
File size:
2.3 KB
|
| Line | |
|---|
| 1 | .. _api-zoo: |
|---|
| 2 | |
|---|
| 3 | ZOO |
|---|
| 4 | === |
|---|
| 5 | |
|---|
| 6 | The following constants and functions are available for the ZOO class: |
|---|
| 7 | |
|---|
| 8 | Constants |
|---|
| 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 | |
|---|
| 28 | Functions |
|---|
| 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 | |
|---|
| 58 | SERVICE_ACCEPTED |
|---|
| 59 | {Integer} used for |
|---|
| 60 | |
|---|
| 61 | .. _service_started: |
|---|
| 62 | |
|---|
| 63 | SERVICE_STARTED |
|---|
| 64 | {Integer} used for |
|---|
| 65 | |
|---|
| 66 | .. _service_paused: |
|---|
| 67 | |
|---|
| 68 | SERVICE_PAUSED |
|---|
| 69 | {Integer} used for |
|---|
| 70 | |
|---|
| 71 | .. _service_succeeded: |
|---|
| 72 | |
|---|
| 73 | SERVICE_SUCCEEDED |
|---|
| 74 | {Integer} used for |
|---|
| 75 | |
|---|
| 76 | .. _service_failed: |
|---|
| 77 | |
|---|
| 78 | SERVICE_FAILED |
|---|
| 79 | {Integer} used for |
|---|
| 80 | |
|---|
| 81 | **Functions** |
|---|
| 82 | |
|---|
| 83 | .. _removeItem: |
|---|
| 84 | |
|---|
| 85 | removeItem |
|---|
| 86 | Remove an object from an array. |
|---|
| 87 | |
|---|
| 88 | .. _indexOf: |
|---|
| 89 | |
|---|
| 90 | indexOf |
|---|
| 91 | |
|---|
| 92 | .. _extend: |
|---|
| 93 | |
|---|
| 94 | extend |
|---|
| 95 | Copy all properties of a source object to a destination object. |
|---|
| 96 | |
|---|
| 97 | .. _rad: |
|---|
| 98 | |
|---|
| 99 | rad |
|---|
| 100 | |
|---|
| 101 | .. _distVincenty: |
|---|
| 102 | |
|---|
| 103 | distVincenty |
|---|
| 104 | Given two objects representing points with geographic coordinates, this calculates the distance between those points on the surface of an ellipsoid. |
|---|
| 105 | |
|---|
| 106 | .. _Class: |
|---|
| 107 | |
|---|
| 108 | Class |
|---|
| 109 | Method used to create ZOO classes. |
|---|
| 110 | |
|---|
| 111 | .. _UpdateStatus: |
|---|
| 112 | |
|---|
| 113 | UpdateStatus |
|---|
| 114 | Method used to update the status of the process |
|---|
| 115 | |
|---|
Note: See
TracBrowser
for help on using the repository browser.
