UnitIDPhases2

The
UnitIDPhases2
 item returns a list of all the phases within the unit specified by the Unit ID, including whether or not there is an associated control strategy.
This table shows the input and output formats for this item.
Input Format
Request:
UnitIDPhases2
UnitID
is
ASCII - Integer, the
unique Equipment ID corresponding to the unit.
Output Format
The UnitIDPhases2 item returns in this format:
<PhaseList2>
is
<Phase2>
\crlf |
<Phase2>
\crlf
<PhaseList2>
<Phase2>
is
<PhaseID>
\t
<PhaseName>
\t
<MaxOwners>
\t
<PhaseType>
\t
<XCord>
\t
<YCord>
\t
<BitMapIndex>
where <Phase2> is:
Field Name
Format
Description
<PhaseID>
ASCII - Integer
Phase’s resource ID.
<PhaseName>
ASCII - String
Phase name.
<MaxOwners>
ASCII - Integer
Max number of owners.
<PhaseType>
ASCII – Integer
Type of phase:
  • 0 = No Control Strategy
  • 1 = Control Strategy
<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 the bitmap in the List of Phase Bitmap items.
This table shows an example of the return on this request.
Example:
A request on
object
.
GetItem(55Phases2)
could return:
68 \t NP_ADDDAIRY_M1 \t 1 \t 2 \t 95 \t 88 \t 1 \crlf
70 \t NP_ADDEGG_M1 \t 1 \t 2 \t 362 \t 89 \t 2 \crlf
72 \t NP_HEAT_M1 \t 1 \t 0 \t 343 \t 182 \t 3 \crlf
71 \t NP_AGITATE_M1 \t 1 \t 0 \t 235 \t 183 \t 4 \crlf
73 \t NP_XFR_OUT_M1 \t 1 \t 0 \t 233 \t 362 \t 5 \crlf
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal