pycatia.dnb_igp_setup_interfaces.device_task_factory

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_igp_setup_interfaces.device_task_factory.DeviceTaskFactory(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
DeviceTaskFactory

Represents the Task Creation Factory for Devices.

Role: Device Task Factory is the object used to create Device
tasks.
The following code snippet can be used to obtain the Device Task Factory from
the Device product.

Dim objDeviceTaskFactory As DeviceTaskFactory
Dim objDevice As Product
…
Set objDeviceTaskFactory = objDevice.GetTechnologicalObject(“DeviceTaskFactory” )
create_device_task(i_name: str, o_device_task: DeviceTask) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateDeviceTask(CATBSTR iName,
DeviceTask oDeviceTask)

Creates a Device Task

Parameters:

iName
The Device Task Name.
oDeviceTask
The Created Device Task.

Returns:
An HRESULT.
Legal values:

S_OK
The Device Task was successfully created.
E_FAIL
The Device Task creation failed.

Example:
The following example creates a Device task for a
Device.

Dim objDeviceTaskFactory As DeviceTaskFactory
Dim objDeviceTask as DeviceTask
..
objDeviceTaskFactory.CreateDeviceTask
“New_DeviceTask_1”,objDeviceTask
Parameters:
Return type:

None

delete_device_task(i_device_task: DeviceTask) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub DeleteDeviceTask(DeviceTask iDeviceTask)

Removes the required Device Task.

Parameters:

iDeviceTask
The Device Task to be Removed.

Returns:
An HRESULT.
Legal values:

S_OK
The Device Task could be successfully deleted.
E_FAIL
The deletion of Device Task failed.

Example:
The following example deletes a device task.

Dim objDeviceTaskFactory As DeviceTaskFactory
Dim objDeviceTask as DeviceTask
..
objRobotTaskFactory.DeleteDeviceTask
objDeviceTask
Parameters:

i_device_task (DeviceTask) –

Return type:

None

get_all_device_tasks(o_robot_task_list: tuple) → None

Note

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

Retrieves the list of Device tasks.

Parameters:

oDeviceTaskList
The Device Task List.

Returns:
An HRESULT.
Legal values:

S_OK
The Device Task List could be successfully
queried.
E_FAIL
The Device Task List could not be retrieved.

Example:
The following example Retrieves the list of Device Tasks for the
Device.

Dim objDeviceTaskFactory As DeviceTaskFactory
Dim objDeviceTask(3) as DeviceTask
..
objDeviceTaskFactory.GetAllDeviceTasks
objDeviceTask
Parameters:

o_robot_task_list (tuple) –

Return type:

None