ICogShapeModel.CreateSubFeatureIterator Method

ICogShapeModel CreateSubFeatureIterator Method

Cognex VisionPro 9.5

Returns a newly created iterator for iterating over all subfeatures. The iterator is positioned at the subfeature specified by InitialIndex. A value of -1 creates an iterator that is positioned just after the last valid subfeature.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

ICogModelFeatureIterator CreateSubFeatureIterator(
	int initialIndex
)

ICogModelFeatureIterator CreateSubFeatureIterator(
	int initialIndex
)

Function CreateSubFeatureIterator ( 
	initialIndex As Integer
) As ICogModelFeatureIterator

Function CreateSubFeatureIterator ( 
	initialIndex As Integer
) As ICogModelFeatureIterator

ICogModelFeatureIterator^ CreateSubFeatureIterator(
	int initialIndex
)

ICogModelFeatureIterator^ CreateSubFeatureIterator(
	int initialIndex
)

Parameters

initialIndex: Type: System Int32
The initial position of the iterator. If this value is −1, the iterator is positioned after the last valid subfeature.

Return Value

Type: ICogModelFeatureIterator

The iterator.

Exceptions

Exception	Condition
ArgumentException	IntialIndex >= SubFeatureCount or < 0 (after translating −1 appropriately).

Remarks

Returns a newly created iterator for iterating over all subfeatures. The iterator is positioned at the subfeature specified by initialIndex. A value of −1 creates an iterator that is positioned just after the last valid subfeature.

Most shape models do not have subfeatures, so it is not unusual for this method to return Nothing (or NULL). Only CogGeneralContour objects have subfeatures.