GetSimulationTimes method

Description

VWorks software calls the GetSimulationTimes method to get the average simulation robot movement times for the Slow, Medium, and Fast speed settings from the plugin.

Syntax

 

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

Parameters

 

XML	[in] An empty IRobotDriver_GetSimulationTimes_Input XML element.
returnedXML	[out] An IRobotDriver_GetSimulationTimes_Output XML element that contains the average simulation robot movement times for the Slow, Medium, and Fast speed settings.
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” .

GetSimulationTimes method input

VWorks software passes an empty IRobotDriver_GetSimulationTimes_Input XML element into the XML parameter of the GetSimulationTimes method.

Example of GetSimulationTimes method input

The following sample code contains an empty IRobotDriver_GetSimulationTimes_Input XML element that is received by the plugin from VWorks software as a string in the XML parameter of the GetSimulationTimes method. VWorks software asks the plugin for the average simulation robot speeds for the 3-Axis Robot’s Slow, Medium, and Fast settings.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='8ea81b7f4630630c501aa89f152db68c' version='1.0' > <IRobotDriver_GetSimulationTimes_Input /> </Velocity11>

IRobotDriver_GetSimulationTimes_Output XML element

The plugin returns an IRobotDriver_GetSimulationTimes_Output XML element in the returnedXML parameter of the GetSimulationTimes method. This XML element provides the average simulation robot movement times for the Slow, Medium, and Fast speed settings.

IRobotDriver_GetSimulationTimes_Output element

The IRobotDriver_GetSimulationTimes_Output element has the following attributes:

 

Name	Value
AverageFastMoveTime	The average simulation robot movement time for the Fast speed setting, in seconds. Required: No Default value: 0
AverageMediumMoveTime	The average simulation robot movement time for the Medium speed setting, in seconds. Required: No Default value: 0
AverageSlowMoveTime	The average simulation robot movement time for the Slow speed setting, in seconds. Required: No Default value: 0

Example of GetSimulationTimes method output

The following sample code contains an IRobotDriver_GetSimulationTimes_Output XML element that is returned to VWorks software by the plugin as a string in the returnedXML parameter of the GetSimulationTimes method. The plugin returns the average simulation speeds for the 3-Axis Robot to VWorks software.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='5d148b5a5eec9af40e5b4df77c90988d' version='1.0' > <IRobotDriver_GetSimulationTimes_Output AverageFastMoveTime='4' →AverageMediumMoveTime='6' AverageSlowMoveTime='8' /> </Velocity11>

Related information

 

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