pycatia.dnb_igp_setup_interfaces.call_robot_task_activity

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.call_robot_task_activity.CallRobotTaskActivity(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
CallRobotTaskActivity

Interface representing a CallRobotTaskActivity.

Role: This interface is used to analyze the CallRobotTask
activity
The following code snippet can be used to obtain a CallRobotTaskActivity from a
selected Activity

Dim oSelectAct As Activity
Set oSelectAct = CATIA.ActiveDocument.Selection.FindObject(“CATIAActivity”)
Dim objCallRobotTaskAct As CallRobotTaskActivity
Set objCallRobotTaskAct = oSelectAct.GetTechnologicalObject(“CallRobotTaskActivity”)
get_pointed_task_name(o_robot_task_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetPointedTaskName(CATBSTR oRobotTaskName)

Gets the name of the Pointed RobotTask.

Parameters:

oRobotTaskName
The name of the RobotTask being pointed.

Returns:
An HRESULT.
Legal values:

S_OK
The pointed RobotTask name is retrieve
successfully.
E_FAIL
Unable to retrieve the pointed RobotTask name.

Example:
The following example shows how to retrieve the pointed
RobotTask

Dim objCallRobotTaskActy as
CallRobotTaskActivity
…
Dim strTaskName as String
objCallRobotTaskActy.GetPointedTaskName
strTaskName
Parameters:

o_robot_task_name (str) –

Return type:

None

get_task(o_robot_task: Activity) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetTask(Activity oRobotTask)

Gets the Pointed RobotTask.

Parameters:

oRobotTask
The RobotTask pointed by this Activity.

Returns:
An HRESULT.
Legal values:

S_OK
The RobotTask is retrieve successfully.
E_FAIL
Unable to retrieve the RobotTask.

Example:
The following example shows how to retrieve the pointed
RobotTask

Dim objCallRobotTaskActy as
CallRobotTaskActivity
…
Dim objPointedTask as RobotTask
objCallRobotTaskActy.GetTask objPointedTask
Parameters:

o_robot_task (Activity) –

Return type:

None

set_task(i_target_robot_task: Activity, o_list_of_pointing_tasks: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetTask(Activity iTargetRobotTask,
CATSafeArrayVariant oListOfPointingTasks)

Sets the Pointed RobotTask.

Parameters:

iTargetRobotTask
The Desired Pointed Task.
oListOfPointingTasks
The List of RobotTasks which have the cyclic dependancy.


Returns:
An HRESULT.
Legal values:

S_OK
The RobotTask is set successfully.
E_FAIL
Unable to set the RobotTask (either the RobotTask belongs to a
different robot or existing cyclic dependancy).

Example:
The following example shows how to set the desired
RobotTask

Dim objCallRobotTaskActy as
CallRobotTaskActivity
Dim objTask as RobotTask
…
Dim objCyclicTasks(5)
objCallRobotTaskActy.SetTask
objTask,objCyclicTasks
Parameters:

  • i_target_robot_task (Activity) –

  • o_list_of_pointing_tasks (tuple) –

Return type:

None