VWorks Software User Guide : Creating a protocol: advanced topics : InventoryLabware object
InventoryLabware object
About the InventoryLabware object
The VWorks JavaScript interpreter provides an InventoryLabware object that can be accessed by a script. InventoryLabware represents an individual labware in the inventory database. By passing InventoryLabware objects to plateDB methods in a JavaScript, you can manage specific labware in the inventory. To see an example of this implementation, see the importLabwareToInventory method example in plateDB object.
Properties
Syntax:
InventoryLabware.property
 
Property
Data type
Description
name
String
Name of the labware.
device
String
Name of the device.
*The device name must match the name in the device file. Be sure to include any spaces, underscores, dashes, and capitalization in the name.
cassette
Integer
Cassette number.
slot
Integer
Slot number.
type
String
Name of labware entry in the Labware Editor.
westbc
String
Barcode on the west side of the labware.
eastbc
String
Barcode on the east side of the labware.
southbc
String
Barcode on the south side of the labware.
northbc
String
Barcode on the north side of the labware.
status
String
Status of the labware:
0—OK
1—Error
2—Invalid
3—Barcode misread
You can set or get the status of the labware. When you add the labware information to the database using the importLabwareToInventory plateDB method, you can set the labware status. When you retrieve labware information using the getLocationByBarcode plateDB method, you can get the labware status.
plategroup
String
Plate group to which the labware belongs.
locationgroup
String
Location group to which the labware belongs.
Methods
Methods are JavaScript functions invoked through an object. The InventoryLabware object has the following methods, available on systems that have the inventory database option. Use these methods to track labware-specific data.
Syntax:
InventoryLabware.method( )
 
Method
Description
nextPlateGroupName( )
Returns the name of the next plate group.
A labware can belong to multiple plate groups. Use this method to determine all the plate groups to which a labware belongs.
nextLocationGroupName( )
Returns the name of the next location group.
A labware can belong to multiple location groups. Use this method to determine all the locations groups to which a labware belongs.
Related information
 
For information about...
See...
Using JavaScript in the VWorks software
Using JavaScript
VWorks-defined functions
VWorks-defined functions
Other VWorks-defined objects
Using JavaScript utilities
Using JavaScript utilities
JavaScript task
JavaScript
Startup and cleanup protocols
Setting up Startup and Cleanup Protocol processes