8.2.1 Property Kind
|For Standard||RESQML v2.0.1|
Property kinds carry the semantics of the list of values. They are used to identify if the values are, for example, representing porosity, length, stress tensor, etc. RESQML includes a list of standard property names that represent the basis for the commonly used properties in the E&P subsurface workflow.
RESQML has these property kinds:
- RESQML "well-known" kinds. A finite list of well-known kinds (for example, length, volume, and permeability). During a RESQML-enabled data exchange, each property kind MUST be derived (either directly or indirectly) from the names listed in the RESQML property kind enumerations, which are included in the properties package (ResqmlPropertyKind). This enumeration has been generated from the ResqmlPropertyKind enumList contained in the enumValuesResqml.xml file located in the energyml\data\resqmlv2\v2.0.1\ancillary folder of the XML schemas. In this XML file, you can find out deprecated information about the RESQML "well-known" kinds" such as the respective representative units of measure of these property kinds. NOTE: This information should not be used in any validation process because it may contradict the quantity class information provided by the schema.
Use of well-known kinds allows programmers implementing RESQML to map their software property names to the RESQML standard property software names, which makes it possible for RESQML-enabled software to translate property names between each other.
For example, if Software A names “porosity” as POR and Software B names it PORO, and both A and B are RESQML enabled, then the software can recognize that these properties are equivalent because they refer to the same RESQML parent property, e.g., "porosity". They can also exchange without ambiguity the numerical values that are recorded because those values will be in the same unit of measure.
- Company- or user-specific kinds. Companies or organizations may specify their own property kinds. When specifying your own property kinds, you MUST observe these conventions:
- The user-specified name must always be based on another property kind, well-known or not (e.g., a custom kind may be based on another custom kind, which is ultimately based on a well-known kind).
- To identify the company or group that defines the property kind, a naming system must be used. For example, urn:resqml:mycompany.com:myproduct
- A reference unit must be provided and requires the associated property value units to be compatible through conversion.
- All of this information must be explicitly defined in the files being transferred.