pycatia.part_interfaces.defeaturing_filter_with_range

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_filter_with_range.DefeaturingFilterWithRange(com_object)

Note

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

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

PartInterfaces.DefeaturingFilter

DefeaturingFilterWithRange

Represents the base object for defeaturing filters which uses range(s) of

values

get_maximum_activity(i_range_id: str) → bool

Note

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

o Func getMaximumActivity(CATBSTR iRangeId) As boolean

Parameters:

i_range_id (str) –

Return type:

bool

get_maximum_angle(i_range_id: str) → Angle

Note

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

o Func getMaximumAngle(CATBSTR iRangeId) As Angle

Parameters:

i_range_id (str) –

Return type:

Angle

get_maximum_length(i_range_id: str) → Length

Note

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

o Func getMaximumLength(CATBSTR iRangeId) As Length

Parameters:

i_range_id (str) –

Return type:

Length

get_maximum_value(i_range_id: str) → float

Note

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

o Func getMaximumValue(CATBSTR iRangeId) As double

Parameters:

i_range_id (str) –

Return type:

float

get_minimum_activity(i_range_id: str) → bool

Note

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

o Func getMinimumActivity(CATBSTR iRangeId) As boolean

Returns the minimum or maximum value activity of the filter for the given

range id.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

Returns:

oValue The filter minimum/maximum activity for the specified

range

Example:

The following example returns in theMinActivity the minimum value

activity of filter myFilter for the range myRange:

Set theMinActivity = myFilter.getMinimumActivity(myRange)

Parameters:

i_range_id (str) –

Return type:

bool

get_minimum_angle(i_range_id: str) → Angle

Note

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

o Func getMinimumAngle(CATBSTR iRangeId) As Angle

Parameters:

i_range_id (str) –

Return type:

Angle

get_minimum_length(i_range_id: str) → Length

Note

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

o Func getMinimumLength(CATBSTR iRangeId) As Length

Parameters:

i_range_id (str) –

Return type:

Length

get_minimum_value(i_range_id: str) → float

Note

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

o Func getMinimumValue(CATBSTR iRangeId) As double

Returns the minimum or maximum value of the filter for the given range id,

if defined and active.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

Returns:

oValue The filter minimum/maximum value for the specified range if

defined and active ELSE the method FAILS (to avoid this,

getMinimumValueActivity/getMaximumValueActivity can be called prior to calling

getMinimumValue/getMaximumValue) Signature with double works for angles as well

as for lengths / EXPRESSED in MODEL UNIT (mm/deg) Signatures with CATIALength

or CATIAAngle must be used with care and will fail if the range nature and the

expected type are incompatible

Example:

The following example returns in theMinValue the minimum value of

filter myFilter for the range myRange:

theMinValue = myFilter.getMinimumValue(myRange)

The following example returns in theMinAngle the minimum value as

an angle of filter myFilter for the range myRange:

Set theMinAngle = myFilter.getMinimumAngle(myRange)

The following example returns in theMaxLength the maximum value as

a length of filter myFilter for the range myRange:

Set theMaxLength = myFilter.getMaximumLength(myRange)

Parameters:

i_range_id (str) –

Return type:

float

set_maximum_activity(i_range_id: str, i_value: bool) → None

Note

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

o Sub setMaximumActivity(CATBSTR iRangeId,

boolean iValue)

Parameters:

• i_range_id (str) –

• i_value (bool) –

Return type:

None

set_maximum_value(i_range_id: str, i_value: float) → None

Note

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

o Sub setMaximumValue(CATBSTR iRangeId,

double iValue)

Parameters:

• i_range_id (str) –

• i_value (float) –

Return type:

None

set_minimum_activity(i_range_id: str, i_value: bool) → None

Note

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

o Sub setMinimumActivity(CATBSTR iRangeId,

boolean iValue)

Sets the defeaturing minimum or maximum value activity of the filter for

the given range id.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

iValue

The filter minimum/maximum activity for the specified

range

Example:

The two following examples set theMaxActivity as the maximum

value activity of filter myFilter for the range

myRange:

Call myFilter.setMaximumActivity(myRange,theMaxActivity)

myFilter.setMaximumActivity myRange

theMaxActivity

Parameters:

• i_range_id (str) –

• i_value (bool) –

Return type:

None

set_minimum_value(i_range_id: str, i_value: float) → None

Note

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

o Sub setMinimumValue(CATBSTR iRangeId,

double iValue)

Sets the minimum or maximum value of the filter for the given range id.

Forces the activation of the minimum or maximum value if not the case

yet.

Parameters:

iRangeId

The identificator of the range on which the minimum/maximum should

be read - if iRangeId is empty or equal to “Default”, takes the default range

as defined by the filter (“RibbonRadius” for FilletFilter, “MainDiameter” for

HoleFilter) - else iRangeId should be chosen among: *

{“RibbonRadius”,”RibbonAngle”,”RibbonLength”} for FilletFilter *

{“MainDiameter”} for HoleFilter * any defined and supported range id in case of

a user-defined filter

iValue

The filter minimum/maximum value for the specified range / MUST BE

EXPRESSED in MODEL UNIT (mm/deg) iValue must be consistent with the other value

if defined and active - new minimum iValue must be smaller than existing active

maximum value if any - new maximum iValue must be larger than existing active

minimum value if any ELSE the method FAILS

Example:

The two following examples set theMaxValue as the maximum value

of filter myFilter for the range myRange:

Call

myFilter.setMaximumValue(myRange,theMaxValue)

myFilter.setMaximumValue myRange theMaxValue

Parameters:

• i_range_id (str) –

• i_value (float) –

Return type:

None