pycatia.dnb_device_interfaces.basic_device

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_device_interfaces.basic_device.BasicDevice(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
BasicDevice

Interface representing a Basic Device.

Role: This interface is used to interact with devices that are available in the
Device Building workbench. This includes devices created in both V5 and
D5.
The following code snippet can be used to obtain a device in a CATProduct
document.

Dim objDevice As BasicDevice
set objDevice = CATIA.ActiveDocument.Product.GetTechnologicalObject(“BasicDevice”)
get_dof_values(o_values: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetDOFValues(CATSafeArrayVariant oValues)

Get the DOF values for the device.

Parameters:

oValues
This contains a list of the current DOF values. Please note that
distances are measured in meters and angles in radians.

Example:

Dim objDevice As BasicDevice
set objDevice = CATIA.ActiveDocument.Product.GetTechnologicalObject(“BasicDevice”)
Dim ListOfDOFValues ()
objDevice.GetDOFValues ListOfDOFValues
For i = 0 to ubound (ListOfDOFValues)
…
Next
Parameters:

o_values (tuple) –

Return type:

None

get_home_positions(o_home_pos_list: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetHomePositions(CATSafeArrayVariant oHomePosList)

Get list of home positions of the device.

Parameters:

oHomePosList
This outer parameter contains list of home position .

Returns:
An HRESULT
Parameters:

o_home_pos_list (tuple) –

Return type:

None

set_home_position(i_name: str, idb_trans: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetHomePosition(CATBSTR iName,
CATSafeArrayVariant idbTrans)

Set home position of the device.

Parameters:

iName
This parameter contains name of home position .
idbTrans
This parameter contains distance data in Meters or angular data in
degree radian.

Returns:
HRESULT indicate whether function succeed.
Parameters:

  • i_name (str) –

  • idb_trans (tuple) –

Return type:

None