CogPMRedLineTool.CurrentRecordEnable Property

CogPMRedLineTool CurrentRecordEnable Property

Cognex VisionPro

Enable the creation of graphical tool records by bitwise ORing the desired values from CogPMRedLineCurrentRecordConstants.

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public CogPMRedLineCurrentRecordConstants CurrentRecordEnable { get; set; }

public CogPMRedLineCurrentRecordConstants CurrentRecordEnable { get; set; }

Public Property CurrentRecordEnable As CogPMRedLineCurrentRecordConstants 
	Get 
	Set

Public Property CurrentRecordEnable As CogPMRedLineCurrentRecordConstants 
	Get 
	Set

public:
property CogPMRedLineCurrentRecordConstants CurrentRecordEnable {
	CogPMRedLineCurrentRecordConstants get ();
	void set (CogPMRedLineCurrentRecordConstants value);
}

public:
property CogPMRedLineCurrentRecordConstants CurrentRecordEnable {
	CogPMRedLineCurrentRecordConstants get ();
	void set (CogPMRedLineCurrentRecordConstants value);
}

Property Value

Type: CogPMRedLineCurrentRecordConstants
A bitwise combination of the values from CogPMRedLineCurrentRecordConstants. Default value is InputImage + SearchRegion + SearchImageMask + TrainImage + TrainRegion + TrainImageMask + PatternOrigin + PatternFeatures.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flags may be affected: SfCurrentRecordEnable SfCreateCurrentRecord

Remarks

A VisionPro tool record is a data structure that contains graphical information about the state of the tool. You can obtain two different records from the tool: the Current Record, which describes the current state of the tool, and the LastRun Record, which describes the state of the tool immediately after the last call to the tool's Run function.

The current record is obtained by calling the CreateCurrentRecord method of the tool. The last run record is obtained by calling the CreateLastRunRecord method.

You can specify the content of the current record using the CurrentRecordEnable property. You can specify the content of the last run record using the LastRunRecordEnable and LastRunRecordDiagEnable properties. Graphical information requested via the LastRunRecordDiagEnable property is only created when the tool is run, and may cause the tool to run more slowly.