SetValueStale Method

SetValueStale Method (McMeasure)

Description

Allows user-defined measurements to set IsValueStale True

Return Type

None

Syntax

object.SetValueStale [Dependencies], [bNotifyNow]

The SetValueStale Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McMeasure.
Dependencies	Optional. A mcMeasurementDependencyFlags enumeration, as described in settings.
bNotifyNow	Optional. A Boolean value.

Settings

The settings for Dependencies are:

Constant		Value	Description
	mcmdfNoDependencies	0	no dependencies
	mcmdfImageLuminance	1	depends on ancestor image luminance data
	mcmdfFeatureData	2	depends on its ancestor McFeatures data
	mcmdfIntensityCalib	4	depends on the intensity calibration
	mcmdfSpatialCalib	8	depends on the spatial calibration
	mcmdfAoi	16	depends on ancestor image AOI
	mcmdfFeaturesStatus	32	depends on ancestor McFeatures.FeaturesStatusFlags or McFeatures.Selected properties.
	mcmdfUserData	64	depends on the UserData property
	mcmdfImageMultiChannel	128	measurements with this dependency are legal only on an ancestor image having multiple channels
	mcmdfImage3Color	256	measurements with this dependency are legal only on an ancestor image having 3 channels. This dependency implies mcmdfImageMultiChannel
	mcmdfOther	32768	some other dependency(s), so always ask
	mcmdfAssumedDependencies	95	These are the dependencies that are assumed if a user measurement does not report anything when a call is made to McUserMeasure.UserAttributes(mcmaidDependencies) or in response to the McUserMeasureCallback.GetAttributes(mcmaidDependencies) event. The assumed flags are mcmdfImageLuminance, mcmdfFeatureData, mcmdfIntensityCalib, mcmdfSpatialCalib, mcmdfAoi and mcmdfUserData.

Remarks

You should generally not have to call this method as it is automatically called internally when necessary based on the measurement's Attributes(mcmaidDependencies). However for some user-defined measurements, it may be necessary to force IsValueStale True based on some asynchronous event that is not tracked by the standard dependencies. In these cases, a call to SetValueStale will do the job. See McUserMeasure.UserIsValueStale for more discussion.