[ResourceID] ResourceDataX

The
[ResourceID]ResourceDataX
 item is a set of items that correspond on a one-to-one basis with the ResourceIndexData entries (ID & Type attributes) exposed in the
ResourcesListX
 data item. The
[ResourceID]ResourceDataX
 data item returns the ID, name, type, and arbitration mask (ArbMask) of a single resource.
Example Input of [ResourceID]ResourceDataX:
object.GetItem([ResourceID]ResourceDataX)
Output of [ResourceID]ResourceDataX:
<ResourceDataX>
<ResourceData>
</ResourceDataX>
where ResourceData is:
<ResourceDataX ID="Value" Type="Value" Name="Value" ArbMask="Value" />
where
:
ID (integer) – A unique equipment ID for a resource. Resource IDs can also be zero or negative. Zero is reserved for the operator object and negative IDs are used for recipe procedures.
Type (positive integer) =
  • 1 = Process Cell
  • 2 = Unit
  • 3 = Phase
  • 4 = Resource
  • 5 = Procedure
  • 7 = Operation Sequence
Name (string) – The name of the resource
ArbMask (nonNegativeInteger) – The arbitration mask is used as a bitmask, with each bit indicating whether a specific command is valid or invalid.
A client request to retrieve the value of a
[ResourceID]ResourceDataX
 item could return:
<ResourceDataX ID="42" Name="Reactor1007" Type="3" ArbMask="6" />
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal