PlateTransferAborted method

Description

VWorks software calls the PlateTransferAborted method to notify the plugin that a labware-transfer process was aborted. This is typically due to a robot malfunction followed by user intervention, that is, when the user clicks the Abort button in the standard error dialog box.

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 PlateTransferAborted( [in] BSTR PlateInfoXML );

Parameter

 

PlateInfoXML

[in] A Plates XML block containing information about the labware that was involved in the aborted labware-transfer process.

PlateTransferAborted method input

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

Plates XML block

The Plates XML block contains the Plates element and all its 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 /> </Plates>

XML elements and attributes

See “Plates XML block components” .

Example of PlateTransferAborted method input (with Mount task)

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 PlateTransferAborted method. VWorks software tells the plugin that the labware named process ‑ 1 was involved in the aborted labware-transfer process 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...
Abort method	“Abort method”
MakeLocationAvailable method	“MakeLocationAvailable method”
PlateDroppedOff method	“PlateDroppedOff method”
PlatePickedUp method	“PlatePickedUp method”