pycatia.dnb_igp_setup_interfaces.robot_task_clone_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.robot_task_clone_factory.RobotTaskCloneFactory(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
RobotTaskCloneFactory

Represents the Clone Factory for Robot Tasks.

Role: Robot Clone Task Factory is the object used to clone robot
tasks.
The following code snippet can be used to obtain the Robot Task Factory from
the robot product.

Dim objRobotTaskFactory As RobotTaskCloneFactory
Dim objRobot As Product
…
Set objRobotTaskCloneFactory = objRobot.GetTechnologicalObject(“RobotTaskCloneFactory” )
clone_task_in_another_robot(i_src_robot_task: RobotTask, i_dest_robot: AnyObject, i_target_task_name: str, i_trans_on_target: tuple, o_cloned_robot_task: RobotTask) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CloneTaskInAnotherRobot(RobotTask iSrcRobotTask,
AnyObject iDestRobot,
CATBSTR iTargetTaskName,
CATSafeArrayVariant iTransOnTarget,
RobotTask oClonedRobotTask)

Clones a given Robot Task with in another robot.

Parameters:

iSrcRobotTask
The Robot task that needs to be cloned.
iTargetTaskName
The name for the cloned robot task.
iTargetTaskName
The transformation that needs to be applied on the targets (w.r.t
the robot).
oClonedRobotTask
The resultant cloned robot task.

Returns:
An HRESULT.
Legal values:

S_OK
The Robot Task cloning was successful.
E_FAIL
The Robot Task cloning was unsuccessful.

Example:
The following example show how to clone a task.

Dim objRobotTaskCloneFactory As
RobotTaskCloneFactory
Dim iSrcTask, oClonedTask
Dim iTargetRobot
Dim iTrans(0 to 11)
..
objRobotTaskCloneFactory.CloneTaskInAnotherRobot oSrcTask,
iTargetRobot, “Task.1”, oTrans, oClonedTask
Parameters:

  • i_src_robot_task (RobotTask) –

  • i_dest_robot (AnyObject) –

  • i_target_task_name (str) –

  • i_trans_on_target (tuple) –

  • o_cloned_robot_task (RobotTask) –

Return type:

None

clone_task_in_same_robot(i_src_robot_task: RobotTask, i_target_task_name: str, i_trans_on_target: tuple, o_cloned_robot_task: RobotTask) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CloneTaskInSameRobot(RobotTask iSrcRobotTask,
CATBSTR iTargetTaskName,
CATSafeArrayVariant iTransOnTarget,
RobotTask oClonedRobotTask)

Clones a given Robot Task with in the same robot.

Parameters:

iSrcRobotTask
The Robot task that needs to be cloned.
iTargetTaskName
The name for the cloned robot task.
oClonedRobotTask
The resultant cloned robot task.
iTargetTaskName
The transformation that needs to be applied on the targets (w.r.t
the robot).

Returns:
An HRESULT.
Legal values:

S_OK
The Robot Task cloning was successful.
E_FAIL
The Robot Task cloning was unsuccessful.

Example:
The following example show how to clone a task.

Dim objRobotTaskCloneFactory As
RobotTaskCloneFactory
Dim iSrcTask, oClonedTask
Dim iTrans(0 to 11)
..
objRobotTaskCloneFactory.CloneTaskInSameRobot iSrcTask,
“Task.1”, iTrans, oClonedTask
Parameters:

  • i_src_robot_task (RobotTask) –

  • i_target_task_name (str) –

  • i_trans_on_target (tuple) –

  • o_cloned_robot_task (RobotTask) –

Return type:

None