Device

Supertype: Component

Definition: Component composed of a piece of equipment that produces observationsobserved value of a property at a point in time. about itself.

Version Info

Introduced	Deprecated	Updated
1.0

Documentation

Description

A Device organizesact of containing and owning one or more elements. its parts as Component entities.

A Device MUST have a name and uuid attribute to identify itself.

A Device MUST have the following DataItems: Availability, AssetChanged, and AssetRemoved.

See Components for more details on the properties of Device.

See Section Part Properties of Device for a list of top levelelement that represents the most significant physical or logical functions of a piece of equipment. Component types for a Device.

Inherited Properties

Name	Type	Int	Dep	Multiplicity	Description
`id`	`ID`	1.0		1	unique identifier for the `Component`.
`name`	`string`	1.0		0..1	name of the `Component`. When provided, `name` MUST be unique for all child `Component` entities of a parent `Component`.
`nativeName`	`string`	1.1		0..1	common name associated with `Component`.
`sampleInterval`	`float`	1.2		0..1	interval in milliseconds between the completion of the reading of the data associated with the `Component` until the beginning of the next sampling of that data. This information may be used by client software applications to understand how often information from a `Component` is expected to be refreshed. The refresh rate for data from all child `Component` entities will be the same as for the parent `Component` element unless specifically overridden by another `sampleInterval` provided for the child `Component`.
~~`sampleRate`~~	`float`	1.0	1.2	0..1	DEPRECATED in MTConnect Version 1.2. Replaced by `sampleInterval,Component`.
`uuid`	`ID`	1.0		0..1	universally unique identifier for the `Component`.
`coordinateSystemIdRef`	`ID`	1.8		0..1	specifies the `CoordinateSystem` for this `Component` and its children.

Inherited Relations

Name	Type	Int	Multiplicity
`hasDescription`	`Description`	1.0	0..1
`hasComposition`	`Composition`	1.4	0..*
`hasComponent`	`Component`	1.0	0..*
`hasConfiguration`	`Configuration`	1.2	0..1
`observes`	`DataItem`	1.0	0..*
`madeObservation`	`Observation`	1.0	0..*
`hasReference`	`Reference`	1.3	0..*
`hasComponentStream`	`ComponentStream`	1.0	0..1
`isComponentOf`	`Component`	1.0	0..*

Properties

Name	Type	Int	Dep	Multiplicity	Description
~~`iso841Class`~~	`string`	1.0	1.2	0..1	DEPRECATED in MTConnect Version 1.2.
`uuid`	`ID`	1.0		1	universally unique identifier for the element.
`mtconnectVersion`	`string`	1.7		0..1	MTConnect version of the Device Information Modelinformation model that describes the physical and logical configuration for a piece of equipment and the data that may be reported by that equipment. used to configure the information to be published for a piece of equipment in an MTConnect Response Documentresponse document published by an MTConnect Agent..
`name`	`string`	1.0		1	name of an element or a piece of equipment.
`hash`	`string`	2.2		0..1	condensed message digest from a secure one-way hash function. FIPS PUB 180-4

Relations

Name	Type	Int	Multiplicity	Description
`hasAuxiliary`	`Auxiliary`	1.4	0..*	(through `Auxiliaries`)
`hasController`	`Controller`	2.0	0..*	(through `Controllers`)
`hasInterface`	`Interface`	1.3	0..*	(through `Interfaces`)
`hasResource`	`Resource`	1.4	0..*	(through `Resources`)
`hasStructure`	`Structure`	1.7	0..*	(through `Structures`)
`hasSystem`	`System`	1.1	0..*	(through `Systems`)
`hasAxis`	`Axis`	1.0	0..*	(through `Axes`)
`hasAdapter`	`Adapter`	1.7	0..*	(through `Adapters`)
`observesAvailability`	`Availability`	1.1	1
`observesAssetChanged`	`AssetChanged`	1.2	1
`observesAssetRemoved`	`AssetRemoved`	1.3	1
`isDeviceOf`	`MTConnectDevices`	1.0	1..*

Constraints

Error Message OCL Expression

Error Message	OCL Expression
All `Device` entities MUST have `DataItem` of `type`s `AVAILABILITY`, `ASSET_CHANGED` and `ASSET_REMOVED`.	Components::Devices::Device::allInstances()->iterate(device;devicecount:Real=0\| if device.observes->size() >= 3 then if device.observes->iterate(av;avail:Real=0\|if av.oclAsType(DataItems::"DataItem Types"::Event).type = DataTypes::EventEnum::AVAILABILITY then avail+1 else avail+0 endif) = 1 then if device.observes->iterate(ac;assetc:Real=0\|if ac.oclAsType(DataItems::"DataItem Types"::Event).type = DataTypes::EventEnum::ASSET_CHANGED then assetc+1 else assetc+0 endif) = 1 then if device.observes->iterate(ar;assetr:Real=0\|if ar.oclAsType(DataItems::"DataItem Types"::Event).type = DataTypes::EventEnum::ASSET_REMOVED then assetr+1 else assetr+0 endif) = 1 then devicecount + 1 else devicecount + 0 endif else devicecount + 0 endif else devicecount + 0 endif else devicecount + 0 endif) = hasDevice->size()
`Device` MUST have at least one of `Component`, `DataItem` or `Reference` entities.	`Components::Devices::Device::allInstances()->iterate(device;devicecount:Real=0\| if device.id->size() = 1 and device.name->size() = 1 and device.uuid->size() = 1 and (device.observes->size() > 0 or device.hasReference->size() > 0 or device.hasComponent->size() > 0) then devicecount + 1 else devicecount + 0 endif ) = Components::Devices::Device::allInstances()->size()`

All Device entities MUST have DataItem of types AVAILABILITY, ASSET_CHANGED and ASSET_REMOVED.

Components::Devices::Device::allInstances()->iterate(device;devicecount:Real=0|
if device.observes->size() >= 3
then 
    if device.observes->iterate(av;avail:Real=0|if av.oclAsType(DataItems::"DataItem Types"::Event).type = DataTypes::EventEnum::AVAILABILITY then avail+1 else avail+0 endif) = 1
    then if device.observes->iterate(ac;assetc:Real=0|if ac.oclAsType(DataItems::"DataItem Types"::Event).type = DataTypes::EventEnum::ASSET_CHANGED then assetc+1 else assetc+0 endif) = 1
        then if device.observes->iterate(ar;assetr:Real=0|if ar.oclAsType(DataItems::"DataItem Types"::Event).type = DataTypes::EventEnum::ASSET_REMOVED then assetr+1 else assetr+0 endif) = 1
            then devicecount + 1
            else devicecount + 0
            endif
        else devicecount + 0
        endif
    else devicecount + 0
    endif
else devicecount + 0
endif) = hasDevice->size()

Device MUST have at least one of Component, DataItem or Reference entities.

Components::Devices::Device::allInstances()->iterate(device;devicecount:Real=0|
if device.id->size() = 1 and 
    device.name->size() = 1 and
    device.uuid->size() = 1 and
    (device.observes->size() > 0 or device.hasReference->size() > 0 or device.hasComponent->size() > 0) 
then
    devicecount + 1
else
    devicecount + 0
endif
) = Components::Devices::Device::allInstances()->size()

Subclasses

Name	Int	Dep
`Agent`	1.7
`MTConnect Device with Operational States`
`MTConnect Device with Part Tracking`

Submit Comment