pycatia.part_interfaces.defeaturing_filters

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.part_interfaces.defeaturing_filters.DefeaturingFilters(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.Collection
DefeaturingFilters

Represents the filter collection of a defeaturing object.
add(i_filter_type_to_add: str) → int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func Add(CATBSTR iFilterTypeToAdd) As long

Creates a new filter and adds it to the Defeaturing filters
collection.

Parameters:

iFilterTypeToAdd
The type of the new filter to add among : - “DefeaturingFilletFilter” -
“DefeaturingHoleFilter” - or any user-defined filter’s type

Returns:
oAddedFilterIndex The added filter’s index - equals to 0 if
FAILED

Example:
The following example adds a new filter of type theFilterType to
defeaturing colelction firstDefeaturingFilters and returns the index theIndex
of the new filter

Set theIndex = firstDefeaturingFilters.Add(theFilterType)
Parameters:

i_filter_type_to_add (str) –

Return type:

int

item(i_filter_id: cat_variant) → DefeaturingFilter

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Func Item(CATVariant iFilterId) As DefeaturingFilter

Returns the filter of the Defeaturing filters collection using its index or
its name.

Parameters:

iFilterId
The index or the name of the filter to retrieve As a numerics, must
be in [1;Count])

Returns:
oFilter The filter (see DefeaturingFilter for list of possible
actions)

Example:
The following example returns in myFilter the filter number
theIndex of Defeaturing collection
firstDefeaturingFilters:

Set myFilter = firstDefeaturingFilters.Item(theIndex)
Parameters:

i_filter_id (cat_variant) –

Return type:

DefeaturingFilter

remove(i_filter_id: cat_variant) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub Remove(CATVariant iFilterId)

Removes a filter from the Defeaturing filters collection and deletes it,
using its index or its name.

Parameters:

iFilterId
The index or the name of the filter to retrieve As a numerics, must
be in [1;Count])

Example:
The two following examples remove the filter number theIndex
from Defeaturing collection
firstDefeaturingFilters:

Call firstDefeaturingFilters.Remove(theIndex)
firstDefeaturingFilters.Remove theIndex
Parameters:

i_filter_id (cat_variant) –

Return type:

None