sample

Lexicon: eco.wonderland.workcell.device.data.defs
Type: object

Abstract dataItem that is continuously changing or analog data value. This data can be measured at any point-in-time and will always produce a value.

Properties

category

Type: category
Default: sample
Required

compositionId

Type: string

Identifier attribute of the composition that the reported data is most closely associated.

discrete

Type: boolean
Required

Indication signifying whether each value reported for the Observation is significant and whether duplicate values are to be suppressed. If a value is not defined for discrete, the default value MUST be false.

id

Type: string
Required

Unique identifier for this data item.

name

Type: string

Name of the data item.

nativeScale

Type: int32

Used to convert the reported value to represent the original measured value.

nativeUnits

Type: nativeUnit

Native units of measurement for the reported value of the data item.

sampleRate

Type: binary32

Rate at which successive samples of a data item are recorded by a piece of equipment.

significantDigits

Type: int32

Number of significant digits in the reported value.

statistic

Type: statistic

Type of statistical calculation performed on a series of data samples to provide the reported data value.

subType

Type: dataItemSubType

Sub-categorization of the type.

type

Type: sample
Required

units

Type: unit
Required

representation

Type: representation

Description of a means to interpret data consisting of multiple data points or samples reported as a single value. If representation is not specified, it MUST be determined to be value.

source

Type: source

constraints

Type: constraints

filters

Type: [ filter | minimumDeltaFilter | periodFilter ]

initialValue

Type: initialValue

resetTrigger

Type: resetTrigger

definition

Type: definition

coordinateSystemIdRef

Type: string

Associated coordinateSystem context for the dataItem.

relationships

Type: [ abstractDataItemRelationship | dataItemRelationship | specificationRelationship ]

Referenced By

• dataItems eco.wonderland.workcell.device.data.defs

Schema

{
  "type": "object",
  "required": [
    "category",
    "discrete",
    "id",
    "type",
    "units"
  ],
  "properties": {
    "category": {
      "type": "string",
      "default": "sample"
    },
    "compositionId": {
      "type": "string"
    },
    "discrete": {
      "type": "boolean"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "nativeScale": {
      "type": "integer"
    },
    "nativeUnits": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#nativeUnit"
    },
    "sampleRate": {
      "type": "bytes",
      "minLength": 4,
      "maxLength": 4
    },
    "significantDigits": {
      "type": "integer"
    },
    "statistic": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#statistic"
    },
    "subType": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#dataItemSubType"
    },
    "type": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#sample"
    },
    "units": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#unit"
    },
    "representation": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.common.data.defs#representation"
    },
    "source": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.data.property.defs#source"
    },
    "constraints": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.data.property.defs#constraints"
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "union",
        "refs": [
          "lex:eco.wonderland.workcell.device.data.property.defs#filter",
          "lex:eco.wonderland.workcell.device.data.property.defs#minimumDeltaFilter",
          "lex:eco.wonderland.workcell.device.data.property.defs#periodFilter"
        ]
      }
    },
    "initialValue": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.data.property.defs#initialValue"
    },
    "resetTrigger": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.data.property.defs#resetTrigger"
    },
    "definition": {
      "type": "ref",
      "ref": "lex:eco.wonderland.workcell.device.data.property.defs#definition"
    },
    "coordinateSystemIdRef": {
      "type": "string"
    },
    "relationships": {
      "type": "array",
      "items": {
        "type": "union",
        "refs": [
          "lex:eco.wonderland.workcell.device.data.property.relationship.defs#abstractDataItemRelationship",
          "lex:eco.wonderland.workcell.device.data.property.relationship.defs#dataItemRelationship",
          "lex:eco.wonderland.workcell.device.data.property.relationship.defs#specificationRelationship"
        ]
      }
    }
  }
}