AuxDevicesMgt (Object)

INTERFACE : DNBIAAuxDevicesMgt
DESCRIPTION This allows add/remove and get/set of aux devices for a robot


Methods


Sub DefineAuxDevices( iAuxDeviceObj, iAuxDeviceType)
Add a aux device to the robot.
Parameters:
iAuxDeviceObj
This parameter should be the device to add as aux device.
iAuxDeviceType
This parameter should be the type of aux device.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub GetAllAuxDevices( oAuxDeviceList)
Get all aux devices defined for the robot.
Parameters:
oAuxDeviceList
This outer parameter contains list of aux devices.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Func GetAuxDevices( iAuxDeviceNum) As
Get the aux device given the the index.
Parameters:
iAuxDeviceNum
This parameter should be the index of the aux device. Valid values are from 1 to nbAuxDevices.
oAuxDevice
This outer parameter contains aux device at the given index iAuxDeviceNum.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Func GetAuxDevicesType( iAuxDeviceNum) As
Get the aux device given the the index.
Parameters:
iAuxDeviceNum
This parameter should be the index of the aux device. Valid values are from 1 to nbAuxDevices.
oAuxDeviceType
This outer parameter contains aux device type for the aux device at the given index iAuxDeviceNum.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Func GetNbAuxDevices() As
Get the number of aux devices for the robot.
Parameters:
nbAuxDevices
This outer parameter contains the number of aux devices.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub RemoveAll()
Remove all the aux devices defined for the robot.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .
Sub RemoveAuxDevicesByPosition( iAuxDeviceNum)
Remove the aux device at the given index.
Parameters:
iAuxDeviceNum
This parameter should be the index of the aux device to be removed. Valid values are from 1 to nbAuxDevices.
Returns:
an HRESULT value.
Legal values:
  • S_OK if the operation succeeds
  • E_FAIL otherwise
  • .