pycatia.cat_plant_ship_interfaces.psp_list_of_objects

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.cat_plant_ship_interfaces.psp_list_of_objects.PSPListOfObjects(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
PspListOfObjects

Represents a collection of Objects.
Role: Collection of Object.
append(i_object: AnyObject) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub Append(AnyObject iObject)

Adds an object to the end of the list.

Parameters:

iObject
The object to be added to the list.

Example:

The following example appends an object to the list.

Dim MyObject As AnyObject
Dim MyList As PspListOfObjects
MyList.Append(MyObject)
Parameters:

i_object (AnyObject) –

Return type:

None

property count: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Count() As long (Read Only)

Returns the number of objects in the list.

Example:
This example retrieves in NumberOfObjects the number of objects
currently gathered in MyList.

NumberOfObjects = MyList.Count
Return type:

int

item(i_index: int, i_interface_name: str) → AnyObject

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func Item(long iIndex,
CATBSTR iInterfaceName) As AnyObject

Returns an object from its index in the list.

Parameters:

iIndex
The index of the first object in the collection is 1, and the index
of the last object is Count.
iInterfaceName
The interface name of oObj.

Returns:
the retrieved object.
Example:

The following example returns in the third object in the
list.

Dim MyObject As PspID
Dim MyList As PspListOfObjects
Set MyObject = PspListOfObjects.Item(3,”CATIAPspID”)
Parameters:

  • i_index (int) –

  • i_interface_name (str) –

Return type:

AnyObject

remove_by_index(i_index: int) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub RemoveByIndex(long iIndex)

Remove an object from the list by specifying its position in the
list.

Parameters:

iIndex
The position of the object to be removed in the list.

Example:

The following example removes the second entry in the list. Please
note that the list index starts with 1.

Dim MyList As PspListOfObjects
MyList.RemoveByIndex (2)
Parameters:

i_index (int) –

Return type:

None