pycatia.cat_mat_interfaces.material_families

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_mat_interfaces.material_families.MaterialFamilies(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
MaterialFamilies

A collection of all the MaterialFamily objects.
This collection is currently managed by a CATIAMaterialDocument
object.
add() → MaterialFamily

Note

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

Adds a new material family to the MaterialFamilies collection.


Example:
The following adds a material family to the collection
attached to a document. This document must be a
MaterialDocument object.

FileToOpen = “e:usersastmaterialsCatalog.CATMaterial”
Dim MyDocument As MaterialDocument
Set MyDocument = Documents.Open(FileToOpen)
Dim MyMaterialFamily As MaterialFamily
Set MyMaterialFamily = MyDocument.MaterialFamilies.Add
Return type:

MaterialFamily

item(i_index: cat_variant) → MaterialFamily

Note

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

Returns a material family from its index in the
MaterialFamilies collection.

Parameters:

iIndex
The index of the material family to retrieve in
the collection of material families. Compared with
other collections, you cannot use the name of
the material family as argument.

Returns:
The retrieved material family

Example:
The following example returns in MyMaterialFamily the
sixth
material family in the collection.

Dim MyMaterialFamily As MaterialFamily
Set MyMaterialFamily = MaterialFamilies.Item(6)
Parameters:

i_index (cat_variant) –

Return type:

MaterialFamily

remove(i_index: cat_variant) → None

Note

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

Removes a material family from the MaterialFamilies
collection.

Parameters:

iIndex
The index of the material family to remove.
Compared with other collections, you cannot use
the name of the material family as argument.


Example:
The following example removes the second material
family in the collection attached to the active
document. This document must be a MaterialDocument
object.

FileToOpen = “e:usersastmaterialsCatalog.CATMaterial”
Dim MyDocument As MaterialDocument
Set MyDocument = Documents.Open(FileToOpen)
MyDocument.MaterialFamilies.Remove(2)
Parameters:

i_index (cat_variant) –

Return type:

None