Superclass (is-a): Event

InterfaceState

Definition: operational state of an «abstract» Interface.

When the InterfaceState is DISABLED, the state of all data items that are specific for the interaction modelmodel that defines how information is exchanged across an interface to enable interactions between independent systems. associated with that «abstract» Interface MUST be set to NOT_READY.

Version Info

Introduced	Deprecated	Updated
1.3

Inherited from `Event`

Properties

Name	Type	Int	Multiplicity	Description
`compositionId`	`ID`	1.4	0..1	identifier of the «abstract» `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`	`ID`	1.0	1	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`	`string`	1.0	0..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`	`integer`	1.0	1	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`	`DataItemSubTypeEnum`	1.2	0..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`	`datetime`	1.0	1	most accurate time available to a piece of equipment that represents the point in time that the data reported was measured.
`type`	«abstract» `DataItemTypeEnum`	1.0	1	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`	`UnitEnum`	1.0	0..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.0	1	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`	`string`	1.0	0..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" } ]`
`quality`	`QualityEnum` (Default: `UNVERIFIABLE`)	2.5	0..1	indicates if the `Observation` is verifiable and is in accordance with the normative definitions within the MTConnect Standard.
`deprecated`	`boolean` (Default: `false`)	2.5	0..1	indicates if the `Observation` has any property or controlled vocabulary that has been deprecated in the MTConnect Standard.
`extended`	`boolean` (Default: `false`)	2.5	0..1	indicates if the `Observation` has any property or controlled vocabulary that has been extended and cannot be validated.
`resetTriggered`	`ResetTriggeredEnum`	1.4	0..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.
`type`	`EventEnum`	1.0	1

Properties

Name	Type	Int	Dep	Multiplicity	Description
`type`	`InterfaceEventEnum` (Only: `INTERFACE_STATE`)	1.3		1
`result`	`InterfaceStateEnum`	1.3		0..1