DefeaturingFilterWithRange (Object)

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

Methods


Func getMaximumActivity( iRangeId) As
Func getMaximumAngle( iRangeId) As
Func getMaximumLength( iRangeId) As
Func getMaximumValue( iRangeId) As
Func getMinimumActivity( iRangeId) As
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)
Func getMinimumAngle( iRangeId) As
Func getMinimumLength( iRangeId) As
Func getMinimumValue( iRangeId) As
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 lengthes / 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)
Sub setMaximumActivity( iRangeId, iValue)
Sub setMaximumValue( iRangeId, iValue)
Sub setMinimumActivity( iRangeId, 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
Sub setMinimumValue( iRangeId, 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