LiquidTransferComplete method

Event

A liquid-transfer process is finished.

Description

VWorks software calls the LiquidTransferComplete method after a liquid-transfer process is finished. VWorks software provides information about both the source and destination labware in the input parameters of this method.

The plugin can use the LiquidTransferComplete method to keep a liquid management system updated on the locations of compounds in the system, in real time.

Syntax

 

HRESULT LiquidTransferComplete( [in] BSTR SourcePlateInfoXML, [in] BSTR DestinationPlateInfoXML, [in, out] BSTR* pResultXML );

Parameters

 

SourcePlateInfoXML	[in] A LiquidTransferComplete XML element containing information about the source labware that was involved in the liquid-transfer process.
DestinationPlateInfoXML	[in] A LiquidTransferComplete XML element containing information about the destination labware that was involved in the liquid-transfer process.
pResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

SourcePlateInfoXML and DestinationPlateInfoXML parameters

VWorks software passes a LiquidTransferComplete XML element into the following parameters of the LiquidTransferComplete method:

•	SourcePlateInfoXML for the source labware

•	DestinationPlateInfoXML for the destination labware

This XML element provides information about the labware that was involved in the liquid-transfer process.

LiquidTransferComplete element

The LiquidTransferComplete element has the following attributes.

Note: Where an attribute name is prepended by a lowercase letter, i=integer, f=float, and s=string.

 

Name	Value
Path	The name of the protocol that generated the event. If the protocol has been saved, the value of this attribute is the protocol’s file path. If the protocol has not been saved, the value is the default protocol name.
fVolume	The volume, in microliters.
iColumn	The column of the well in the labware in which the liquid-transfer process occurred (1‑based).
sQuadrant	The set quadrant, which depends on the microplate-to-labware mapping (1, 1–4, or 1–16). Note: Refer to the VWorks Automation Control User Guide for more information about quadrant patterns.
iRow	The row of the well on the microplate in which the liquid-transfer process occurred (1-based).
sDevice	The name of the destination device.
sPlate	The labware name.
sTimestamp	The date and time of the liquid-transfer process, in the following format: m/d/yyyy - H:M:S.MS AM(PM) where m = month (1–12) d = day (1–31) yyyy = year (1980–2099) H = hour (1–12) M = minutes (0–59) S = seconds (0–59) MS = milliseconds (0–59)
sWellDescription	The description of the well.
sNorthSideBarcode	The barcode if it is located on the north side of the microplate, or else the value No bar code.
sSouthSideBarcode	The barcode if it is located on the south side of the microplate, or else the value No bar code.
sEastSideBarcode	The barcode if it is located on the east side of the microplate, or else the value No bar code.
sWestSideBarcode	The barcode if it is located on the west side of the microplate, or else the value No bar code.

Example of LiquidTransferComplete method input for the source microplate

The following sample code is a LiquidTransferComplete XML element that is received by the plugin from VWorks software as a string in the SourcePlateInfoXML parameter of the LiquidTransferComplete method. VWorks software tells the plugin that a liquid-transfer process is finished on the source microplate named process ‑ 1 1.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='87c92b22402e34a7bdd7ab7ff0c39147' version='1.0' > <LiquidTransferComplete Path='C:\V11\V11 Files\Protocols\Hooks reference test.pro' fVolume='10' iColumn='1' iQuadrant='1' iRow='1' sDevice='Bravo - 1' sEastSideBarcode='No bar code' sNorthSideBarcode='No bar code' sPlate='process - 1 1' sSouthSideBarcode='No bar code' sTimestamp='2010-4-7 21:27:35' sWellDescription='Quadrant 1' sWestSideBarcode='No bar code' /> </Velocity11>

Example of LiquidTransferComplete method input for the destination microplate

The following sample code is a LiquidTransferComplete XML element that is received from VWorks software by the plugin as a string in the DestinationPlateInfoXML parameter of the LiquidTransferComplete method. VWorks software tells the plugin that a liquid-transfer process is finished on the destination microplate named process ‑ 2 1.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='3f1102a46cf0727053bd6273b867c66c' version='1.0' > <LiquidTransferComplete Path='C:\V11\V11 Files\Protocols\Hooks reference test.pro' fVolume='10' iColumn='1' iQuadrant='1' iRow='1' sDevice='Bravo - 1' sEastSideBarcode='No bar code' sNorthSideBarcode='No bar code' sPlate='process - 2 1' sSouthSideBarcode='No bar code' sTimestamp='2010-4-7 21:27:37' sWellDescription='Quadrant 1' sWestSideBarcode='No bar code' /> </Velocity11>

LiquidTransferComplete method output

The plugin returns a HookResults XML block in the pResultXML parameter of the LiquidTransferComplete method. For information about the structure and contents of this XML block, see “HookResults XML block” .

Example of LiquidTransferComplete method output

The following sample code is a HookResults XML block that is returned to VWorks software by the plugin as a string in the sResultXML parameter of the LiquidTransferComplete method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

The liquid-transfer process is finished.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' →ResultValue='The liquid-transfer process is finished.' /> </Results> </HookResults> </Velocity11>

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”