pycatia.dnb_igp_setup_interfaces.robot_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.robot_task.RobotTask(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

RobotTask

Represents the Robot Task.

Role: The interface is used manage activities under a Robot

Task.

The following code snippet can be used to obtain the Robot Task from a Robot

Task Factory.

Dim objRobotTaskFactory As RobotTaskFactory

Dim objRobot As Product

…

Set objRobotTaskFactory = objRobot.GetTechnologicalObject(“RobotTaskFactory” )

Dim objRobotTaskList(3) as RobotTask

Dim objRobotTask as RobotTask

objRobotTaskFactory.GetAllRobotTasks objRobotTaskList

objRobotTask=objRobotTaskList[0]

The Robot Task can also be obtained from an activity of the type

RobotTask.

Dim objActivity as Activity

…

Dim objRobotTask as RobotTask

Set objRobotTask = objActivity.GetTechnologicalObject(“RobotTask” )

create_after_operation(i_after_operation: Operation, o_created_operation: Operation) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub CreateAfterOperation(Operation iAfterOperation,

Operation oCreatedOperation)

Creates Operation as a child of Robot Task.

Parameters:

iAfterOperation

The Operation after which the required operation is to be created.

oCreatedOperation

The Created Operation.

Returns:

An HRESULT.

Legal values:

S_OK

The operation was successfully created.

E_FAIL

The operation could not be created.

Example:

The following example creates an Operation

Dim objRobotTask as RobotTask

Dim objAfterOperation As Operation

…

Dim objOperation As Operation

objRobotTask.CreateAfterOperation

objAfterOperation,objOperation

Parameters:

• i_after_operation (Operation) –

• o_created_operation (Operation) –

Return type:

None

create_call_task(i_robot_task: RobotTask, i_after_operation: Operation, i_where: bool, o_created_call_task: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub CreateCallTask(RobotTask iRobotTask,

Operation iAfterOperation,

boolean iWhere,

AnyObject oCreatedCallTask)

Creates a calltask inside a Robot Task

Parameters:

iRobotTask

The task to be called in the current robot task

iAfterOperation

The Operation after which the required operation is to be created..

iWhere

The postion of where the task needs to be inserted Before(0)

After(1)

oCreatedCallTask

The created call task

Returns:

An HRESULT.

Legal values:

S_OK

The call task was successfully created.

E_FAIL

The call task could not be created.

Example:

The following example creates An Operation

Dim objRobotTask as RobotTask

Dim objCalledTask as RobotTask

Dim objAfterOperation as Operation

..

Dim objCallTaskAct as AnyObject

objRobotTask.CreateCallTask objCalledTask,objAfterOperation,1,objCallTaskAct

Parameters:

• i_robot_task (RobotTask) –

• i_after_operation (Operation) –

• i_where (bool) –

• o_created_call_task (AnyObject) –

Return type:

None

create_operation(i_reference_operation: Operation, i_after_operation: Operation, o_created_operation: Operation) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub CreateOperation(Operation iReferenceOperation,

Operation iAfterOperation,

Operation oCreatedOperation)

Creates Operation as a child of Robot Task.

Parameters:

iReferenceOperation

The Reference Operation after which the Operation has to be created

and whose properties will be copied to the created operation.

iAfterOperation

The Operation after which the required operation is to be created.

(Pass NOTHING if Reference Operation is specified)

oCreatedOperation

The Created Operation.

Returns:

An HRESULT.

Legal values:

S_OK

The operation was successfully created.

E_FAIL

The operation could not be created.

Example:

The following example creates an Operation

Dim objRobotTask as RobotTask

Dim objRefOperation as Operation

…

Dim objAfterOperation as Operation

Set objAfterOperation = Nothing

Dim objOperation As Operation

objRobotTask.CreateOperation

objRefOperation,objAfterOperation,objOperation

Parameters:

• i_reference_operation (Operation) –

• i_after_operation (Operation) –

• o_created_operation (Operation) –

Return type:

None

delete_operations(i_operation_list: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub DeleteOperations(CATSafeArrayVariant iOperationList)

Deletes the required list of Operations.

Parameters:

iOperationList

The list of Operations to be deleted.

Returns:

An HRESULT.

Legal values:

S_OK

The operation list was successfully deleted.

E_FAIL

The operation list could not be created.

Example:

The following example creates an Operation

Dim objRobotTask as RobotTask

Dim objOperationList as Operation

…

objRobotTask.DeleteOperations objOperationList

Parameters:

i_operation_list (tuple) –

Return type:

None

get_all_operations(o_operation_list: tuple) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub GetAllOperations(CATSafeArrayVariant oOperationList)

Retrieves the List of Operations of Robot Task.

Parameters:

oOperationList

The list of Operations

Returns:

An HRESULT.

Legal values:

S_OK

The operation list was successfully queried.

E_FAIL

The operation list could not be queried.

Example:

The following example creates An Operation

Dim objRobotTask as RobotTask

Dim objOperationList As Operation

…

objRobotTask.GetAllOperations objOperationList

Parameters:

o_operation_list (tuple) –

Return type:

None