ILiddingDriver interface : OnDelidMoveComplete method

OnDelidMoveComplete method
Description
VWorks software calls the OnDelidMoveComplete method to notify the plugin that a delid operation was executed. The plugin determines whether the lid was successfully removed and returns the results to VWorks software.
Syntax
 
HRESULT OnDelidMoveComplete(
[in] BSTR LiddingXML,
[out,retval] enum ReturnCode *retVal
);
Parameters
 
0 = The delid operation was executed successfully (the request was completed) (RETURN_SUCCESS)
1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS)
2 = The delid operation failed (the request was not completed) (RETURN_FAIL)
OnDelidMoveComplete method input
VWorks software passes a Command XML block into the LiddingXML parameter of the OnDelidMoveComplete method.
Command XML block
The Command XML block for the OnDelidMoveComplete method contains the Command element and all its children. This XML block describes the Delid task that caused the delid operation to occur.
When the plugin receives the Command XML block, it only needs to check the Name attribute of the Location parameter. This attribute is designated by bold text in the following XML structure and input example.
Although VWorks software passes other XML metadata in the Command XML block, this information is of no interest to the plugin.
XML structure
The value of the file attribute for the Velocity11 element is MetaData. See “Velocity11 element” .
 
<Command>
<Parameters>
<Parameter ... Name='Plate' ...>
<Ranges>
<Range />
...
</Ranges>
</Parameter>
<Parameter Name='Labware' ... />
<Parameter Name='ApproachOffset' ... />
<Parameter ... Name='Location' ... />
<Parameter ... Name='Teachpoint' ... />
</Parameters>
</Command>
Parameter element (Location)
The Location parameter specifies the name of the location where the labware is to be delidded. If a lid is present at the specified location after the delid operation is executed, the plugin notifies VWorks software that the operation was successful. If a lid is not present, the plugin notifies VWorks software that the delid operation was not successful. This Parameter element has the following attributes plus the Scriptable, Style, and Type attributes:
 
The value Location to use.
The value Location.
OnDelidMoveComplete method input
The following code is a Command XML block received by the plugin from VWorks software as a string in the LiddingXML parameter of the OnDelidMoveComplete method. VWorks software notifies the plugin that the specified delid operation was executed. To determine whether the delid move was successful, the plugin looks for a lid at the location named Stage.
 
<Command Compiler="128" Editor="14" Name="Delid" NextTaskToExecute="1"
PreferredTab="Plate Handling" RequiresRefresh="0" TaskRequiresLocation="1"
VisibleAvailability="1">
<Parameters>
<Parameter Description="Delidding method for BenchCel" Hide_if="Constant(1)"
Name="Delidding method" Scriptable="1" Style="0" Type="2"
Value="Delid and retract">
<Ranges>
<Range Value="Delid and retract" />
<Range Value="Delid to waste" />
</Ranges>
</Parameter>
<Parameter Name="Plate" Scriptable="1" Style="0" Type="5"
Value="process - 1 1" />
<Parameter Name="Labware" Scriptable="1" Style="0" Type="10"
Value="96 Costar 3894 PS Clr Rnd V Btm" />
<Parameter Description="Location to use" Name="Location" Scriptable="1"
Style="0" Type="6" Value="Stage" />
<Parameter Description="Teachpoint to use" Name="Teachpoint" Scriptable="1"
Style="0" Type="1" Value="robot teachpoint" />
</Parameters>
</Command>
Related information