pycatia.dnb_igp_setup_interfaces.device_task

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.DeviceTask(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
DMAPSInterfaces.Activity
DeviceTask

Represents the Device Task.

Role: The interface is used manage activities under a Device
Task.
The following code snippet can be used to obtain the Device Task from a Device
Task Factory.

Dim objDeviceTaskFactory As DeviceTaskFactory
Dim objDevice As Product
…
Set objDeviceTaskFactory = objDevice.GetTechnologicalObject(“DeviceTaskFactory” )
Dim objDeviceTaskList(3) as DeviceTask
Dim objDeviceTask as DeviceTask
objDeviceTaskFactory.GetAllDeviceTasks objDeviceTaskList
objDeviceTask=objDeviceTaskList[0]



The Device Task can also be obtained from an activity of the type
DeviceTask.

Dim objActivity as Activity
…
Dim objDeviceTask as DeviceTask
Set objDeviceTask = objActivity.GetTechnologicalObject(“DeviceTask” )
create_delay_activity(isp_father: AnyObject, position: int, delay_time: float, o_delay_acty: Activity) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateDelayActivity(AnyObject ispFather,
short position,
double delay_time,
Activity oDelayActy)

Creates a Delay Activity inside a Device Task

Parameters:

ispFather
The Activity preceeding the new activity.
position
Whether to insert activity before or after father. 0 tells at the
start and 1 means after
delay_time
The input delay time value to be set.
oDelayActy
The created Delay Activity

Returns:
An HRESULT.
Legal values:

S_OK
The Delay Activity was successfully created.
E_FAIL
The Delay Activity could not be created.

Example:
The following example creates An Delay Activity under a given
device task

Dim objDeviceTask as DeviceTask
Dim objPreceedingActy as Activity
..
Dim objDelayAct as Object
objDeviceTask.CreateDelayActivity
objPreceedingActy,1,objDelayAct
Parameters:

  • isp_father (AnyObject) –

  • position (int) –

  • delay_time (float) –

  • o_delay_acty (Activity) –

Return type:

None

create_move_home_activity(isp_father: AnyObject, position: int, o_move_home_acty: Activity) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateMoveHomeActivity(AnyObject ispFather,
short position,
Activity oMoveHomeActy)

Creates a MoveHome Activity inside a Device Task

Parameters:

ispFather
The Activity preceeding the new activity.
position
Whether to insert activity before or after father. 0 tells at the
start and 1 means after
oMoveHomeActy
The created MoveHome Activity

Returns:
An HRESULT.
Legal values:

S_OK
The MoveHome Activity was successfully created.
E_FAIL
The MoveHome Activity could not be created.

Example:
The following example creates An MoveHome Activity under a given
device task

Dim objDeviceTask as DeviceTask
Dim objPreceedingActy as Activity
..
Dim objMovHomeAct as Object
objDeviceTask.CreateMoveHomeActivity
objPreceedingActy,1,objMovHomeAct
Parameters:
Return type:

None

create_move_joints_activity(isp_father: AnyObject, position: int, o_move_joints_acty: Activity) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateMoveJointsActivity(AnyObject ispFather,
short position,
Activity oMoveJointsActy)

Creates a MoveJoints Activity inside a Device Task

Parameters:

ispFather
The Activity preceeding the new activity.
position
Whether to insert activity before or after father. 0 tells at the
start and 1 means after
oMoveJointsActy
The created MoveJoints Activity

Returns:
An HRESULT.
Legal values:

S_OK
The MoveJoints Activity was successfully created.
E_FAIL
The MoveJoints Activity could not be created.

Example:
The following example creates An MoveJoints Activity under a given
device task

Dim objDeviceTask as DeviceTask
Dim objPreceedingActy as Activity
..
Dim objMovJointsAct as Object
objDeviceTask.CreateMoveJointsActivity
objPreceedingActy,1,objMovJointsAct
Parameters:
Return type:

None