Changeset 459 for trunk/docs

Timestamp:

Apr 1, 2014, 11:32:29 PM (10 years ago)

Author:

djay

Message:

Initial introduction of Value and Range in AllowedValues?, update zcfg documentation. Return valid Status code when returning ExceptionRepport?.

File:

• trunk/docs/services/zcfg-reference.txt (modified) (2 diffs)

trunk/docs/services/zcfg-reference.txt

@@ -131 +131 @@
 A ``<LiteralData>`` node contains:
 
+- one (optional) ``AllowedValues`` key containing all value allowed for this input
+- one (optional) ``rangeMin`` (``rangeMin``) properties containing the minimum (maximum) value of this range
+- one (optional) ``rangeSpacing`` properties containing the regular distance or spacing between value in this range
+- one (optional) ``rangeClosure`` properties containing the closure type (``c``,``o``,``oc``,``co``)
 - one ``<Default>`` node,
 - zero or more ``<Supported>`` nodes depending on the existence or the number of supported Units Of Measure (UOM), and 
@@ -159 +163 @@
    </LiteralData>
 
+
+A typical ``<LiteralData>`` node, defining a ``float`` data type which
+should take values contained in ``[0.0,100.0]``, looks like the following:
+.. code-block:: guess
+   :linenos:
+   
+   <LiteralData>
+     dataType = float
+     rangeMin = 0.0
+     rangeMax = 100.0
+     rangeClosure = c
+     <Default />
+   </LiteralData>
+
+A typical ``<LiteralData>`` node, defining a ``string`` data type which
+support values ``hillshade``, ``slope``, ``aspect``, ``TRI``, ``TPI``
+and ``roughness``, looks like the following:
+.. code-block:: guess
+   :linenos:
+   
+   <LiteralData>
+     dataType = float
+     AllowedValues = hillshade,slope,aspect,TRI,TPI,roughness
+     <Default />
+   </LiteralData>
+
+Properties``AllowedValues`` and ``range*`` can be conbined with both ``<Default>`` and
+``<Supported>`` nodes in the same ``<LiteralData>`` node.
+
 .. _BoundingBoxData: