pycatia.dmaps_interfaces.items

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.dmaps_interfaces.items.Items(com_object)

Note

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

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
Items

The collection of items related to the current activity.
add(i_product: Item) Item

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Add(Item iProduct) As Item

This method adds the specified item in the current list

Parameters:

iItem
The item to add

Returns:
oitem The item
Parameters:

i_product (Item) –

Return type:

Item

add_by_assignment_type(i_item: Item, i_assignment_type: int) Item

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddByAssignmentType(Item iItem,
ItemAssignmentType iAssignmentType) As Item

This method Assigns the specified item with the specified assignment
type

Parameters:

iItem
The item to be assigned
iAssignmentType
Type of the Assignment (Item to the Process)

Returns:
oitem The item
Parameters:
  • i_item (Item) –

  • i_assignment_type (int) – enum item_assignment_type

Return type:

Item

count_by_assignment_type(i_assignment_type: int) int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func CountByAssignmentType(ItemAssignmentType iAssignmentType) As
long

This method returns the Number of items that assocated with the activity
with given Assignment Type.

Parameters:

iAssignmentType
Type of the Assignment between items & the activity


Returns:
oNbItems No. of Items that are assigned to the activity with the given
assignment type.
Parameters:

i_assignment_type (int) – enum item_assignment_type

Return type:

int

item(i_index: cat_variant) Item

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(CATVariant iIndex) As Item

This method returns the idl object Item for the specified item
identifier.

Parameters:

iIndex
The item identifier

Returns:
oItem The idl item
Parameters:

i_index (cat_variant) –

Return type:

Item

item_by_assignment_type(i_index: cat_variant, i_assignment_type: int) Item

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func ItemByAssignmentType(CATVariant iIndex,
ItemAssignmentType iAssignmentType) As Item

This method returns the item assocated with the activity with given
Assignment Type.

Parameters:

iAssignmentType
Type of the Assignment between item & the activity


Returns:
oItem idl item to be returned
Parameters:
  • i_index (cat_variant) –

  • i_assignment_type (int) – enum item_assignment_type

Return type:

Item

remove_by_assignment_type(i_item: Item, i_assignment_type: int) Item

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func RemoveByAssignmentType(Item iItem,
ItemAssignmentType iAssignmentType) As Item

This method used to unassign the specified item (with the given assignment
type)

Parameters:

iItem
The item to be Unassigned
iAssignmentType
Type of the Assignment (Item to the Process) to be removed


Returns:
oitem The item
Parameters:
  • i_item (Item) –

  • i_assignment_type (int) – enum item_assignment_type

Return type:

Item