PlatePickedUp method

Description

VWorks software calls the PlatePickedUp method to notify the plugin that a labware was picked up at the location specified in the previous call to the MakeLocationAvailable method. (See “MakeLocationAvailable method” .) A call to the PlatePickedUp method also provides information about the labware that was picked up. VWorks software calls this method when the device’s location is the source of a labware transfer, which includes robot transfers and configured labware.

IMPORTANT After VWorks software calls the MakeLocationAvailable method, it always calls the PlateDroppedOff, PlatePickedUp, or PlateTransferAborted method before making any other calls to the plugin. See “PlateDroppedOff method” , “PlatePickedUp method” , “PlateTransferAborted method” .

Syntax

 

HRESULT PlatePickedUp( [in] BSTR PlateInfoXML, [out,retval] enum ReturnCode *retVal );

Parameters

 

PlateInfoXML	[in] A Plates XML block containing information about the labware that was picked up.
retVal	[out, retval] Returns an error code. Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL) For more information, see “ReturnCode enumerated type” .

PlatePickedUp method input

VWorks software passes a Plates XML block into the PlateInfoXML parameter of the PlatePickedUp method.

Plates XML block

The Plates XML block contains the Plates element and its all children. This XML block provides information about labware that are used in methods involving labware-handling processes.

XML structure

The Plates XML block does not contain a Velocity11 element.

Note: The MountedBy element is only present if the labware was involved in a Mount task.

 

<?xml version='1.0' encoding='ASCII' ?> <Plates> <Plate /> <Mountby /> </Plate> </Plates>

XML elements and attributes

See “Plates XML block components” .

Example of PlatePickedUp method input

The following sample code is a Plates XML block that is received by the plugin from VWorks software as a string in the PlateInfoXML parameter of the PlatePickedUp method. VWorks software tells the plugin that the labware named process ‑ 1 was picked up at the location named Location and that the labware was involved in a Mount task with the labware named process ‑ 3.

Note: The MountedBy element is only present if the labware was involved in a Mount task.

 

<?xml version='1.0' encoding='ASCII' ?> <Plates file='PlateInfo' md5sum='1791ea89c01d01a460f8f38626207de9' version='1.0' > <Plate Instance_Number='1' Labware='1536 Greiner 782076 blk sqr well flt btm' →Location='Location' Name='process - 1' Not_Really_Moving_The_Plate='0' →Plate_Has_Lid='0' Simulating='0'> <MountedBy Instance_Number='1' Labware='1536 Black Greiner' Name='process - 3' →Plate_Has_Lid='0' /> </Plate> </Plates>

Related information

 

For information about...	See...
GetErrorInfo method	“GetErrorInfo method”
MakeLocationAvailable method	“MakeLocationAvailable method”
PlateDroppedOff method	“PlateDroppedOff method”
PlateTransferAborted method	“PlateTransferAborted method”
ReturnCode enumerated type	“ReturnCode enumerated type”