CogBeadInspectTrainResult.GetCaliperPointMarker Method

CogBeadInspectTrainResult GetCaliperPointMarker Method

Cognex VisionPro 9.25 SR1

Returns a CogPointMarker that describes the center of the caliper at the given index.

Namespace: Cognex.VisionPro.EdgeInspect
Assembly: Cognex.VisionPro.EdgeInspect (in Cognex.VisionPro.EdgeInspect.dll) Version: 93.1.0.0

Syntax

C++

Copy to Clipboard Print

public CogPointMarker GetCaliperPointMarker(
	int index
)

public CogPointMarker GetCaliperPointMarker(
	int index
)

Public Function GetCaliperPointMarker ( 
	index As Integer
) As CogPointMarker

Public Function GetCaliperPointMarker ( 
	index As Integer
) As CogPointMarker

public:
CogPointMarker^ GetCaliperPointMarker(
	int index
)

public:
CogPointMarker^ GetCaliperPointMarker(
	int index
)

Parameters

index: Type: System Int32
The index of the caliper along the trained path.

Return Value

Type: CogPointMarker
A CogPointMarker that represents the center of the indexed caliper.

Exceptions

Exception	Condition
IndexOutOfRangeException	The given index is less than zero, or too large to index the trained calipers of this train result.

Remarks

The returned point marker will be interactive (i.e. selectable), but not draggable. Its rotation will match the rotation of the caliper, and it will have its TipText set to the given caliper index.