SetSpeed method

Description

VWorks software calls the SetSpeed method to tell the plugin to set the specified robot-speed setting to a new value.

Syntax

 

HRESULT SetSpeed( [in] BSTR XML, [out] BSTR *returnedXML, [out,retval] enum ReturnCode *retVal );

Parameters

 

XML	[in] An IRobotDriver_SetSpeed_Input XML element that contains the name of the robot-speed settings and their new values.
returnedXML	[out] An empty IRobotDriver_SetSpeed_Output XML element.
retVal	[out, retval] Returns an error code. Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL) For more information, see “ReturnCode enumerated type” .

SetSpeed method input

VWorks software passes an IRobotDriver_SetSpeed_Input XML element into the XML parameter of the SetSpeed method. This XML element provides name of the robot-speed settings and their new values.

IRobotDriver_SetSpeed_Input element

The IRobotDriver_SetSpeed_Input element has the following attributes:

 

Name	Value
EmptyPayloadSpeedType	The speed at which the robot can run when the gripper is not carrying any labware. The labware speed settings are ignored. This attribute is used when Always run at “robot speed” when gripper is empty is selected in the Options dialog box. Possible values: 0 = Slow 1 = Medium 2 = Fast
Type	Represents the robot-speed setting. Possible values: 0 = Slow 1 = Medium 2 = Fast

Example of SetSpeed method input

The following sample code contains an IRobotDriver_SetSpeed_Input XML element that is received by the plugin from VWorks software as a string in the XML parameter of the SetSpeed method. VWorks software tells the plugin to set the Fast robot-speed setting to the new value of 2.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='79363f4956846adf751f115dbe5e52b2' version='1.0' > <IRobotDriver_SetSpeed_Input EmptyPayloadSpeedType='2' Type='2' /> </Velocity11>

SetSpeed method output

The plugin returns an empty IRobotDriver_SetSpeed_Output XML element in the returnedXML parameter of the SetSpeed method.

Example of SetSpeed method output

The following sample code is an empty IRobotDriver_SetSpeed_Output XML element that is returned by the plugin to VWorks software as a string in the returnedXML parameter of the SetSpeed method.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='6c51256d736d242e7f2388a2ff95086f' version='1.0' > <IRobotDriver_SetSpeed_Output /> </Velocity11>

Related information

 

For information about...	See...
CheckPlatePresent method	“CheckPlatePresent method”
DelidRelid method	“DelidRelid method”
GetPlatePresentResult method	“GetPlatePresentResult method”
GetSimulationTimes method	“GetSimulationTimes method”
GetTeachPoints method	“GetTeachPoints method”
Move method	“Move method”
ReturnCode enumerated type	“ReturnCode enumerated type”