AGSi Standard / Data¶
agsiDataParameterValue¶
Object description¶
Each agsiDataParameterValue objects provides the data for a single defined parameter. The parameter value conveyed may be numeric, a profile of numeric values (e.g. a design line) or text. Refer to Data general rules and conventions for further details.
The parent object of agsiDataParameterValue is agsiDataPropertySet
agsiDataParameterValue has associations (reference links) with the following objects:
agsiDataParameterValue has the following attributes:
Attributes¶
codeID¶
Code that identifies the parameter. 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: UndrainedShearStrength
caseID¶
Code (or text) that identifies the use case for a parameter. For example, different values of the same parameter may be defined corresponding to different design/analysis methods. May also be used to define sets of parameters for sensitivity analyses. If the input is a code, this should be defined in the agsiDataCase object. May be left blank, but the combination of codeID and caseID should be unique for each agsiDataParameter Value object.
Type: string (reference to caseID of agsiDataCase object, or text)
Example: EC7Pile
valueNumeric¶
Numeric value of parameter, if applicable.
Type: number
Condition: Recommended
Example: 75
valueText¶
Text based value of parameter, if applicable. For a profile (see below), this could be used for a concise description or representation of the profile. Unless specified otherwise, this attribute should only be used when the value is not numeric, i.e. valueNumeric not used.
Type: string
Example: 100 + 6z (z=0 @ +6.0mOD)
valueProfileIndVarCodeID¶
Code that identifies the independent variable for a profile, i.e. what the parameter value varies against. Codes should be defined in either the agsiDataCode object, or in the code dictionary defined in the agsiData object. Refer to General /Data input formats for further information.
Type: string (reference to codeID of agsiDataCode object, or code dictionary)
Condition: Recommended
Example: Elevation
valueProfile¶
The profile of values as an ordered list of tuples of [independent variable value, parameter value]. Typically used to represent design lines. Refer to General /Data input formats for further information.
Type: array (profile)
Condition: Recommended
Example: [[6,100],[-24,280]]
remarks¶
Additional remarks, if required
Type: string