IWorksController methods overview

Use the following table to quickly locate an IWorksController method by name or by description.

 

Method	Description
“NotifyDataChanged method”	Notifies VWorks software that the user changed a property in the diagnostics dialog box.
“NotifyTipOperation method”	Notifies VWorks software that the user performed a pipette-tip task using the diagnostics dialog box for a device that uses pipette tips.
“OnCloseDiagsDialog method”	Notifies VWorks software that the plugin’s diagnostics dialog box was closed.
“PrintToLog method”	Tells VWorks software to print the specified string to the Main Log.
“Query method”	Requests information from VWorks software or requests information from another plugin, using VWorks software as the intermediary.
Query method categories
“AllDeviceInfo query/response”	Gets all device names and device types in the device file.
“Barcode query/response”	Gets all barcodes on the labware at the specified location.
“DeviceLocationTeachpoints query/response”	Gets all locations on all devices for which the robot has teachpoints.
“GetDeviceName query/response”	Gets the device name for the plugin in VWorks software.
“GetIOManagerPointInput query/response”	Gets the value of the specified digital input signal.
“GetJavascriptVariable query/response”	Gets the value of the specified JavaScript variable.
“GetProductInfo query/response”	Gets the name and version of VWorks software that is currently running.
“GetRunSetStatus query/response”	Gets information about all the protocol runs listed in the Runset Manager.
“InterPlugin query/response”	Gets information from a destination plugin, using VWorks software as the intermediary. Note: This query is only used for interplugin communication.
“Labware query/response”	Gets the labware entry for the specified labware type.
“LocationInformation query/response”	Gets the name of the static labware at the specified location. If the location is a stack location, gets the allowable stack height.
“LocationToTeachpoints query/response”	Gets all teachpoints that have been set at the specified location.
“PlateVolume query/response”	Gets the current volume of all the wells in the labware at the specified location.
“ScanBarcode query/response”	Determines whether a barcode scanner should be used to scan the barcode on the specified side of the labware at the specified location.
“SystemPlateInformation query/response”	Gets the labware type for the specified labware.
“TeachpointInformation query/response”	Gets the coordinates of the specified teachpoint for the specified robot from the destination plugin. Note: The source plugin can also get this information using the InterPlugin query.
“Update method”	Returns information to VWorks software, tells VWorks software to perform certain actions, or both.
Update method categories
“AsyncTaskFinished update”	Tells VWorks software that an asynchronous task is completed.
“AsyncTaskStarted update”	Tells VWorks software that an asynchronous task is started.
“Barcode update”	Tells VWorks software to update the barcode on the specified side of the labware at the specified location.
“ErrorAbortRetryIgnoreNonBlocking update”	When an error occurs during an asynchronous task, tells VWorks software to trigger task error handling.
“InventoryPlateBarcodes update”	Returns the results of the labware inventory, which was requested by VWorks software with a call to the IStorageDriver QueryStorageLocations method. See “QueryStorageLocations method” .
“LiquidTransferComplete update”	Tells VWorks software that a liquid transfer is completed.
“RackInfo update”	Tells VWorks software how many mismatches occurred during a rack check.
“RunScript update”	Tells VWorks software to execute an arbitrary JavaScript script.
“RunsetAdd update”	Tells VWorks software to schedule the specified protocol run in the Runset Manager.
“SetIOManagerPointDigitalOutput update”	Tells VWorks software to output the specified value on the specified digital output channel.
“Volume update”	Returns the volume change of one or more wells in the labware at the specified location to VWorks software.