ResourcesList

The
ResourcesList
 item returns a list of all resources and their corresponding equipment IDs.
TIP:
For large resource lists, use the
ResourcesListX
 data item. Using the
ResourcesList
 item for large area models may cause performance issues.
This table shows the input and output formats for this item.
Input Format
Request:
ResourcesList
Output Format
The ResourcesList item returns in this format:
<ResourcesList>
is
<Resource>
|
<Resource> <ResourcesList>
<Resource>
is
<ResourceID>
\t
<ResourceName>
\t
<ResourceType>
\t
<ArbMask>
\crlf
where <Resource> is:
Field Name
Format
Description
<ResourceID>
ASCII - Integer
Unique equipment ID for a resource.
<ResourceName>
ASCII - String
Name of the resource. (Process Cells, Units and Shared Resources are included in this list.)
<ResourceType>
ASCII - Integer
Type of the resource:
  • 1: Process Cell
  • 2: Unit
  • 3: Phase
  • 4: Resource
  • 5: Procedure
<ArbMask>
Encoded String
Arbitration masks
This table shows an example of the return on this request.
Example:
A request on
object.GetItem(ResourcesList)
could return:
-1138 \t 17:MCLS_FRENCHVANILLA\MCLS_TRANSFER_OUT_UP:1\MCLS_TRANSFER_OUT_OP:1 \t 5 \t 0 \crlf
-1137 \t 17:MCLS_FRENCHVANILLA\MCLS_TRANSFER_OUT_UP:1 \t 5 \t 0 \crlf
-1136 \t 17:MCLS_FRENCHVANILLA\MCLS_TRANSFER_IN_UP:1\MCLS_TRANSFER_IN_OP:1 \t 5 \t 0 \crlf
...
119 \t FV101 \t 4 \t 1 \crlf
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal