pycatia.dnb_robot_interfaces.aux_devices_mgt

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.dnb_robot_interfaces.aux_devices_mgt.AuxDevicesMgt(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

AuxDevicesMgt

INTERFACE : DNBIAAuxDevicesMgt

DESCRIPTION This allows add/remove and get/set of aux devices for a

robot

define_aux_devices(i_aux_device_obj: AnyObject, i_aux_device_type: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub DefineAuxDevices(AnyObject iAuxDeviceObj,

DNBAuxilliaryDeviceType 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

Parameters:

• i_aux_device_obj (AnyObject) –

• i_aux_device_type (int) – enum dnb_auxilliary_device_type

Return type:

None

get_all_aux_devices(o_aux_device_list: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetAllAuxDevices(CATSafeArrayVariant 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

Parameters:

o_aux_device_list (tuple) –

Return type:

None

get_aux_devices(i_aux_device_num: int) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetAuxDevices(long iAuxDeviceNum) As AnyObject

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

Parameters:

i_aux_device_num (int) –

Return type:

AnyObject

get_aux_devices_type(i_aux_device_num: int) → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetAuxDevicesType(long iAuxDeviceNum) As

DNBAuxilliaryDeviceType

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

Parameters:

i_aux_device_num (int) –

Returns:

enum dnb_auxilliary_device_type

Return type:

int

get_nb_aux_devices() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetNbAuxDevices() As long

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

Return type:

int

remove_all() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o 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

Return type:

None

remove_aux_devices_by_position(i_aux_device_num: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub RemoveAuxDevicesByPosition(long 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

Parameters:

i_aux_device_num (int) –

Return type:

None