UnitIDPhases

The
UnitIDPhases
item returns a list of all the phases within the unit specified by the unit ID.
This table shows the input and output formats for this item.
Input and output formats
Format
Description
Input Format
Request:
UnitIDPhases
UnitID
is
An ASCII - Integer representing the
unique equipment ID corresponding to the unit.
Output Format
The UnitIDPhases item returns in this format:
<PhaseList>
is
<Phase>
\crlf
<Phase>
\crlf
<PhaseList>
<Phase>
is
<PhaseID>
\t
<PhaseName>
\t
<MaxOwners>
\t
<XCord>
\t
<Ycord>
\t
<BitMapIndex>
where <
Phase
> is:
Field Name
Format
Description
<PhaseID>
ASCII - Integer
Phase’s resource ID.
<PhaseName>
ASCII - String
Phase name.
<MaxOwners>
ASCII - Integer
Maximum number of owners.
<XCord>
ASCII - Integer
X coordinate for the bitmap in the Equipment View
<YCord>
ASCII - Integer
Y coordinate for the bitmap in the Equipment View.
<BitMapIndex>
ASCII - Integer
Location of bitmap in the List of Phase Bitmap items.
This is an example of the return on this request.
A request on
object
.
GetItem(55Phases)
returns:
68 \t NP_ADDDAIRY_M1 \t 1 \t 95 \t 88 \t 1 \crlf
70 \t NP_ADDEGG_M1 \t 1 \t 362 \t 89 \t 2 \crlf
72 \t NP_HEAT_M1 \t 1 \t 343 \t 182 \t 3 \crlf
71 \t NP_AGITATE_M1 \t 1 \t 235 \t 183 \t 4 \crlf
73 \t NP_XFR_OUT_M1 \t 1 \t 233 \t 362 \t 5 \crlf
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal