muPart
Syntax
<Path>.muPart[(Index:integer:= 1)] → object |
The method muPart accesses all MUs located on the object designated by <Path> as a whole or in part.
Parameter
When you enter the optional parameter Index of data type integer, Plant Simulation accesses the MU designated by the parameter of data type integer. When you do not enter a parameter, Plant Simulation accesses the first muPart available.
Example: The MUs A, B, C, D, E, and F are located on the length-oriented objects Line1, Line2, and Line3.
The booking points of all MUs are located at their front end. The return values for muPart are listed in this table:
Call | Returns |
|---|---|
line1.MUPart(1) | MU A |
line1.MUPart(2) | VOID |
line2.MUPart(1) | MU D |
line2.MUPart(2) | MU C |
line2.MUPart(3) | MU B |
line2.MUPart(4) | MU A |
line2.MUPart(5) | VOID |
Default Value
The default value is 1, meaning the first MU.
Return Value
The return value has the data type object.
If no muPart is located on the object or if the muPart called does not exist, the method returns VOID.
Example
line1.muPart(1) -- returns VOID |
Related Topics