pycatia.dnb_resource_program_interfaces.active_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.active_task.ActiveTask(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
ActiveTask

Represents the Active task of the resource in conjunction with a particular
activity.

Role: Active Task is the object used to access and manage the active task set
for all the resources assigned for the activity.
The following code snippet can be used to obtain the Active Task from the
activity.

Dim objChildActivity As Activity
Dim objActiveActivity As ActiveTask

Set objActiveActivity = objChildActivity.GetTechnologicalObject(“ActiveTask”)
get_active_task(i_resource: AnyObject, o_task: Task) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub GetActiveTask(AnyObject iResource,
Task oTask)

Retrieves the Active Task for an activity for a particular
Resource.

Parameters:

iResource
The resources.
oTask
The Active Task.

Returns:
An HRESULT.
Legal values:

S_OK
The status could be successfully queried from the
activity
E_FAIL
The query failed.

Example:
The following example get the active task of the particular
resource in the activity.

Dim oActiveAct As ActiveTask
Dim iResPrgMngr As ResourceProgramManager
Dim oTask As Task
..
oActiveAct.GetActiveTask iResPrgMngr, oTask
Parameters:
Return type:

None

set_active_task(i_resource: AnyObject, i_task: Task) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetActiveTask(AnyObject iResource,
Task iTask)

Defines the Active Task for an activity for a particular
Resource.

Parameters:

iResource
The resources that owns the Task.
iTask
The Tasks to be made active.

Returns:
An HRESULT.
Legal values:

S_OK
The Active Task was corrrectly set
E_FAIL
The Active Task was not corrrectly set

Example:
The following example sets Active Task for an activity for a
particular Resource.

Dim iActiveAct As ActiveTask
Dim iResPrgMngr As ResourceProgramManager
Dim iTask As Task
..
oActiveAct.SetActiveTask iResPrgMngr, iTask
Parameters:
Return type:

None