Skip to content
Cloud APIs
/
/
/
Frame of Reference Meta D...

Frame of Reference Meta Data Item (FoR of File)

A meta data item, which allows the association of named properties or property values to a Unit/Measurement/CRS/Azimuth/Time context.

kindstring(Reference Kind)required

The kind of reference, unit, measurement, CRS or azimuth reference.

Enum:"CRS""Unit""Measurement""AzimuthReference""DateTime"
namestring(Name or Symbol)

The name of the CRS or the symbol/name of the unit

Example:"[\"NAD27 * OGP-Usa Conus / North Dakota South [32021,15851]\",\"ft\"]"
persistableReferencestring(Persistable Reference)required

The persistable reference string uniquely identifying the CRS or Unit

Example:"{\"scaleOffset\":{\"scale\":0.3048006096012192,\"offset\":0.0},\"symbol\":\"ftUS\",\"baseMeasurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"ty
propertyNamesArray of strings(Attribute Names)

The list of property names, to which this meta data item provides Unit/CRS context to. Data structures, which come in a single frame of reference, can register the property name, others require a full path like "data.structureA.propertyB" to define a unique context.

Example:
[
  "elevationFromMsl",
  "\"totalDepthMdDriller",
  "wellHeadProjected"
]
propertyValuesArray of strings(Attribute Names)

The list of property values, to which this meta data item provides Unit/CRS context to. Typically a unit symbol is a value to a data structure; this symbol is then registered in this propertyValues array and the persistableReference provides the absolute reference.

Example:
[
  "F",
  "ftUS",
  "deg"
]
uncertaintynumber(Uncertainty)

The uncertainty of the values measured given the unit or CRS unit.

<property name>objectadditional property
{
  "kind": "CRS",
  "name": "[\"NAD27 * OGP-Usa Conus / North Dakota South [32021,15851]\",\"ft\"]",
  "persistableReference": "{\"scaleOffset\":{\"scale\":0.3048006096012192,\"offset\":0.0},\"symbol\":\"ftUS\",\"baseMeasurement\":{\"ancestry\":\"Length\",\"type\":\"UM\"},\"type\":\"USO\"}",
  "propertyNames": [
    "elevationFromMsl",
    "\"totalDepthMdDriller",
    "wellHeadProjected"
  ],
  "propertyValues": [
    "F",
    "ftUS",
    "deg"
  ],
  "uncertainty": 0,
  "property1": {},
  "property2": {}
}