NotifyTipOperation method

Description

The plugin calls the NotifyTipOperation method to tell VWorks software that the user performed a pipette-tip task using the diagnostics dialog box of a device that uses pipette tips. VWorks software can use this information to track pipette-tip usage.

Syntax

 

HRESULT NotifyTipOperation( [in] IControllerClient *Source, [in] BSTR TipOperationXML );

Parameters

 

Source	[in] The plugin’s pointer to itself.
TipOperationXML	[in] A DiagnosticsTipOperation XML block that contains information about the specified pipette-tip task involving the specified labware type at the specified location.

NotifyTipOperation method input

VWorks software sends a DiagnosticsTipOperation XML block in the Source parameter of the NotifyTipOperation method.

DiagnosticsTipOperation XML block

The DiagnosticsTipOperation XML block contains the DiagnosticsTipOperation element and all its children. This XML block provides information about the specified pipette-tip task involving the specified labware type at the specified location.

XML structure

The value of the file attribute for the Velocity11 element is MetaData. See “Velocity11 element” .

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11> <DiagnosticsTipOperation> <WellSelection> <PipetteHeadMode /> <Wells> <Well /> ... </Wells> </WellSelection> </DiagnosticsTipOperation> </Velocity11>

DiagnosticsTipOperation element

The DiagnosticsTipOperation element contains one WellSelection element and has the following attributes:

 

Name	Value
Labware	The type of the labware involved in the pipette-tip task. Required: Yes
Location	The name of the location where the pipette-tip task occurred. Required: Yes
Operation	Represents the type of the pipette-tip task. Possible values: 0 = Tips On 1 = Tips Off Required: No Default value: 1

WellSelection element

See “WellSelection element” .

PipetteHeadMode element

See “PipetteHeadMode element” .

Wells element

See “Wells element” .

Well element

See “Well element” .

Example of NotifyTipOperation method output

The following sample code is a DiagnosticsTipOperation XML block that is sent by the plugin to VWorks software as a string in the TipOperationXML parameter of the NotifyTipOperation method. The plugin returns information about a pipette-tip task involving a labware of type 384 V11 Tip Box ST70 19133.002 at the location named 7.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='ede80c89e21ca65d4296dfd86c7cd69e' version='1.0' > <DiagnosticsTipOperation Labware='384 V11 Tip Box ST70 19133.002' Location='7' →Operation='0' > <WellSelection CanBe16QuadrantPattern='0' CanBeLinked='0' →CanBeQuadrantPattern='0' IsLinked='0' IsQuadrantPattern='0' OnlyOneSelection='0' →OverwriteHeadMode='0' QuadrantPattern='0' StartingQuadrant='1' →LinkedText='From hit pick task' > <PipetteHeadMode Channels='1' ColumnCount='24' RowCount='16' SubsetConfig='0' →SubsetType='0' TipType='0' /> <Wells> <Well Column='0' Row='0' /> </Wells> </WellSelection> </DiagnosticsTipOperation> </Velocity11>

Related information

 

For information about...	See...
IControllerClient interface	“IControllerClient interface”