pycatia.dnb_resource_program_interfaces.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_resource_program_interfaces.task.Task(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
Task

Represents the Task of a resource.

Role: Task is the object used to access and manage the attributes of the
task.
The following code snippet can be used to obtain the Task from the Resource
program manager.

Dim objResourceProgramManager As ResourceProgramManager
Dim oTask As Task

objResourceProgramManager.GetTask “RobotTask.1”, oTask
get_name(o_name: str) → None

Note

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

Get the name of the Task

Parameters:

oName
The user defined name of the Task.

Returns:
An HRESULT.
Legal values:

S_OK
The name of the task was corrrectly retrieved
E_FAIL
The name of the task was not corrrectly retrieved

Example:
The following example get the name of the task.

Dim objTask As Task
Dim strTaskName As String
..
objTask.GetName strTaskName
Parameters:

o_name (str) –

Return type:

None

get_resource(o_res: Product) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetResource(Product oRes)

Gets the Owning Resource

Parameters:

oRes
The Owning Resource.

Returns:
An HRESULT.
Legal values:

S_OK
The owning resource was corrrectly retrieved
E_FAIL
The owning resource was not corrrectly retrieved

Example:
The following example retrieves the owning resource of the
task.

Dim objTask As Task
Dim objRobot as Product
..
objTask.GetResource objRobot
Parameters:

o_res (Product) –

Return type:

None

set_name(i_name: str) → None

Note

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

Set the name of the task

Parameters:

iName
The user defined name of the Task.

Returns:
An HRESULT.
Legal values:

S_OK
The name of the task was set corrrectly
E_FAIL
The name of the task was not set corrrectly

Example:
The following example set the name of the task.

Dim objTask As Task
..
objTask.SetName(“RobotTask.2”)
Parameters:

i_name (str) –

Return type:

None