Filter Method (McFractalDimension)
      
 

Description

The ancestor McFeatures features are selected based the measurement

Return Type

None  

Syntax

object.Filter [AllInRangeElseAnyInRange]

The Filter Method syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McFractalDimension.
AllInRangeElseAnyInRangeOptional. A Boolean value.

If True (the default) and a feature is already selected by having its mcfsfAnyNotSelected bits (mcfsfDeselected, mcfsfOutOfRange or mcfsfCancelled) of the McFeatures.FeatureStatusFlags clear, then it will become unselsected (the mcfsfOutOfRange bit of the McFeatures.FeatureStatusFlags will be set for that feature) if the measurement value corresponding to that feature falls outside RangeMin through RangeMax. That is, if AllInRangeElseAnyInRange is True, a feature's status will only be changed if it is not already de-selected. If AllInRangeElseAnyInRange is False, and a feature is already deselected by having its any of its mcfsfAnyNotSelected bits of the McFeatures.FeatureStatusFlags set, then it will become selsected (the all mcfsfAnyNotSelected bits of the McFeatures.FeatureStatusFlags will be cleared for that feature) if the measurement value corresponding to that feature falls inside RangeMin through RangeMax. That is, if AllInRangeElseAnyInRange is False, a feature's status will only be changed if it is not already Selected.

Remarks

This sets the ancestor McFeatures.Selected and McFeatures.FeatureStatusFlags properties based on the current measurement Value array values in relation to the RangeMin and RangeMax properties. This method will set the mcfsfOutOfRange McFeatures.FeatureStatusFlags bit (and thus make Selected False) for a feature where the measurement for that feature is outside of McMeasure.RangeMin to McMeasure.RangeMax. Depending on the AllInRangeElseAnyInRange argument, the existing selected state of a feature may be left unchanged.

The Filter method only makes sense for one-dimensional measurements (that is, ones where a single value is taken from each feature), so for other types of measurements, this method fails. For filterable measurements, Attributes(mcmaidCanFilter) will be True.

Exceptions

The method will fail if Attributes(mcmaidCanFilter) is not True.