CAP Methods
CAP methods get information about rotational or AEM CAPs in the library. The methods can open, close, lock, unlock, or set the owner of a CAP.
What is a capHandle?
The capHandle identifes a sepcific CAP within the library. Use the handle to reserve the CAP before sending any of the CAP operational methods (open, close, and so on).
Use setCapOwner() to acquire a capHandle and reserve the CAP. Even if the CAP is dedicated to a partition, you must use setCapOwner() to acquire a capHandle.
closeCap()
Closes an open CAP. Equivalent to pressing the button on an open CAP.
Once a CAP is closed, the library audits the CAP cells and adds the cartridges to the partition that owns the CAP. The library moves any cleaning cartridges to system cells.
Used by WWOPs.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
C1,S1,I |
WebServiceException |
freeCap()
Removes partition ownership of the CAP.
The CAP must be locked and empty. An application should free a shared CAP after completing CAP operations so that the CAP is available for other partitions. This method has no effect on CAPs in a dedicated CAP pool.
Used by ACSLS.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
C1,S1,I |
WebServiceException |
getCap()
Returns information about a specific CAP.
Used by ACSLS.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
All |
WebServiceException |
getCapPool()
Returns the CAPs in the CAP pool.
Used by STA and ACSLS.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
All |
WebServiceException |
getCaps()
Returns information about all CAPs in the library complex.
Used by STA and ACSLS.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
None |
List of CapDto |
All |
WebServiceException |
getCapStatistics()
Returns CAP telemetry data.
Used by WWOPs.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
S1,I |
WebServiceException |
lockCap()
Logically locks a CAP.
While in the locked state, the library disables all means of opening the CAP, allowing the robot to safely access the CAP. To lock a CAP, it must be closed, online, and owned by a non-SCSI partition.
Used by ACSLS and WWOPs.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
C1,S1,I |
WebServiceException |
openCap()
Opens an unlocked CAP. Equivalent to pressing the button on a closed CAP.
Used by WWOPs.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
C1,S1,I |
WebServiceException |
setCapOwner()
Assigns ownership of a CAP to a specific partition and provides a capHandle. A partition must own a CAP to export or import cartridges with the CAP.
Note:
Even if the CAP is dedicated to a partition, you must use setCapOwner() to acquire a capHandle.Any moves to or from a CAP not owned by the partition will fail. A partition can only own CAPs in the CAP pool assigned to the partition. If a CAP pool is assigned to only one partition, the partition automatically owns the CAPs in that pool. setCapOwner() returns capHandle, which you can use as input on operations that require an owned CAP.
Used by ACSLS.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
long
|
long
|
C1,S1,I |
WebServiceException |
unlockCap()
Unlocks a CAP so that an operator can open it.
When unlocked, the robot cannot access the CAP cells. To unlock a CAP, it must be closed, online, owned by a partition (or controlled by the UI), and not currently in use by the robot.
Used by ACSLS and WWOPs.
| Inputs | Outputs | Roles | Errors |
|---|---|---|---|
|
long
|
C1,S1,I |
WebServiceException |