pycatia.arrangement_interfaces.arr_nomenclatures

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.arrangement_interfaces.arr_nomenclatures.ArrNomenclatures(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
ArrNomenclatures

The collection of UserNomenclature objects.
add_user_nomenclature(i_name: str, i_icon_name: str, i_class_type: str, i_super_type: str) ArrNomenclature

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func AddUserNomenclature(CATBSTR iName,
CATBSTR iIconName,
CATBSTR iClassType,
CATBSTR iSuperType) As ArrNomenclature

Creates a new UserNomenclature and adds it to this collection. The
NomenclatureType of the new UserNomenclature will be “User”. The base objects
in the UserDictionary are created when the UserDictionary is
created.

Parameters:

iName
The user nomenclature name.
iIconName
The icon name associated to this nomenclature name.

Returns:
The new UserNomenclature.
Parameters:
  • i_name (str) –

  • i_icon_name (str) –

  • i_class_type (str) –

  • i_super_type (str) –

Return type:

ArrNomenclature

item(i_index: cat_variant) ArrNomenclature

Note

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

Returns the specified item of the collection

Parameters:

iItem
The list index (long) or name (CATBSTR) of the member to retrieve.


Returns:
The retrieved member object.
Parameters:

i_index (cat_variant) –

Return type:

ArrNomenclature