Sample

Supertype: Observation

Definition: Observation that is continuously changing or analog data value.

Version Info

IntroducedDeprecatedUpdated
1.0  

Documentation

Description

It provides the information and data reported from a piece of equipment for those DataItem entities defined with DataItem::category as SAMPLE in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..

Sample MUST always be reported in float.

Figure Sample Example shows Sample type examples. It also shows an example for when the Observation::result is not available (dataItemId=cspeed).

Sample Example

Note: See sample-example for the XML representation of the same example.

The following Section Value Properties of Sample lists the additional and/or updated attributes for Sample.

Inherited Properties

NameTypeIntDepMultiplicityDescription
compositionId ID1.40..1 identifier of the Composition entity defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request. associated with the data reported for the Observation.
dataItemId ID1.01

unique identifier of the DataItem associated with this Observation.

Observation::dataItemId MUST match the associated DataItem::id defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..

name string1.00..1

name of the DataItem associated with this Observation.

Observation::name MUST match the associated DataItem::name defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..

sequence integer1.01

number representing the sequential position of an occurrence of an observationobserved value of a property at a point in time. in the data buffer of an agentsoftware that collects data published from one or more piece(s) of equipment, organizes that data in a structured manner, and responds to requests for data from client software systems by providing a structured response in the form of a response document that is constructed using the semantic data model of a Standard. .

Observation::sequence MUST have a value represented as an unsigned 64-bit value from 1 to \(2^{64}-1\).

subType DataItemSubTypeEnum1.20..1

subtype of the DataItem associated with this Observation.

Observation::subType MUST match the associated DataItem::subType defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..

timestamp datetime1.01 most accurate time available to a piece of equipment that represents the point in time that the data reported was measured.
type DataItemTypeEnum1.01

type of the DataItem associated with this Observation.

Observation::type MUST match the associated DataItem::type defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..

units UnitEnum1.00..1

units of the DataItem associated with this Observation.

Observation::units MUST match the associated DataItem::units defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..

isUnavailable boolean (Default: true)1.01

when true, Observation::result is indeterminate.

Note 1 to entry: In XML, when isUnavailable is true, the XML CDATA of the Observation MUST be UNAVAILABLE. ```xml

<Execution dataItemId=”…” …>UNAVAILABLE</Execution>


> Note 2 to entry: In *JSON*, when `isUnavailable` is `true`, the *JSON* `value` of the `Observation` **MUST** be `UNAVAILABLE`.
```json
  "Execution" : [ { "dataItemId": "..." ..., "value": "UNAVAILABLE" } ]
result string1.00..1

observationobserved value of a property at a point in time. of the Observation entity.

The default value type for Observation::result is string.

Note 1 to entry: in XML the Observation::result is the CDATA of the Observation elementconstituent part or a basic unit of identifiable and definable data..

<Execution dataItemId="..." ...>READY</Execution>

Note 2 to entry: in JSON the Observation::result is the member value of the Observation object.

"Execution" : [ { "dataItemId": "..." ..., "value": "READY" } ]

Inherited Relations

NameTypeIntDepMultiplicityDescription
isObservationOf Component1.00..*
isObservationOf Agent1.00..*
isObservationOf DataItem1.00..*

Properties

NameTypeIntDepMultiplicityDescription
duration SECOND1.20..1

time-period over which the data was collected.

Sample::duration MUST be provided when the DataItem::statistic is defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..

resetTriggered ResetTriggeredEnum1.40..1

identifies when a reported value has been reset and what has caused that reset to occur for those DataItem entities that may be periodically reset to an initial value.

resetTriggered MUST only be provided for the specific occurrence of a DataItem reported in the MTConnectStreams Response Documentresponse document published by an MTConnect Agent in response to a current request or a sample request. when the reset occurred.

sampleRate float1.20..1

rate at which successive samples of the value are recorded.

statistic StatisticEnum1.20..1 type of statistical calculation defined by the DataItem::statistic defined in the MTConnectDevices Response Documentresponse document published by an MTConnect Agent in response to a probe request..
result float1.00..1
units UnitEnum1.01
type SampleEnum1.01

Subclasses

NameIntDep
Acceleration1.0 
AccumulatedTime1.2 
Amperage1.01.6
AmperageAC1.6 
AmperageDC1.6 
Angle1.0 
AngularAcceleration1.0 
AngularDeceleration1.7 
AngularVelocity1.0 
AssetUpdateRate1.7 
AxisFeedrate1.0 
BatteryCapacity2.1 
BatteryCharge2.1 
CapacityFluid1.5 
CapacitySpatial1.5 
ChargeRate2.1 
Concentration1.2 
Conductivity1.2 
CuttingSpeed1.5 
Deceleration1.7 
Density1.5 
DepositionAccelerationVolumetric1.5 
DepositionDensity1.5 
DepositionMass1.5 
DepositionRateVolumetric1.5 
DepositionVolume1.5 
DewPoint2.1 
Diameter1.6 
DischargeRate2.1 
Displacement1.0 
DisplacementAngular2.1 
DisplacementLinear2.1 
ElectricalEnergy1.2 
EquipmentTimer1.4 
FillHeight2.5 
FillLevel1.2 
Flow1.2 
FollowingError2.1 
FollowingErrorAngular2.1 
FollowingErrorLinear2.1 
Frequency1.0 
GlobalPosition1.01.1
GravitationalAcceleration2.1 
GravitationalForce2.1 
HumidityAbsolute1.6 
HumidityRelative1.6 
HumiditySpecific1.6 
Length1.3 
Level1.11.2
LinearForce1.2 
Load1.0 
Mass1.2 
ObservationUpdateRate1.7 
Openness2.0 
Orientation1.6 
PH1.1 
ParticleCount2.5 
ParticleSize2.5 
PathFeedrate1.0 
PathFeedratePerRevolution1.5 
PathPosition1.1 
Position1.0 
PositionCartesian2.1 
PowerFactor1.2 
Pressure1.0 
PressureAbsolute1.7 
PressurizationRate1.7 
ProcessTimer1.4 
Resistance1.2 
Resistivity2.5 
RotaryVelocity1.2 
SettlingError2.1 
SettlingErrorAngular2.1 
SettlingErrorLinear2.1 
SoundLevel1.2 
SpindleSpeed1.01.2
Strain1.2 
Temperature1.0 
Temperature  
Tension1.4 
Tilt1.2 
Torque1.0 
Velocity1.0 
Viscosity1.2 
VoltAmpere1.2 
VoltAmpereReactive1.2 
Voltage1.01.6
VoltageAC1.6 
VoltageDC1.6 
VolumeFluid1.5 
VolumeSpatial1.5 
WaterHardness2.7 
Wattage1.0 
XDimension1.6 
YDimension1.6 
ZDimension1.6 

Back to top

Copyright © 2017-2026 Association for Manufacturing Technology (AMT). All rights reserved. MTConnect® is a trademark of AMT. Terms of Use.

MTConnect SysML Model V2.7