GetLayoutBitmap method

VWorks software calls the GetLayoutBitmap method to get a dynamic bitmap from the plugin. The bitmap displays the specified labware and its location on a device.

The following figure shows a Configure Labware dialog box that contains the dynamic bitmap of a Bravo deck with two tip boxes and a tip trash.

Figure Configure Labware dialog box showing a dynamic bitmap

Syntax


HRESULT GetLayoutBitmap( [in] BSTR LayoutInfoXML, [out,retval] IPictureDisp **ppPicture );

Parameters


LayoutInfoXML	[in] A LayoutVector XML block containing the names and locations of the labware that VWorks software wants to represent on a device.
ppPicture	[out, retval] An IPictureDisp object that contains the handle to the bitmap for the image. The suggested size for this bitmap is 480 pixels by 320 pixels or smaller. Refer to the Microsoft SDK documentation for more details about the standard COM IPictureDisp interface at http://windowssdk.msdn.microsoft.com/en-us/library.

GetLayoutBitmap method input

VWorks software passes a LayoutVector XML block into the LayoutInfoXML parameter of the GetLayoutBitmap method.

LayoutVector XML block

The LayoutVector XML block contains the LayoutVector element and all its children. This XML block provides the names and locations of the specified labware. The plugin should parse the LayoutVector XML block and render a dynamic bitmap that shows the labware and its locations on the device.

XML structure

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


<?xml version='1.0' encoding='ASCII' ?> <Velocity11> <LayoutVector> <Layouts> <Layout /> ... </Layouts> </LayoutVector> </Velocity11>

LayoutVector element

The LayoutVector element contains one Layouts element.

Layouts element

The Layouts element contains one or more Layout elements.

Layout element

Each Layout element contains the type of a labware to show on the device and has the following attributes:


Name	Value
Labware	The labware type. If a labware is not configured at a location, this attribute is not specified.
Name	The name of the location on the device.

Example of GetLayoutBitmap method input

The following sample code is a LayoutVector XML block that is received by the plugin from VWorks software as a string in the LayoutInfoXML parameter of the GetLayoutBitmap method. VWorks software asks the plugin for a dynamic bitmap.

The plugin uses the information in the LayoutVector XML block to generate a dynamic bitmap that includes two labware at the locations named 1 and 2. No labware is present at locations 3 though 9, so the Labware attribute for these Layout elements is not specified.


<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='623442a0db37a6ec5c093d6666e9f1bd' version='1.0' > <LayoutVector > <Layouts > <Layout Labware='! Novartis 1536' Name='1' /> <Layout Labware='384 V11 Tip Box ST70 19133.002' Name='2' /> <Layout Name='3' /> <Layout Name='4' /> <Layout Name='5' /> <Layout Name='6' /> <Layout Name='7' /> <Layout Name='8' /> <Layout Name='9' /> </Layouts> </LayoutVector> </Velocity11>