Setup Center mit Setup Center Interface - 第25页

SIPLACE 3 Application program interface (API) description Ausgabe 05/2007 25 Refill 3 Refill packaging unit(s) in online verification. 3 Parameters 3 packagingUnitLocations 3 Packaging unit(s) to refill. 3 Remarks 3 The …

100%1 / 44
3 Application program interface (API) description SIPLACE
Ausgabe 05/2007
24
3.1.6.2 Interface methods in detail
GetReducedActualSetup 3
Method delivers the actual physical setup filtered by the target setup for the specified machine. 3
3
3
Method delivers the actual physical setup filtered by the target setup for the specified machine. 3
3
Parameters 3
strMachineId 3
The machine to consider. 3
Return Value 3
The actual setup of the specified machine. 3
Exceptions 3
Exceptions will not be thrown by this interface, as the underlying software doesn’t resolve excep-
tions by error codes. In addition, it’s yet not designed to throw exception lists of different exception
types. 3
Instead of exceptions, messages like errors, warnings etc. will be published by the event Messa-
gesReceived (see below). 3
SIPLACE 3 Application program interface (API) description
Ausgabe 05/2007
25
Refill 3
Refill packaging unit(s) in online verification. 3
Parameters 3
packagingUnitLocations 3
Packaging unit(s) to refill. 3
Remarks 3
The call of “Set” (“Refill” on an empty track) has initializing behavior on the station. This means,
that any existing value (e.g. splice information) is lost after execution. 3
Exceptions 3
Exceptions will not be thrown by this interface, as the underlying software doesn’t resolve excep-
tions by error codes. In addition, it’s yet not designed to throw exception lists of different exception
types. 3
Instead of exceptions, errors, warnings etc. will be published by the event MessagesReceived
(see below). 3
Set 3
Put packaging unit(s) in online verification. 3
3
Parameters 3
packagingUnitLocations 3
Packaging unit(s) to set. 3
Remarks 3
The call of “Set” (“Refill” on an empty track) has initializing behavior on the station. This means,
that any existing value (e.g. splice information) is lost after execution. 3
Exceptions 3
Exceptions will not be thrown by this interface, as the underlying software doesn’t resolve excep-
tions by error codes. In addition, it’s yet not designed to throw exception lists of different exception
types. 3
Instead of exceptions, errors, warnings etc. will be published by the event MessagesReceived
(see below). 3
3
3
3 Application program interface (API) description SIPLACE
Ausgabe 05/2007
26
TearDown 3
Tear down the specified packaging unit(s) within the mentioned setup. 3
3
Parameters 3
strSetup 3
The related setup full path. 3
packagingUnitLocations 3
Packaging unit(s) to tear down. 3
Exceptions 3
Exceptions will not be thrown by this interface, as the underlying software doesn’t resolve excep-
tions by error codes. In addition, it’s yet not designed to throw exception lists of different exception
types. 3
Instead of exceptions, errors, warnings etc. will be published by the event MessagesReceived
(see below). 3
Update 3
Adjust the total quantity of packaging unit(s). 3
3
Parameters 3
packagingUnits 3
Packaging unit(s), which already contain the designated total quantity. 3
Return Value 3
The list of successful updated packaging unit(s) (first packaging unit of the splice chain). Other-
wise null, if operation was aborted because of a null reference. Packaging units, which couldn't be
updated, are not in this list. 3
Remarks 3
If the packaging unit is in use, the packaging unit won't be updated. Only the quantity of the pak-
kaging unit is updated. All other members keep unchanged. All errors which occurred during exe-
cution can be get MessagesReceived-event. 3
3