pycatia.dnb_igp_setup_interfaces.robot_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.robot_task_factory.RobotTaskFactory(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
RobotTaskFactory

Represents the Task Creation Factory for Robots.

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

Dim objRobotTaskFactory As RobotTaskFactory
Dim objRobot As Product
…
Set objRobotTaskFactory = objRobot.GetTechnologicalObject(“RobotTaskFactory” )
create_robot_task(i_name: str, o_robot_task: RobotTask) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub CreateRobotTask(CATBSTR iName,
RobotTask oRobotTask)

Creates a Robot Task

Parameters:

iName
The Robot Task Name.
oRobotTask
The Created Robot Task.

Returns:
An HRESULT.
Legal values:

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

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

Dim objRobotTaskFactory As RobotTaskFactory
Dim objRobotTask as RobotTask
..
objRobotTaskFactory.CreateRobotTask
“New_RobotTask_1”,objRobotTask
Parameters:

  • i_name (str) –

  • o_robot_task (RobotTask) –

Return type:

None

delete_robot_task(i_robot_task: RobotTask) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub DeleteRobotTask(RobotTask iRobotTask)

Removes the required Robot Task.

Parameters:

iRobotTask
The Robot Task to be Removed.

Returns:
An HRESULT.
Legal values:

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

Example:
The following example deleted a robot task of a
robot.

Dim objRobotTaskFactory As RobotTaskFactory
Dim objRobotTask as RobotTask
..
objRobotTaskFactory.DeleteRobotTask
objRobotTask
Parameters:

i_robot_task (RobotTask) –

Return type:

None

get_all_robot_tasks(o_robot_task_list: tuple) → None

Note

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

Retrieves the list of Robot Tasks owned by a Robot.

Parameters:

oRobotTaskList
The Robot Task List.

Returns:
An HRESULT.
Legal values:

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

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

Dim objRobotTaskFactory As RobotTaskFactory
Dim objRobotTask(3) as RobotTask
..
objRobotTaskFactory.GetAllRobotTasks
objRobotTask
Parameters:

o_robot_task_list (tuple) –

Return type:

None