AGSi Standard / Data¶
agsiDataPropertyValue¶
Object description¶
Each agsiDataPropertyValue object provides the data for a single defined property. The property data conveyed may be a simple statistical summary, a text based summary or a profile of data points. Refer to Data general rules and conventions for further details.
The parent object of agsiDataPropertyValue is agsiDataPropertySet
agsiDataPropertyValue has associations (reference links) with the following objects:
agsiDataPropertyValue has the following attributes:
- codeID
- caseID
- valueMin
- valueMax
- valueMean
- valueStdDev
- valueCount
- valueText
- valueProfileIndVarCodeID
- valueProfile
- remarks
Attributes¶
codeID¶
Code that identifies the property. Codes should be defined in either the agsiDataCode object, or in the code dictionary defined in the agsiData object.
Type: string (reference to codeID of agsiDataCode object, or code dictionary)
Condition: Required
Example: TRIG_CU
caseID¶
Code that identifies a specific usage or subdivision of the property. For example, an alternative statistical summary that excludes outliers. If the input is a code, this shall be defined in the agsiDataCase object. May be left blank, but the combination of codeID and caseID should be unique for each agsiDataProperty Value object.
Type: string (reference to caseID of agsiDataCase object, or text)
Example: ExclOutlier
valueMin¶
Minimum value
Type: number
Condition: Recommended
Example: 78
valueMax¶
Maximum value
Type: number
Condition: Recommended
Example: 345
valueMean¶
Mean value
Type: number
Example: 178.2
valueStdDev¶
Standard deviation
Type: number
Example: 36.4
valueCount¶
Number of results
Type: number
Condition: Recommended
Example: 58
valueText¶
Alternative text based summary, if required or preferred. May be needed when limiting values are not numeric (<0.001) or could be used to provide a list of results for very small data sets.
Type: string
Example: <0.01 to 12.57, mean 3.21, (16 results)
valueProfileIndVarCodeID¶
Code that identifies the independent variable for a profile, i.e. what the property value varies against. Codes should be defined in either the agsiDataCode object, or in the code dictionary defined in the agsiData object.
Type: string (reference to codeID of agsiDataCode object, or code dictionary)
Condition: Recommended
Example: Elevation
valueProfile¶
A profile of values as an ordered list of tuples of [independent variable value, parameter value]. Refer to General /Data input formats for further information.
Type: array (profile)
Condition: Recommended
Example: [[15.5,60],[14.0,75],[12.5,105]]
remarks¶
Additional remarks, if required
Type: string